HA
/
patool
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated program description.

This commit is contained in:
Bastian Kleineidam 2013-03-28 19:42:02 +01:00
parent 376b049136
commit b53a094971
3 changed files with 34 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/patool.1
View File

@ -13,7 +13,7 @@
.\" .\"
.TH PATOOL "1" "February 2013" "patool" .TH PATOOL "1" "February 2013" "patool"
.SH NAME .SH NAME
patool - portable archive file manager for the commandline console patool - portable archive file manager
.SH SYNOPSIS .SH SYNOPSIS
\fBpatool\fP [\fIglobal-options\fP] (\fBlist\fP|\fBtest\fP|\fBextract\fP|\fBcreate\fP|\fBdiff\fP|\fBsearch\fP|\fBrepack\fP|\fBformats\fP) [\fIcommand-options\fP] <\fIcommand-arguments\fP>... \fBpatool\fP [\fIglobal-options\fP] (\fBlist\fP|\fBtest\fP|\fBextract\fP|\fBcreate\fP|\fBdiff\fP|\fBsearch\fP|\fBrepack\fP|\fBformats\fP) [\fIcommand-options\fP] <\fIcommand-arguments\fP>...
.SH DESCRIPTION .SH DESCRIPTION

65
doc/patool.txt
View File

@ -3,35 +3,34 @@ PATOOL(1) PATOOL(1)
NAME NAME
patool - portable archive file manager for the commandline con‐ patool - portable archive file manager
sole
SYNOPSIS SYNOPSIS
patool [global-options] (list|test|extract|cre‐ patool [global-options] (list|test|extract|cre‐
ate|diff|search|repack|formats) [command-options] <command- ate|diff|search|repack|formats) [command-options] <command-
arguments>... arguments>...
DESCRIPTION DESCRIPTION
Various archive formats can be created, extracted, tested, Various archive formats can be created, extracted, tested,
listed, searched, repacked and compared by patool. The advan‐ listed, searched, repacked and compared by patool. The advan‐
tage of patool is its simplicity in handling archive files tage of patool is its simplicity in handling archive files
without having to remember a myriad of programs and options. without having to remember a myriad of programs and options.
The archive format is determined by the file(1) program and as The archive format is determined by the file(1) program and as
a fallback by the archive file extension. a fallback by the archive file extension.
patool supports 7z (.7z), ACE (.ace), ADF (.adf), ALZIP (.alz), patool supports 7z (.7z), ACE (.ace), ADF (.adf), ALZIP (.alz),
APE (.ape), AR (.a), ARC (.arc), ARJ (.arj), BZIP2 (.bz2), CAB APE (.ape), AR (.a), ARC (.arc), ARJ (.arj), BZIP2 (.bz2), CAB
(.cab), COMPRESS (.Z), CPIO (.cpio), DEB (.deb), DMS (.dms), (.cab), COMPRESS (.Z), CPIO (.cpio), DEB (.deb), DMS (.dms),
FLAC (.flac), GZIP (.gz), ISO (.iso), LRZIP (.lrz), LZH (.lha, FLAC (.flac), GZIP (.gz), ISO (.iso), LRZIP (.lrz), LZH (.lha,
.lzh), LZIP (.lz), LZMA (.lzma), LZOP (.lzo), RPM (.rpm), RAR .lzh), LZIP (.lz), LZMA (.lzma), LZOP (.lzo), RPM (.rpm), RAR
(.rar), RZIP (.rz), SHN (.shn), TAR (.tar), XZ (.xz), ZIP (.rar), RZIP (.rz), SHN (.shn), TAR (.tar), XZ (.xz), ZIP
(.zip, .jar) and ZOO (.zoo) formats. It relies on helper (.zip, .jar) and ZOO (.zoo) formats. It relies on helper
applications to handle those archive formats (for example bzip2 applications to handle those archive formats (for example bzip2
for BZIP2 archives). for BZIP2 archives).
The archive formats TAR, ZIP, BZIP2 and GZIP are supported The archive formats TAR, ZIP, BZIP2 and GZIP are supported
natively and do not require helper applications to be natively and do not require helper applications to be
installed. installed.
EXAMPLES EXAMPLES
@ -45,7 +44,7 @@ EXAMPLES
GLOBAL OPTIONS GLOBAL OPTIONS
-v, --verbose -v, --verbose
Display more info about what patool does, and display Display more info about what patool does, and display
the output of helper applications. Can be given multiple the output of helper applications. Can be given multiple
times to increase the output even more. times to increase the output even more.
@ -56,7 +55,7 @@ COMMANDS
· The original archive will never be removed. · The original archive will never be removed.
· Files outside the outut directory will never be created. · Files outside the outut directory will never be created.
This relies on archive program options to prevent unpacking This relies on archive program options to prevent unpacking
of files with an absolute path name (eg. --no-abso‐ of files with an absolute path name (eg. --no-abso‐
lute-filenames for cpio(1)). lute-filenames for cpio(1)).
@ -66,22 +65,22 @@ COMMANDS
extract extract
patool extract [--outdir directory] <archive>... patool extract [--outdir directory] <archive>...
Extract files from given archives. The original archives will Extract files from given archives. The original archives will
never be removed and are left as is. never be removed and are left as is.
--outdir directory --outdir directory
Extract to the given output directory. Default is to Extract to the given output directory. Default is to
extract to the current working directory. extract to the current working directory.
If the archive contains exactly one file or directory, the ar‐ If the archive contains exactly one file or directory, the ar‐
chive contents are extracted directly to the output directory. chive contents are extracted directly to the output directory.
Else the files are extracted in a newly created subdirectory of Else the files are extracted in a newly created subdirectory of
the output directory. The new directory is named after the ar‐ the output directory. The new directory is named after the ar‐
chive filename without the extension. chive filename without the extension.
This prevents cluttering the output directory with a lot of This prevents cluttering the output directory with a lot of
files from the extracted archive. files from the extracted archive.
All extracted files are ensured that they are readable by the All extracted files are ensured that they are readable by the
current user. current user.
list list
@ -92,15 +91,15 @@ COMMANDS
create create
patool create <archive> <file-or-directory>... patool create <archive> <file-or-directory>...
Create an archive from given files. All of the given files to Create an archive from given files. All of the given files to
add to the archive must be readable by the current user. The add to the archive must be readable by the current user. The
format of the archive to create is determined by the archive format of the archive to create is determined by the archive
file extension. file extension.
test test
patool test <archive>... patool test <archive>...
Test the given archives. If the helper application does not Test the given archives. If the helper application does not
support testing, the archive contents are listed instead. support testing, the archive contents are listed instead.
diff diff
@ -112,24 +111,24 @@ COMMANDS
search search
patool search <pattern> <archive> patool search <pattern> <archive>
Search in archive contents for given pattern using the grep(1) Search in archive contents for given pattern using the grep(1)
program. The grep options used are -r; additional options can program. The grep options used are -r; additional options can
be supplied with the GREP_OPTIONS environment variable. be supplied with the GREP_OPTIONS environment variable.
repack repack
patool repack <archive> <archive_new> patool repack <archive> <archive_new>
Repackage archive to a different format. The target archive Repackage archive to a different format. The target archive
format is determined by the file extension of archive_new. format is determined by the file extension of archive_new.
formats formats
patool formats patool formats
Show all supported archive formats (ie. which helper applica‐ Show all supported archive formats (ie. which helper applica‐
tions are available). tions are available).
HELP OPTION HELP OPTION
Specifying the help option displays help for patool itself, or Specifying the help option displays help for patool itself, or
a command. a command.
For example: For example:
patool --help - display help for patool patool --help - display help for patool

2
patool
View File

@ -136,7 +136,7 @@ EXAMPLES
def create_argparser(): def create_argparser():
"""Construct and return an argument parser.""" """Construct and return an argument parser."""
parser = ArgumentParser(description="A commandline archive handler.", parser = ArgumentParser(description="An archive file manager.",
epilog=Examples, formatter_class=argparse.RawDescriptionHelpFormatter) epilog=Examples, formatter_class=argparse.RawDescriptionHelpFormatter)
parser.add_argument('--verbose', '-v', action='count', default=0, dest='verbosity', help="verbose operation; can be given multiple times") parser.add_argument('--verbose', '-v', action='count', default=0, dest='verbosity', help="verbose operation; can be given multiple times")
subparsers = parser.add_subparsers(help='the archive command; type "patool COMMAND -h" for command-specific help', dest='command') subparsers = parser.add_subparsers(help='the archive command; type "patool COMMAND -h" for command-specific help', dest='command')