Mercurial > octave-antonio
annotate scripts/miscellaneous/gzip.m @ 20164:df437a52bcaf stable
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 |
| rev | line source |
|---|---|
|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19405
diff
changeset
|
1 ## Copyright (C) 2007-2015 David Bateman |
| 6869 | 2 ## |
| 3 ## This file is part of Octave. | |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
| 8 ## your option) any later version. | |
| 6869 | 9 ## |
| 10 ## Octave is distributed in the hope that it will be useful, but | |
| 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 ## General Public License for more details. | |
| 14 ## | |
| 15 ## You should have received a copy of the GNU General Public License | |
| 7016 | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 6869 | 18 |
| 19 ## -*- texinfo -*- | |
| 19243 | 20 ## @deftypefn {Function File} {@var{filelist} =} gzip (@var{files}) |
| 21 ## @deftypefnx {Function File} {@var{filelist} =} gzip (@var{files}, @var{dir}) | |
| 22 ## Compress the list of files and directories specified in @var{files}. | |
| 23 ## | |
|
20164
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
24 ## @var{files} is a character array or cell array of strings. Shell wildcards |
|
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
25 ## in the filename such as @samp{*} or @samp{?} are accepted and expanded. |
|
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
26 ## Each file is compressed separately and a new file with a @file{".gz"} |
|
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
27 ## extension is created. The original files are not modified, but existing |
|
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
28 ## compressed files will be silently overwritten. If a directory is |
|
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
29 ## specified then @code{gzip} recursively compresses all files in the |
|
19258
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
19243
diff
changeset
|
30 ## directory. |
| 19243 | 31 ## |
|
19258
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
19243
diff
changeset
|
32 ## If @var{dir} is defined the compressed files are placed in this directory, |
|
20164
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
33 ## rather than the original directory where the uncompressed file resides. |
|
19258
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
19243
diff
changeset
|
34 ## If @var{dir} does not exist it is created. |
| 19243 | 35 ## |
| 36 ## The optional output @var{filelist} is a list of the compressed files. | |
|
19258
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
19243
diff
changeset
|
37 ## @seealso{gunzip, unpack, bzip2, zip, tar} |
| 6869 | 38 ## @end deftypefn |
| 39 | |
| 19243 | 40 function filelist = gzip (varargin) |
| 41 | |
| 42 if (nargin < 1 || nargin > 2 || nargout > 1) | |
| 6869 | 43 print_usage (); |
| 44 endif | |
|
13141
e81ddf9cacd5
maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
12500
diff
changeset
|
45 |
|
12499
a3019189ac51
Improve file archiving functions (gzip, bzip2, zip, unpack)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
46 if (nargout == 0) |
|
a3019189ac51
Improve file archiving functions (gzip, bzip2, zip, unpack)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
47 __xzip__ ("gzip", "gz", "gzip -r %s", varargin{:}); |
|
a3019189ac51
Improve file archiving functions (gzip, bzip2, zip, unpack)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
48 else |
| 19243 | 49 filelist = __xzip__ ("gzip", "gz", "gzip -r %s", varargin{:}); |
|
12499
a3019189ac51
Improve file archiving functions (gzip, bzip2, zip, unpack)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
50 endif |
|
a3019189ac51
Improve file archiving functions (gzip, bzip2, zip, unpack)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
51 |
| 6869 | 52 endfunction |
| 53 | |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14359
diff
changeset
|
54 |
|
8349
02beb5be5683
add bzip2 function
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
55 %!xtest |
|
17336
b81b9d079515
Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
56 %! ## test gzip together with gunzip |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14359
diff
changeset
|
57 %! unwind_protect |
| 19243 | 58 %! filename = tempname; |
| 59 %! dummy = pi; | |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14359
diff
changeset
|
60 %! save (filename, "dummy"); |
| 19243 | 61 %! dirname = tempname; |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14359
diff
changeset
|
62 %! mkdir (dirname); |
| 19243 | 63 %! filelist = gzip (filename, dirname); |
| 64 %! filelist = filelist{1}; | |
| 65 %! [~, basename, extension] = fileparts (filename); | |
| 66 %! if (! strcmp (filelist, [dirname, filesep, basename, extension, ".gz"])) | |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14359
diff
changeset
|
67 %! error ("gzipped file does not match expected name!"); |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14359
diff
changeset
|
68 %! endif |
| 19243 | 69 %! if (! exist (filelist, "file")) |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14359
diff
changeset
|
70 %! error ("gzipped file cannot be found!"); |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14359
diff
changeset
|
71 %! endif |
| 19243 | 72 %! gunzip (filelist); |
|
18301
57d5bd8700df
gzip.m: Re-write %!test not to depend on external system diff command.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
73 %! fid = fopen (filename, "rb"); |
|
57d5bd8700df
gzip.m: Re-write %!test not to depend on external system diff command.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
74 %! assert (fid >= 0); |
|
57d5bd8700df
gzip.m: Re-write %!test not to depend on external system diff command.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
75 %! orig_data = fread (fid); |
|
57d5bd8700df
gzip.m: Re-write %!test not to depend on external system diff command.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
76 %! fclose (fid); |
|
57d5bd8700df
gzip.m: Re-write %!test not to depend on external system diff command.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
77 %! fid = fopen ([dirname filesep basename extension], "rb"); |
|
57d5bd8700df
gzip.m: Re-write %!test not to depend on external system diff command.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
78 %! assert (fid >= 0); |
|
57d5bd8700df
gzip.m: Re-write %!test not to depend on external system diff command.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
79 %! new_data = fread (fid); |
|
57d5bd8700df
gzip.m: Re-write %!test not to depend on external system diff command.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
80 %! fclose (fid); |
|
57d5bd8700df
gzip.m: Re-write %!test not to depend on external system diff command.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
81 %! if (orig_data != new_data) |
| 19243 | 82 %! error ("gunzipped file not equal to original file!"); |
|
18301
57d5bd8700df
gzip.m: Re-write %!test not to depend on external system diff command.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
83 %! endif |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14359
diff
changeset
|
84 %! unwind_protect_cleanup |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14359
diff
changeset
|
85 %! delete (filename); |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14359
diff
changeset
|
86 %! delete ([dirname, filesep, basename, extension]); |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14359
diff
changeset
|
87 %! rmdir (dirname); |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14359
diff
changeset
|
88 %! end_unwind_protect |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14359
diff
changeset
|
89 |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14359
diff
changeset
|
90 %!error gzip () |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14359
diff
changeset
|
91 %!error gzip ("1", "2", "3") |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14359
diff
changeset
|
92 %!error <FILES must be a character array or cellstr> gzip (1) |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14359
diff
changeset
|
93 |