Mercurial > octave
comparison scripts/miscellaneous/gzip.m @ 9051:1bf0ce0930be
Grammar check TexInfo in all .m files
Cleanup documentation sources to follow a few consistent rules.
Spellcheck was NOT done. (but will be in another changeset)
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Fri, 27 Mar 2009 22:31:03 -0700 |
parents | eb63fbe60fab |
children | be55736a0783 |
comparison
equal
deleted
inserted
replaced
9044:656ad518f385 | 9051:1bf0ce0930be |
---|---|
19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
20 ## @deftypefn {Function File} {@var{entries} =} gzip (@var{files}) | 20 ## @deftypefn {Function File} {@var{entries} =} gzip (@var{files}) |
21 ## @deftypefnx {Function File} {@var{entries} =} gzip (@var{files}, @var{outdir}) | 21 ## @deftypefnx {Function File} {@var{entries} =} gzip (@var{files}, @var{outdir}) |
22 ## Compress the list of files and/or directories specified in @var{files}. | 22 ## Compress the list of files and/or directories specified in @var{files}. |
23 ## Each file is compressed separately and a new file with a '.gz' extension | 23 ## Each file is compressed separately and a new file with a '.gz' extension |
24 ## is created. The original files are not touched. Existing compressed | 24 ## is created. The original files are not touched. Existing compressed |
25 ## files are silently overwritten. If @var{outdir} is defined the compressed | 25 ## files are silently overwritten. If @var{outdir} is defined the compressed |
26 ## versions of the files are placed in this directory. | 26 ## versions of the files are placed in this directory. |
27 ## @seealso{gunzip, bzip2, zip, tar} | 27 ## @seealso{gunzip, bzip2, zip, tar} |
28 ## @end deftypefn | 28 ## @end deftypefn |
29 | 29 |
30 function entries = gzip (varargin) | 30 function entries = gzip (varargin) |