INSTALL

Fri, 19 Oct 2007 22:46:20 -0400

author
brett
date
Fri, 19 Oct 2007 22:46:20 -0400
branch
trunk
changeset 28
4d88f2231d33
parent 18
1600807a32bd
child 42
4a4cab75d5e6
permissions
-rw-r--r--

[svn] Change all the license notices from GPLv2 to GPLv3.

Instead of checking the archive contents, figuring out what to do, and
doing it, instead we now always extract the archive to a private directory,
and then shuffle around the contents appropriately. I expected this to be
a bigger win than my benchmarks have borne out, but I'm sticking with this
strategy because it provides a cleaner separation of responsibilities
between the extractors and the archive type handlers, and also I have to
believe it's a much better way to handle bigger archives -- since we're now
reading it once and not twice.

x Installation Documentation
============================

Requirements
------------

To run x, you'll need Python_ 2.4 or greater.  You can also use Python 2.3
if you separately install the `subprocess module`_.

.. _Python: http://www.python.org/
.. _`subprocess module`: http://www.lysator.liu.se/~astrand/popen5/

x calls out to different external tools to support different archive types.
Most of these are already installed on most GNU/Linux systems, so you
probably won't have to worry about these too much, but just for
completeness, the exact requirements for each format are as follows:

tar archives
  tar

zip archives
  unzip, zipinfo

cpio archives
  cpio

rpm archives
  rpm2cpio, cpio

deb archives
  ar, tar, zcat

Files compressed with gzip or compress
  zcat

Files compressed with bzip2
  bzcat

Installation
------------

x is just a simple script, making it easy to stash wherever you need it.
Just copy ``scripts/x`` to a location that's convenient for you.  If you'd
like to install the program system-wide, you can run the following as root
or equivalent::

   python setup.py install

mercurial