diff --git a/doc/README.txt b/doc/README.txt index 82f58f8..34b7e9d 100644 --- a/doc/README.txt +++ b/doc/README.txt @@ -1,8 +1,10 @@ Patool ======= -Various archive types can be created, extracted, tested and -listed with patool. The advantage of patool is its simplicity in +Patool is an archive file manager for the commandline console. + +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 programs and options. diff --git a/doc/patool.1 b/doc/patool.1 index 0542285..fc270d5 100644 --- a/doc/patool.1 +++ b/doc/patool.1 @@ -13,11 +13,11 @@ .\" .TH PATOOL "1" "February 2013" "patool" .SH NAME -patool - portable command line archive file manager +patool - portable archive file manager for the commandline console .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 -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 files without having to remember a myriad of programs and options. .PP @@ -41,7 +41,7 @@ installed. \fBpatool --verbose test dist.tar.gz\fP \fBpatool list package.deb\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 repack linux-2.6.33.tar.gz linux-2.6.33.tar.bz2\fP .SH GLOBAL OPTIONS @@ -56,17 +56,19 @@ The following rules apply to all commands: Existing files are never overwritten. .IP "\(bu" 4 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 The following commands are available. .SS extract -\fBpatool\fP \fBextract\fP [\fIoptions\fP] <\fIarchive\fP>... +\fBpatool\fP \fBextract\fP [\fB\-\-outdir\fP \fIdirectory\fP] <\fIarchive\fP>... .PP Extract files from given archives. The original archives will never be removed and are left as is. -.PP -Options: .TP -\fB\-\-outdir\fP DIRECTORY +\fB\-\-outdir\fP \fIdirectory\fP Extract to the given output directory. Default is to extract to the current working directory. .PP diff --git a/doc/patool.txt b/doc/patool.txt index a237c9c..6c5af3f 100644 --- a/doc/patool.txt +++ b/doc/patool.txt @@ -3,33 +3,34 @@ PATOOL(1) PATOOL(1) NAME - patool - portable command line archive file manager + patool - portable archive file manager for the commandline con‐ + sole SYNOPSIS - patool [global-options] - (list|test|extract|create|diff|search|repack|formats) - [command-options] ... + patool [global-options] (list|test|extract|cre‐ + ate|diff|search|repack|formats) [command-options] ... DESCRIPTION - Various archive types 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), 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 + APE (.ape), AR (.a), ARC (.arc), ARJ (.arj), BZIP2 (.bz2), CAB + (.cab), compress (.Z), CPIO (.cpio), DEB (.deb), DMS (.dms), + FLAC (.flac), GZIP (.gz), 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 @@ -37,13 +38,13 @@ EXAMPLES patool --verbose test dist.tar.gz patool list package.deb 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 repack linux-2.6.33.tar.gz linux-2.6.33.tar.bz2 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. @@ -54,17 +55,20 @@ COMMANDS · 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. extract - patool extract [options] ... + patool extract [--outdir directory] ... Extract files from given archives. The original archives will 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 current working directory. diff --git a/setup.py b/setup.py index 39ad8c0..9c3227c 100644 --- a/setup.py +++ b/setup.py @@ -273,10 +273,11 @@ class MyRegister (register, object): args = dict( name = AppName, version = AppVersion, - description = "portable command line archive file manager", - long_description = """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. + description = "portable archive file manager for the commandline console", + long_description = """Various archive formats can be created, extracted, tested, listed, +searched, compared and repacked by patool. The advantage 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 a fallback by the archive file extension. @@ -305,7 +306,7 @@ installed. packages = ['patoolib', 'patoolib.programs'], data_files = data_files, scripts = ['patool'], - keywords = "archiver,compression,commandline", + keywords = "archiver,archive,compression,commandline,console,manager", classifiers = [ 'Environment :: Console', 'Topic :: System :: Archiving',