patool

History

Bastian Kleineidam a37ab688a1 Add missing GZIP creation to 7z modules.		2013-07-26 22:31:53 +02:00
..
icon	Add a logo and fix dist building.	2012-05-18 22:55:40 +02:00
web	Fix download link.	2013-07-19 15:20:48 +02:00
README.txt	Add API docs.	2013-05-06 20:43:02 +02:00
changelog.txt	Add missing GZIP creation to 7z modules.	2013-07-26 22:31:53 +02:00
development.txt	Fix typo.	2013-07-06 12:58:09 -04:00
install.txt	Updated installation instructions.	2013-02-21 17:50:08 +01:00
patool.1	Fix typo.	2013-06-11 21:12:02 +02:00
patool.txt	Fix typo.	2013-06-11 21:12:02 +02:00

README.txt

Patool
=======

Patool is an archive file manager.

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.

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), ISO (.iso), 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 installed.

Examples
---------
```
patool extract archive.zip otherarchive.rar
patool test --verbose dist.tar.gz
patool list package.deb
patool create --verbose /path/to/myfiles.zip file1.txt dir/
patool diff release1.0.tar.gz 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
```

Website
--------
See http://wummel.github.io/patool/ for more info and downloads.

API
----
You can use patool functions from other Python applications.
Log output will be on sys.stdout and sys.stderr.
On errors, `PatoolError` will be raised.

```
import patoolib
patoolib.extract_archive("archive.zip", outdir="/tmp")
patoolib.test_archive("dist.tar.gz", verbosity=1)
patoolib.list_archive("package.deb")
patoolib.create_archive("/path/to/myfiles.zip", ("file1.txt", "dir/"))
patoolib.diff_archives("release1.0.tar.gz", "release2.0.zip")
patoolib.search_archive("def urlopen", "python3.3.tar.gz")
patoolib.repack_archive("linux-2.6.33.tar.gz", "linux-2.6.33.tar.bz2")
```

Test suite status
------------------
Patool has extensive unit tests to ensure the code quality.
[Travis CI](https://travis-ci.org/) is used for continuous build
and test integration.

[![Build Status](https://travis-ci.org/wummel/patool.png)](https://travis-ci.org/wummel/patool)