Mercurial > octave-nkf

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 f96b9b9f141b
comparison
equal deleted inserted replaced
12499:a3019189ac51 12500:8f2056646dba
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {@var{files} =} unpack (@var{file}) 20 ## @deftypefn {Function File} {@var{files} =} unpack (@var{file})
21 ## @deftypefnx {Function File} {@var{files} =} unpack (@var{file}, @var{dir}) 21 ## @deftypefnx {Function File} {@var{files} =} unpack (@var{file}, @var{dir})
22 ## @deftypefnx {Function File} {@var{files} =} unpack (@var{file}, @var{dir}, @var{filetype}) 22 ## @deftypefnx {Function File} {@var{files} =} unpack (@var{file}, @var{dir}, @var{filetype})
23 ## Unpack the archive @var{file} based on its extension to the directory 23 ## Unpack the archive @var{file} based on its extension to the directory
24 ## @var{dir}. If @var{file} is a cellstr, then all files will be 24 ## @var{dir}. If @var{file} is a list of strings, then each file is
25 ## handled individually. If @var{dir} is not specified, it defaults to 25 ## unpacked individually. If @var{dir} is not specified, it defaults to
26 ## the current directory. It returns a list of @var{files} 26 ## the current directory. If a directory is in the file list, then the
27 ## unpacked. If a directory is in the file list, then the 27 ## @var{filetype} must also be specified.
28 ## @var{filetype} to unpack must also be specified. 28 ##
29 ## 29 ## The optional return value is a list of @var{files} unpacked.
30 ## The @var{files} includes the entire path to the output files. 30 ## @seealso{bzip2, gzip, zip, tar}
31 ## @seealso{bunzip2, tar, untar, gzip, gunzip, zip, unzip}
32 ## @end deftypefn 31 ## @end deftypefn
33 32
34 ## Author: Bill Denney <denney@seas.upenn.edu> 33 ## Author: Bill Denney <denney@seas.upenn.edu>
35 34
36 function filelist = unpack (file, dir = ".", filetype = "") 35 function filelist = unpack (file, dir = ".", filetype = "")