Mercurial > octave-antonio

comparison scripts/miscellaneous/gzip.m @ 20164:df437a52bcaf stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed miscellaneous, sparse, strings in scripts directory. * scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m, scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m, scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m, scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m, scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m, scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m, scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m, scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m, scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m, scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m, scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m, scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m, scripts/sparse/treeplot.m, scripts/strings/base2dec.m, scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m, scripts/strings/deblank.m, scripts/strings/dec2base.m, scripts/strings/dec2bin.m, scripts/strings/dec2hex.m, scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m, scripts/strings/isletter.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m, scripts/strings/strjoin.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/strsplit.m, scripts/strings/strtok.m, scripts/strings/strtrim.m, scripts/strings/strtrunc.m, scripts/strings/substr.m, scripts/strings/untabify.m, scripts/time/datenum.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Mon, 04 May 2015 14:22:02 -0700
parents 4197fc428c7d
children
comparison
equal deleted inserted replaced
20163:075a5e2e1ba5 20164:df437a52bcaf
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {@var{filelist} =} gzip (@var{files}) 20 ## @deftypefn {Function File} {@var{filelist} =} gzip (@var{files})
21 ## @deftypefnx {Function File} {@var{filelist} =} gzip (@var{files}, @var{dir}) 21 ## @deftypefnx {Function File} {@var{filelist} =} gzip (@var{files}, @var{dir})
22 ## Compress the list of files and directories specified in @var{files}. 22 ## Compress the list of files and directories specified in @var{files}.
23 ## 23 ##
24 ## @var{files} is a character array or cell array of strings. Shell 24 ## @var{files} is a character array or cell array of strings. Shell wildcards
25 ## wildcards in the filename such as @samp{*} or @samp{?} are accepted and 25 ## in the filename such as @samp{*} or @samp{?} are accepted and expanded.
26 ## expanded. Each file is compressed separately and a new file with a 26 ## Each file is compressed separately and a new file with a @file{".gz"}
27 ## @file{".gz"} extension is created. The original files are not modified, 27 ## extension is created. The original files are not modified, but existing
28 ## but existing compressed files will be silently overwritten. If a directory 28 ## compressed files will be silently overwritten. If a directory is
29 ## is specified then @code{gzip} recursively compresses all files in the 29 ## specified then @code{gzip} recursively compresses all files in the
30 ## directory. 30 ## directory.
31 ## 31 ##
32 ## If @var{dir} is defined the compressed files are placed in this directory, 32 ## If @var{dir} is defined the compressed files are placed in this directory,
33 ## rather than the original directory where the uncompressed file resides. 33 ## rather than the original directory where the uncompressed file resides.
34 ## If @var{dir} does not exist it is created. 34 ## If @var{dir} does not exist it is created.
35 ## 35 ##
36 ## The optional output @var{filelist} is a list of the compressed files. 36 ## The optional output @var{filelist} is a list of the compressed files.
37 ## @seealso{gunzip, unpack, bzip2, zip, tar} 37 ## @seealso{gunzip, unpack, bzip2, zip, tar}
38 ## @end deftypefn 38 ## @end deftypefn