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

Updated documentation and version

This commit is contained in:
Bastian Kleineidam 2010-02-22 18:28:07 +01:00
parent 3c01a64a16
commit 3b2b5573a5
4 changed files with 22 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/patool.1
View File

@ -20,7 +20,9 @@ patool - simple manager for file archives of various types
\fBpatool\fP \fBformats\fP [\fIoptions\fP]
.SH DESCRIPTION
Various archive types can be created, extracted, tested and listed by
\fBpatool\fP.
\fBpatool\fP. The advantage of patool is its simplicity in handling archive
files without having to remember a myriad of programs and options.
.PP
The archive format is determined by the archive file extension and
as a fallback with file(1).
.PP

37
doc/patool.txt
View File

@ -11,33 +11,27 @@ SYNOPSIS
patool formats [options]
DESCRIPTION
Various archive types can be created, extracted, tested and listed by
patool. The archive format is determined by the archive file extension
and as a fallback with file(1).
Various archive types can be created, extracted, tested and listed by patool. The advantage of patool is its simplicity in handling archive files without having to
remember a myriad of programs and options.
patool supports 7z (.7z), ZIP (.zip, .jar), GZIP (.gz), compress (.Z),
BZIP2 (.bz2), TAR (.tar), ARJ (.arj), CAB (.cab), CPIO (.cpio), RPM
(.rpm), DEB (.deb), LZOP (.lzo), LZMA (.lzma), XZ (.xz) and RAR (.rar)
formats. It relies on helper applications to handle those archive for‐
mats (for example bzip2 for BZIP2 archives).
The archive format is determined by the archive file extension and as a fallback with file(1).
patool supports 7z (.7z), ZIP (.zip, .jar), GZIP (.gz), compress (.Z), BZIP2 (.bz2), TAR (.tar), ARJ (.arj), CAB (.cab), CPIO (.cpio), RPM (.rpm), DEB (.deb), LZOP
(.lzo), LZMA (.lzma), XZ (.xz) and RAR (.rar) formats. It relies on helper applications to handle those archive formats (for example bzip2 for BZIP2 archives).
COMMANDS
Several commands and options are available.
extract
Extract files from an archive4. Often one wants to extract all files in
an archive to a single subdirectory. However, some archives contain
multiple files in their root directories. The patool program overcomes
this problem by first extracting files to a unique (temporary) direc‐
tory, and then moving its contents back if possible. This also prevents
local files from being overwritten by mistake.
Extract files from an archive4. Often one wants to extract all files in an archive to a single subdirectory. However, some archives contain multiple files in their
root directories. The patool program overcomes this problem by first extracting files to a unique (temporary) directory, and then moving its contents back if possible.
This also prevents local files from being overwritten by mistake.
--force
Allow overwriting of local files.
--verbose
Be verbose when extracting (if the helper application supports
it).
Be verbose when extracting (if the helper application supports it).
--help Show help for this command.
@ -74,11 +68,9 @@ COMMANDS
--help Show help for this command.
CONFIGURATION
The configuration files (see FILES) can specify which program to use
for each archive format. Per default a list of programs are searched
and the first one will be used for an archive.
Additionally, default options like verbosity and force overwrite can be
configured.
The configuration files (see FILES) can specify which program to use for each archive format. Per default a list of programs are searched and the first one will be used
for an archive.
Additionally, default options like verbosity and force overwrite can be configured.
The configuration format is the Windows INI format.
@ -93,8 +85,7 @@ CONFIGURATION
Supported archive formats are listed by the formats command.
command=/usr/bin/mycommand
Set the application to handle the archive format for given com‐
mand. command can be one of (extract, list, test, create).
Set the application to handle the archive format for given command. command can be one of (extract, list, test, create).
FILES
/etc/patool.conf, ~/.patool.conf - configuration files

2
doc/todo.txt
View File

@ -0,0 +1,2 @@
- Check and list the supported encoding options for tar files
in the "formats" command.

2
setup.py
View File

@ -26,7 +26,7 @@ if not (hasattr(sys, 'version_info') or
from distutils.core import setup
AppName = "patool"
AppVersion = "0.1"
AppVersion = "0.2"
MyName = "Bastian Kleineidam"
MyEmail = "calvin@users.sourceforge.net"