Mercurial > hg > octave-lyh

comparison scripts/miscellaneous/__xzip__.m @ 8812:7d48766c21a5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
use consistent format for doc strings of internal functions
author John W. Eaton <jwe@octave.org>
date Thu, 19 Feb 2009 02:16:34 -0500
parents 34c0acf11539
children eb63fbe60fab
comparison
equal deleted inserted replaced
8811:20dfb885f877 8812:7d48766c21a5
16 ## You should have received a copy of the GNU General Public License 16 ## You should have received a copy of the GNU General Public License
17 ## along with Octave; see the file COPYING. If not, see 17 ## along with Octave; see the file COPYING. If not, see
18 ## <http://www.gnu.org/licenses/>. 18 ## <http://www.gnu.org/licenses/>.
19 19
20 ## -*- texinfo -*- 20 ## -*- texinfo -*-
21 ## @deftypefn {Function File} {@var{entries} =} _xzip_ (@var{commandname}, @var{extension}, @var{commandtemplate}, @var{files}, @var{outdir}) 21 ## @deftypefn {Function File} {@var{entries} =} __xzip__ (@var{commandname}, @var{extension}, @var{commandtemplate}, @var{files}, @var{outdir})
22 ## Compresses the list of files and/or directories specified in @var{files} 22 ## Undocumented internal function.
23 ## @end deftypefn
24
25 ## Compress the list of files and/or directories specified in @var{files}
23 ## with the external compression command @var{commandname}. The template 26 ## with the external compression command @var{commandname}. The template
24 ## @var{commandtemplate} is used to actually start the command. Each file 27 ## @var{commandtemplate} is used to actually start the command. Each file
25 ## is compressed separately and a new file with the extension @var{extension} 28 ## is compressed separately and a new file with the extension @var{extension}
26 ## is created and placed into the directory @var{outdir}. The original files 29 ## is created and placed into the directory @var{outdir}. The original files
27 ## are not touched. Existing compressed files are silently overwritten. 30 ## are not touched. Existing compressed files are silently overwritten.
28 ## This is an internal function. Do not use directly. 31 ## This is an internal function. Do not use directly.
29 ## @seealso{gzip, bzip2}
30 ## @end deftypefn
31 32
32 function entries = __xzip__ (commandname, extension, 33 function entries = __xzip__ (commandname, extension,
33 commandtemplate, files, outdir) 34 commandtemplate, files, outdir)
34 35
35 if (nargin == 4 || nargin == 5) 36 if (nargin == 4 || nargin == 5)