Mercurial > octave-nkf
annotate scripts/miscellaneous/gunzip.m @ 19277:91a6f06c5052
Overhaul gzip.m and gunzip.m
These functions now operate in the directory where the archive file is
located rather than the current directory.
* gunzip.m: Redo docstring. Default directory for unpacking is now the
directory where the .gz file resides. Eliminate unnecessary varargout
usage. Eliminate unnecessary mfilename() function call by replacing with
string "gunzip". Add %!assert(1) to remove file from test statistics.
The tests are located in gzip.m
* gzip.m: Redo docstring. Rename outdir input variable to dir to match
other compress/uncompress routines.
* unpack.m: Redo seealso links in docstring.
| author | Rik <rik@octave.org> |
|---|---|
| date | Thu, 09 Oct 2014 20:38:04 -0700 |
| parents | d63878346099 |
| children | a4e993343e93 |
| rev | line source |
|---|---|
|
17744
d63878346099
maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents:
17338
diff
changeset
|
1 ## Copyright (C) 2006-2013 Bill Denney |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
2 ## |
| 6082 | 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. | |
| 6082 | 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/>. | |
| 6082 | 18 |
| 19 ## -*- texinfo -*- | |
| 19277 | 20 ## @deftypefn {Function File} {@var{files} =} gunzip (@var{gzfile}) |
| 21 ## @deftypefnx {Function File} {@var{files} =} gunzip (@var{gzfile}, @var{dir}) | |
| 22 ## Unpack the gzip archive @var{gzfile}. | |
| 23 ## | |
| 24 ## If @var{gzfile} is a directory, all gzfiles in the directory will be | |
| 25 ## recursively unpacked. | |
| 26 ## | |
| 27 ## If @var{dir} is specified the files are unpacked in this directory rather | |
| 28 ## than the one where @var{gzfile} is located. | |
| 29 ## | |
| 30 ## The optional output @var{files} is a list of the uncompressed files. | |
| 31 ## @seealso{gzip, bunzip2, unzip, untar, unpack} | |
| 6082 | 32 ## @end deftypefn |
| 33 | |
| 34 ## Author: Bill Denney <denney@seas.upenn.edu> | |
| 35 | |
| 19277 | 36 function files = gunzip (gzfile, dir) |
| 6082 | 37 |
| 19277 | 38 if (nargin < 1 || nargin > 2) |
| 6082 | 39 print_usage (); |
| 40 endif | |
| 41 | |
| 19277 | 42 if (isempty (dir)) |
| 43 dir = fileparts (gzfile); | |
| 44 endif | |
| 45 | |
| 6599 | 46 if (nargout > 0) |
| 19277 | 47 files = unpack (gzfile, dir, "gunzip"); |
| 6599 | 48 else |
| 19277 | 49 unpack (gzfile, dir, "gunzip"); |
| 6599 | 50 endif |
| 6082 | 51 |
| 52 endfunction | |
|
17338
1c89599167a6
maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
53 |
| 19277 | 54 |
| 55 ## Tests for this m-file are located in gzip.m | |
| 56 ## Remove from test statistics | |
| 57 %!assert (1); | |
| 58 |