Mercurial > octave
annotate scripts/miscellaneous/bunzip2.m @ 23220:092078913d54
maint: Merge stable to default.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 22 Feb 2017 12:58:07 -0500 |
parents | ef4d915df748 3ac9f9ecfae5 |
children | 194eb4bd202b |
rev | line source |
---|---|
23219
3ac9f9ecfae5
maint: Update copyright dates.
John W. Eaton <jwe@octave.org>
parents:
23083
diff
changeset
|
1 ## Copyright (C) 2006-2017 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 | |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
7 ## the Free Software Foundation; either version 3 of the License, or |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
8 ## (at 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 | |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
13 ## GNU General Public License for more details. |
6082 | 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 -*- | |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
20 ## @deftypefn {} {@var{filelist} =} bunzip2 (@var{bzfile}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
21 ## @deftypefnx {} {@var{filelist} =} bunzip2 (@var{bzfile}, @var{dir}) |
19258
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
22 ## Unpack the bzip2 archive @var{bzfile}. |
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
23 ## |
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
24 ## If @var{dir} is specified the files are unpacked in this directory rather |
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
25 ## than the one where @var{bzfile} is located. |
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
26 ## |
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
27 ## The optional output @var{filelist} is a list of the uncompressed files. |
12500
8f2056646dba
Improve docstrings for archive functions (gzip, bzip2, etc.)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
28 ## @seealso{bzip2, unpack, gunzip, unzip, untar} |
6082 | 29 ## @end deftypefn |
30 | |
31 ## Author: Bill Denney <denney@seas.upenn.edu> | |
32 | |
19258
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
33 function filelist = bunzip2 (bzfile, dir = []) |
6082 | 34 |
19258
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
35 if (nargin < 1 || nargin > 2) |
6082 | 36 print_usage (); |
37 endif | |
38 | |
19258
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
39 if (isempty (dir)) |
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
40 dir = fileparts (bzfile); |
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
41 endif |
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
42 |
6599 | 43 if (nargout > 0) |
19258
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
44 filelist = unpack (bzfile, dir, "bunzip2"); |
6599 | 45 else |
19258
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
46 unpack (bzfile, dir, "bunzip2"); |
6599 | 47 endif |
6082 | 48 |
49 endfunction | |
17338
1c89599167a6
maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
50 |
19258
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
51 |
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
52 ## Tests for this m-file are located in bzip2.m |
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
53 ## Remove from test statistics |
a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
54 %!assert (1) |