From 1699408696196ee873e6bc707bd463069426ba21 Mon Sep 17 00:00:00 2001 From: Bastian Kleineidam Date: Thu, 13 Dec 2012 21:34:57 +0100 Subject: [PATCH] Add readme --- README.md | 1 + doc/README.txt | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 120000 README.md create mode 100644 doc/README.txt diff --git a/README.md b/README.md new file mode 120000 index 0000000..253de0c --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +doc/README.txt \ No newline at end of file diff --git a/doc/README.txt b/doc/README.txt new file mode 100644 index 0000000..f4d91a3 --- /dev/null +++ b/doc/README.txt @@ -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 +```