comparison scripts/miscellaneous/gzip.m @ 12500:8f2056646dba

Improve docstrings for archive functions (gzip, bzip2, etc.)
author Rik <octave@nomad.inbox5.com>
date Thu, 03 Mar 2011 13:05:50 -0800
parents a3019189ac51
children e81ddf9cacd5
comparison
equal deleted inserted replaced
12499:a3019189ac51 12500:8f2056646dba
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 modified. 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 ## 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)
31 if (nargin != 1 && nargin != 2) || (nargout > 1) 31 if (nargin != 1 && nargin != 2) || (nargout > 1)