Updated program description.
This commit is contained in:
Bastian Kleineidam
parent
376b049136
commit
b53a094971
|
|
@ -13,7 +13,7 @@
|
|||
.\"
|
||||
.TH PATOOL "1" "February 2013" "patool"
|
||||
.SH NAME
|
||||
patool - portable archive file manager for the commandline console
|
||||
patool - portable archive file manager
|
||||
.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>...
|
||||
.SH DESCRIPTION
|
||||
|
|
|
|||
|
|
@ -3,35 +3,34 @@ PATOOL(1) PATOOL(1)
|
|||
|
||||
|
||||
NAME
|
||||
patool - portable archive file manager for the commandline con‐
|
||||
sole
|
||||
patool - portable archive file manager
|
||||
|
||||
SYNOPSIS
|
||||
patool [global-options] (list|test|extract|cre‐
|
||||
patool [global-options] (list|test|extract|cre‐
|
||||
ate|diff|search|repack|formats) [command-options] <command-
|
||||
arguments>...
|
||||
|
||||
DESCRIPTION
|
||||
Various archive formats can be created, extracted, tested,
|
||||
listed, searched, repacked and compared by patool. The advan‐
|
||||
tage of patool is its simplicity in handling archive files
|
||||
Various archive formats can be created, extracted, tested,
|
||||
listed, searched, repacked and compared by patool. The advan‐
|
||||
tage of patool is its simplicity in handling archive files
|
||||
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.
|
||||
|
||||
patool supports 7z (.7z), ACE (.ace), ADF (.adf), ALZIP (.alz),
|
||||
APE (.ape), AR (.a), ARC (.arc), ARJ (.arj), BZIP2 (.bz2), CAB
|
||||
(.cab), COMPRESS (.Z), CPIO (.cpio), DEB (.deb), DMS (.dms),
|
||||
FLAC (.flac), GZIP (.gz), ISO (.iso), LRZIP (.lrz), LZH (.lha,
|
||||
.lzh), LZIP (.lz), LZMA (.lzma), LZOP (.lzo), RPM (.rpm), RAR
|
||||
(.rar), RZIP (.rz), SHN (.shn), TAR (.tar), XZ (.xz), ZIP
|
||||
(.zip, .jar) and ZOO (.zoo) formats. It relies on helper
|
||||
APE (.ape), AR (.a), ARC (.arc), ARJ (.arj), BZIP2 (.bz2), CAB
|
||||
(.cab), COMPRESS (.Z), CPIO (.cpio), DEB (.deb), DMS (.dms),
|
||||
FLAC (.flac), GZIP (.gz), ISO (.iso), LRZIP (.lrz), LZH (.lha,
|
||||
.lzh), LZIP (.lz), LZMA (.lzma), LZOP (.lzo), RPM (.rpm), RAR
|
||||
(.rar), RZIP (.rz), SHN (.shn), TAR (.tar), XZ (.xz), ZIP
|
||||
(.zip, .jar) and ZOO (.zoo) formats. It relies on helper
|
||||
applications to handle those archive formats (for example bzip2
|
||||
for BZIP2 archives).
|
||||
|
||||
The archive formats TAR, ZIP, BZIP2 and GZIP are supported
|
||||
natively and do not require helper applications to be
|
||||
The archive formats TAR, ZIP, BZIP2 and GZIP are supported
|
||||
natively and do not require helper applications to be
|
||||
installed.
|
||||
|
||||
EXAMPLES
|
||||
|
|
@ -45,7 +44,7 @@ EXAMPLES
|
|||
|
||||
GLOBAL OPTIONS
|
||||
-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
|
||||
times to increase the output even more.
|
||||
|
||||
|
|
@ -56,7 +55,7 @@ COMMANDS
|
|||
|
||||
· 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
|
||||
of files with an absolute path name (eg. --no-abso‐
|
||||
lute-filenames for cpio(1)).
|
||||
|
|
@ -66,22 +65,22 @@ COMMANDS
|
|||
extract
|
||||
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.
|
||||
|
||||
--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.
|
||||
|
||||
If the archive contains exactly one file or directory, the ar‐
|
||||
chive contents are extracted directly to the output directory.
|
||||
If the archive contains exactly one file or directory, the ar‐
|
||||
chive contents are extracted directly to the output directory.
|
||||
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.
|
||||
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.
|
||||
|
||||
All extracted files are ensured that they are readable by the
|
||||
All extracted files are ensured that they are readable by the
|
||||
current user.
|
||||
|
||||
list
|
||||
|
|
@ -92,15 +91,15 @@ COMMANDS
|
|||
create
|
||||
patool create <archive> <file-or-directory>...
|
||||
|
||||
Create an archive from given files. All of the given files to
|
||||
add to the archive must be readable by the current user. The
|
||||
format of the archive to create is determined by the archive
|
||||
Create an archive from given files. All of the given files to
|
||||
add to the archive must be readable by the current user. The
|
||||
format of the archive to create is determined by the archive
|
||||
file extension.
|
||||
|
||||
test
|
||||
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.
|
||||
|
||||
diff
|
||||
|
|
@ -112,24 +111,24 @@ COMMANDS
|
|||
search
|
||||
patool search <pattern> <archive>
|
||||
|
||||
Search in archive contents for given pattern using the grep(1)
|
||||
program. The grep options used are -r; additional options can
|
||||
Search in archive contents for given pattern using the grep(1)
|
||||
program. The grep options used are -r; additional options can
|
||||
be supplied with the GREP_OPTIONS environment variable.
|
||||
|
||||
repack
|
||||
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.
|
||||
|
||||
formats
|
||||
patool formats
|
||||
|
||||
Show all supported archive formats (ie. which helper applica‐
|
||||
Show all supported archive formats (ie. which helper applica‐
|
||||
tions are available).
|
||||
|
||||
HELP OPTION
|
||||
Specifying the help option displays help for patool itself, or
|
||||
Specifying the help option displays help for patool itself, or
|
||||
a command.
|
||||
For example:
|
||||
patool --help - display help for patool
|
||||
|
|
|
|||
2
patool
2
patool
|
|
@ -136,7 +136,7 @@ EXAMPLES
|
|||
|
||||
def create_argparser():
|
||||
"""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)
|
||||
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')
|
||||
|
|
|
|||
Loading…
Reference in New Issue