Added cross-references between the various archive file formats.

This commit is contained in:
Mark Summerfield 2007-11-05 09:22:48 +00:00
parent 80e95c142e
commit aea6e5913b
5 changed files with 21 additions and 8 deletions

View File

@ -14,7 +14,10 @@ This module provides a comprehensive interface for the bz2 compression library.
It implements a complete file interface, one-shot (de)compression functions, and
types for sequential (de)compression.
Here is a resume of the features offered by the bz2 module:
For other archive formats, see the :mod:`gzip`, :mod:`zipfile`, and
:mod:`tarfile` modules.
Here is a summary of the features offered by the bz2 module:
* :class:`BZ2File` class implements a complete file interface, including
:meth:`readline`, :meth:`readlines`, :meth:`writelines`, :meth:`seek`, etc;
@ -32,9 +35,7 @@ Here is a resume of the features offered by the bz2 module:
* One-shot (de)compression supported by :func:`compress` and :func:`decompress`
functions;
* Thread safety uses individual locking mechanism;
* Complete inline documentation;
* Thread safety uses individual locking mechanism.
(De)compression of files

View File

@ -15,6 +15,9 @@ formats which can be decompressed by the :program:`gzip` and :program:`gunzip`
programs, such as those produced by :program:`compress` and :program:`pack`,
are not supported by this module.
For other archive formats, see the :mod:`bz2`, :mod:`zipfile`, and
:mod:`tarfile` modules.
The module defines the following items:

View File

@ -13,10 +13,13 @@
.. sectionauthor:: Lars Gustäbel <lars@gustaebel.de>
The :mod:`tarfile` module makes it possible to read and create tar archives.
The :mod:`tarfile` module makes it possible to read and write tar
archives, including those using gzip or bz2 compression.
(`.zip` files can be read and written using the :mod:`zipfile` module.)
Some facts and figures:
* reads and writes :mod:`gzip` and :mod:`bzip2` compressed archives.
* reads and writes :mod:`gzip` and :mod:`bz2` compressed archives.
* read/write support for the POSIX.1-1988 (ustar) format.

View File

@ -21,11 +21,13 @@ defined in `PKZIP Application Note
This module does not currently handle ZIP files which have appended comments, or
multi-disk ZIP files. It can handle ZIP files that use the ZIP64 extensions
(that is ZIP files that are more than 4 GByte in size). It supports decryption
of encrypted files in ZIP archives, but it cannot currently create an encrypted
of encrypted files in ZIP archives, but it currently cannot create an encrypted
file.
The available attributes of this module are:
For other archive formats, see the :mod:`bz2`, :mod:`gzip`, and
:mod:`tarfile` modules.
The module defines the following items:
.. exception:: BadZipfile

View File

@ -19,6 +19,10 @@ order. This documentation doesn't attempt to cover all of the permutations;
consult the zlib manual at http://www.zlib.net/manual.html for authoritative
information.
For reading and writing ``.gz`` files see the :mod:`gzip` module. For
other archive formats, see the :mod:`bz2`, :mod:`zipfile`, and
:mod:`tarfile` modules.
The available exception and functions in this module are: