Add readme

This commit is contained in:
Bastian Kleineidam 2012-12-13 21:34:57 +01:00
parent 1624856b00
commit 1699408696
2 changed files with 38 additions and 0 deletions

1
README.md Symbolic link
View File

@ -0,0 +1 @@
doc/README.txt

37
doc/README.txt Normal file
View File

@ -0,0 +1,37 @@
Patool
=======
Patool is a portable command line archive file manager.
Introduction
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.
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
ZOO (.zoo) formats. It relies on helper applications to handle
those archive formats (for example bzip2 for BZIP2 archives).
The archive formats TAR (.tar), ZIP (.zip), BZIP2 (.bz2) and
GZIP (.gz) are supported natively and do not require helper
applications to be installed.
Examples
```
patool extract archive.zip otherarchive.rar
patool test --verbose dist.tar.gz
patool list package.deb
patool create --verbose myfiles.zip file1.txt dir/
patool diff release1.0.tar.gz release2.0.zip
patool repack linux-2.6.33.tar.gz linux-2.6.33.tar.bz2
```