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

Updated documentation.

This commit is contained in:
Bastian Kleineidam 2013-02-26 20:42:05 +01:00
parent 3ea731db9b
commit 42e328f681
4 changed files with 44 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/README.txt
View File

@ -1,8 +1,10 @@
Patool Patool
======= =======
Various archive types can be created, extracted, tested and Patool is an archive file manager for the commandline console.
listed with patool. The advantage of patool is its simplicity in
Various archive formats can be created, extracted, tested, listed,
searched, repacked and compared with patool. The advantage of patool is its simplicity in
handling archive files without having to remember a myriad of handling archive files without having to remember a myriad of
programs and options. programs and options.

16
doc/patool.1
View File

@ -13,11 +13,11 @@
.\" .\"
.TH PATOOL "1" "February 2013" "patool" .TH PATOOL "1" "February 2013" "patool"
.SH NAME .SH NAME
patool - portable command line archive file manager patool - portable archive file manager for the commandline console
.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
Various archive types can be created, extracted, tested, listed, searched, repacked and compared by Various archive formats can be created, extracted, tested, listed, searched, repacked and compared by
\fBpatool\fP. The advantage of patool is its simplicity in handling archive \fBpatool\fP. The advantage of patool is its simplicity in handling archive
files without having to remember a myriad of programs and options. files without having to remember a myriad of programs and options.
.PP .PP
@ -41,7 +41,7 @@ installed.
\fBpatool --verbose test dist.tar.gz\fP \fBpatool --verbose test dist.tar.gz\fP
\fBpatool list package.deb\fP \fBpatool list package.deb\fP
\fPpatool --verbose create myfiles.zip file1.txt dir/\fP \fPpatool --verbose create myfiles.zip file1.txt dir/\fP
\fBpatool diff release1.0.tar.gz release2.0.zip\fP \fBpatool diff release1.0.tar.xz release2.0.zip\fP
\fBpatool search "def urlopen" python-3.3.tar.gz\fP \fBpatool search "def urlopen" python-3.3.tar.gz\fP
\fBpatool repack linux-2.6.33.tar.gz linux-2.6.33.tar.bz2\fP \fBpatool repack linux-2.6.33.tar.gz linux-2.6.33.tar.bz2\fP
.SH GLOBAL OPTIONS .SH GLOBAL OPTIONS
@ -56,17 +56,19 @@ The following rules apply to all commands:
Existing files are never overwritten. Existing files are never overwritten.
.IP "\(bu" 4 .IP "\(bu" 4
The original archive will never be removed. The original archive will never be removed.
.IP "\(bu" 4
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. \fB\-\-no\-absolute\-filenames\fP for \fBcpio(1)\fP).
.PP .PP
The following commands are available. The following commands are available.
.SS extract .SS extract
\fBpatool\fP \fBextract\fP [\fIoptions\fP] <\fIarchive\fP>... \fBpatool\fP \fBextract\fP [\fB\-\-outdir\fP \fIdirectory\fP] <\fIarchive\fP>...
.PP .PP
Extract files from given archives. The original archives will never Extract files from given archives. The original archives will never
be removed and are left as is. be removed and are left as is.
.PP
Options:
.TP .TP
\fB\-\-outdir\fP DIRECTORY \fB\-\-outdir\fP \fIdirectory\fP
Extract to the given output directory. Default is to extract to Extract to the given output directory. Default is to extract to
the current working directory. the current working directory.
.PP .PP

46
doc/patool.txt
View File

@ -3,33 +3,34 @@ PATOOL(1) PATOOL(1)
NAME NAME
patool - portable command line archive file manager patool - portable archive file manager for the commandline con‐
sole
SYNOPSIS SYNOPSIS
patool [global-options] patool [global-options] (list|test|extract|cre‐
(list|test|extract|create|diff|search|repack|formats) ate|diff|search|repack|formats) [command-options] <command-
[command-options] <command-arguments>... arguments>...
DESCRIPTION DESCRIPTION
Various archive types 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), LRZIP (.lrz), LZH (.lha, .lzh), LZIP FLAC (.flac), GZIP (.gz), LRZIP (.lrz), LZH (.lha, .lzh), LZIP
(.lz), LZMA (.lzma), LZOP (.lzo), RPM (.rpm), RAR (.rar), RZIP (.lz), LZMA (.lzma), LZOP (.lzo), RPM (.rpm), RAR (.rar), RZIP
(.rz), SHN (.shn), TAR (.tar), XZ (.xz), ZIP (.zip, .jar) and (.rz), SHN (.shn), TAR (.tar), XZ (.xz), ZIP (.zip, .jar) and
ZOO (.zoo) formats. It relies on helper applications to handle ZOO (.zoo) formats. It relies on helper applications to handle
those archive formats (for example bzip2 for BZIP2 archives). those archive formats (for example bzip2 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
@ -37,13 +38,13 @@ EXAMPLES
patool --verbose test dist.tar.gz patool --verbose test dist.tar.gz
patool list package.deb patool list package.deb
patool --verbose create myfiles.zip file1.txt dir/ patool --verbose create myfiles.zip file1.txt dir/
patool diff release1.0.tar.gz release2.0.zip patool diff release1.0.tar.xz release2.0.zip
patool search "def urlopen" python-3.3.tar.gz patool search "def urlopen" python-3.3.tar.gz
patool repack linux-2.6.33.tar.gz linux-2.6.33.tar.bz2 patool repack linux-2.6.33.tar.gz linux-2.6.33.tar.bz2
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.
@ -54,17 +55,20 @@ COMMANDS
· The original archive will never be removed. · The original archive will never be removed.
· 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)).
The following commands are available. The following commands are available.
extract extract
patool extract [options] <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.
Options: --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.

11
setup.py
View File

@ -273,10 +273,11 @@ class MyRegister (register, object):
args = dict( args = dict(
name = AppName, name = AppName,
version = AppVersion, version = AppVersion,
description = "portable command line archive file manager", description = "portable archive file manager for the commandline console",
long_description = """Various archive types can be created, extracted, tested and listed by long_description = """Various archive formats can be created, extracted, tested, listed,
patool. The advantage of patool is its simplicity in handling archive searched, compared and repacked by patool. The advantage of patool
files without having to remember a myriad of programs and options. 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 a The archive format is determined by the file(1) program and as a
fallback by the archive file extension. fallback by the archive file extension.
@ -305,7 +306,7 @@ installed.
packages = ['patoolib', 'patoolib.programs'], packages = ['patoolib', 'patoolib.programs'],
data_files = data_files, data_files = data_files,
scripts = ['patool'], scripts = ['patool'],
keywords = "archiver,compression,commandline", keywords = "archiver,archive,compression,commandline,console,manager",
classifiers = [ classifiers = [
'Environment :: Console', 'Environment :: Console',
'Topic :: System :: Archiving', 'Topic :: System :: Archiving',