INSTALL

Fri, 19 Oct 2007 23:06:53 -0400

author
brett
date
Fri, 19 Oct 2007 23:06:53 -0400
branch
trunk
changeset 30
1015bbd6dc5e
parent 18
1600807a32bd
child 42
4a4cab75d5e6
permissions
-rw-r--r--

[svn] If we can't figure out what the file is by mimetype, try using the file
command to figure out what it is instead.

This completely changes the program structure because now we might try to
use several extractors on a particular file before giving up. I haven't
really done the refactoring that would be appropriate for a change this
fundamental. I'd like to do that before the next release.

18
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
1 x Installation Documentation
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
2 ============================
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
3
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
4 Requirements
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
5 ------------
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
6
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
7 To run x, you'll need Python_ 2.4 or greater. You can also use Python 2.3
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
8 if you separately install the `subprocess module`_.
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
9
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
10 .. _Python: http://www.python.org/
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
11 .. _`subprocess module`: http://www.lysator.liu.se/~astrand/popen5/
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
12
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
13 x calls out to different external tools to support different archive types.
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
14 Most of these are already installed on most GNU/Linux systems, so you
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
15 probably won't have to worry about these too much, but just for
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
16 completeness, the exact requirements for each format are as follows:
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
17
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
18 tar archives
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
19 tar
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
20
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
21 zip archives
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
22 unzip, zipinfo
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
23
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
24 cpio archives
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
25 cpio
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
26
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
27 rpm archives
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
28 rpm2cpio, cpio
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
29
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
30 deb archives
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
31 ar, tar, zcat
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
32
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
33 Files compressed with gzip or compress
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
34 zcat
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
35
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
36 Files compressed with bzip2
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
37 bzcat
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
38
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
39 Installation
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
40 ------------
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
41
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
42 x is just a simple script, making it easy to stash wherever you need it.
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
43 Just copy ``scripts/x`` to a location that's convenient for you. If you'd
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
44 like to install the program system-wide, you can run the following as root
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
45 or equivalent::
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
46
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
47 python setup.py install

mercurial