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

Rephrase some documentation.

This commit is contained in:
Bastian Kleineidam 2010-03-19 13:09:16 +01:00
parent 95e1ee608d
commit b4a9a04cdf
2 changed files with 53 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/patool.1
View File

@ -50,14 +50,15 @@ be removed and is left as it is.
.br .br
This is the default command if no command was given. This is the default command if no command was given.
.PP .PP
Files are always extracted to a unique temporary directory (in the Files are always extracted to a unique temporary directory in the
current working directory). If the archive contains exactly one current working directory. If the archive contains exactly one
file or directory, the archive contents are moved to the current file or directory, the archive contents are moved to the current
working directory and the temporary directory will be removed. working directory and the temporary directory will be removed.
.br .br
This ensures that always one entry will be extracted. This prevents cluttering the current working directory with a lot
of files from the extracted archive.
.PP .PP
All extracted files are checked that they are readable by the All extracted files are ensured that they are readable by the
current user. current user.
.TP .TP
\fB\-v\fP, \fB\-\-verbose\fP \fB\-v\fP, \fB\-\-verbose\fP

90
doc/patool.txt
View File

@ -1,4 +1,4 @@
PATOOL(1) PATOOL(1) PATOOL(1) PATOOL(1)
@ -13,20 +13,21 @@ SYNOPSIS
patool formats patool formats
DESCRIPTION DESCRIPTION
Various archive types can be created, extracted, tested and listed by Various archive types can be created, extracted, tested and
patool. The advantage of patool is its simplicity in handling archive listed by patool. The advantage of patool is its simplicity in
files without having to remember a myriad of programs and options. 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 a fall‐ The archive format is determined by the file(1) program and as
back by the archive file extension. a fallback by the archive file extension.
patool supports 7z (.7z), ACE (.ace), ALZIP (.alz), AR (.a), ARC patool supports 7z (.7z), ACE (.ace), ALZIP (.alz), AR (.a),
(.arc), ARJ (.arj), BZIP2 (.bz2), CAB (.cab), compress (.Z), CPIO ARC (.arc), ARJ (.arj), BZIP2 (.bz2), CAB (.cab), compress
(.cpio), DEB (.deb), GZIP (.gz), LRZIP (.lrz), LZH (.lha, .lzh), LZIP (.Z), CPIO (.cpio), DEB (.deb), GZIP (.gz), LRZIP (.lrz), LZH
(.lz), LZMA (.lzma), LZOP (.lzo), RPM (.rpm), RAR (.rar), TAR (.tar), (.lha, .lzh), LZIP (.lz), LZMA (.lzma), LZOP (.lzo), RPM
XZ (.xz) and ZIP (.zip, .jar) formats. It relies on helper applica‐ (.rpm), RAR (.rar), TAR (.tar), XZ (.xz) and ZIP (.zip, .jar)
tions to handle those archive formats (for example bzip2 for BZIP2 ar‐ formats. It relies on helper applications to handle those ar‐
chives). chive formats (for example bzip2 for BZIP2 archives).
EXAMPLES EXAMPLES
patool extract archive.zip otherarchive.rar patool extract archive.zip otherarchive.rar
@ -40,60 +41,65 @@ COMMANDS
Several commands and options are available. Several commands and options are available.
extract extract
Extract files from an archive. The original archive will never be Extract files from an archive. The original archive will never
removed and is left as it is. be removed and is left as it is.
This is the default command if no command was given. This is the default command if no command was given.
Files are always extracted to a unique temporary directory (in the cur‐ Files are always extracted to a unique temporary directory in
rent working directory). If the archive contains exactly one file or the current working directory. If the archive contains exactly
directory, the archive contents are moved to the current working direc‐ one file or directory, the archive contents are moved to the
tory and the temporary directory will be removed. current working directory and the temporary directory will be
This ensures that always one entry will be extracted. removed.
This prevents cluttering the current working directory with a
lot of files from the extracted archive.
All extracted files are checked that they are readable by the current All extracted files are ensured that they are readable by the
user. current user.
-v, --verbose -v, --verbose
Be verbose when extracting (if the helper application supports Be verbose when extracting (if the helper application
it). supports it).
list list
List files in an archive. List files in an archive.
-v, --verbose -v, --verbose
Verbose archive listing (if the helper application supports it). Verbose archive listing (if the helper application sup‐
ports it).
create create
Create an archive from given files. At least on of the given files to Create an archive from given files. At least on of the given
add to the archive has to exist (non-existing files are ignored). The files to add to the archive has to exist (non-existing files
format of the archive to create is determined by the archive file are ignored). The format of the archive to create is deter‐
extension. mined by the archive file extension.
-v, --verbose -v, --verbose
Verbose operation (if the helper application supports it). Verbose operation (if the helper application supports
it).
test test
Test files in an archive. If the helper application does not support Test files in an archive. If the helper application does not
testing, the archive contents are listed instead. support testing, the archive contents are listed instead.
-v, --verbose -v, --verbose
Verbose archive testing (if the helper application supports it). Verbose archive testing (if the helper application sup‐
ports it).
diff diff
Show differences between two archives with the diff(1) utility. The Show differences between two archives with the diff(1) utility.
diff options used are -urN. The diff options used are -urN.
repack repack
Repackage archive to a different format. The target archive format is Repackage archive to a different format. The target archive
determined by the file extension. format is determined by the file extension.
formats formats
Show all supported archive formats (ie. which helper applications are Show all supported archive formats (ie. which helper applica‐
available). tions are available).
HELP OPTION HELP OPTION
Specifying the help option displays help for patool itself, or a com‐ Specifying the help option displays help for patool itself, or
mand. a command.
For example: For example:
patool --help - display help for patool patool --help - display help for patool
patool extract --help - display help for the extract command patool extract --help - display help for the extract command
@ -106,4 +112,4 @@ COPYRIGHT
patool February 2010 PATOOL(1) patool February 2010 PATOOL(1)