doc/index.rst

   1
   2 rarfile - RAR archive reader for Python
   3 =======================================
   4
   5 This is Python module for RAR_ archive reading.  The interface
   6 is made as zipfile_ like as possible.  Licensed under ISC_
   7 license.
   8
   9 Features:
  10
  11 - Supports both RAR3 and RAR5 format archives.
  12 - Supports multi volume archives.
  13 - Supports Unicode filenames.
  14 - Supports password-protected archives.
  15 - Supports archive and file comments.
  16 - Archive parsing and non-compressed files are handled in pure Python code.
  17 - Compressed files are extracted by executing external tool: either ``unrar``
  18   from RARLAB_ or ``bsdtar`` from libarchive_.
  19 - Works with both Python 2.7 and 3.x.
  20
  21 Documentation:
  22
  23 .. toctree::
  24    :maxdepth: 1
  25
  26    Module Documentation <api>
  27    FAQs <faq>
  28    Release News  <news>
  29
  30
  31 Indices and tables
  32 ==================
  33
  34 * :ref:`genindex`
  35 * :ref:`modindex`
  36 * :ref:`search`
  37
  38 .. _RAR: http://en.wikipedia.org/wiki/RAR
  39 .. _zipfile: http://docs.python.org/library/zipfile.html
  40 .. _ISC: http://en.wikipedia.org/wiki/ISC_license
  41 .. _libarchive: https://github.com/libarchive/libarchive
  42 .. _RARLAB: http://www.rarlab.com/