INSTALL

Mon, 26 Nov 2007 22:39:29 -0500

author
brett
date
Mon, 26 Nov 2007 22:39:29 -0500
branch
trunk
changeset 42
4a4cab75d5e6
parent 18
1600807a32bd
child 56
d061b94889aa
permissions
-rw-r--r--

[svn] Update documentation.

42
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
1 dtrx Installation Documentation
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
2 ===============================
18
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
42
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
7 dtrx will work out of the box with Python_ 2.4 or greater. You can also
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
8 use Python 2.3 if you separately install the `subprocess module`_.
18
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
42
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
13 dtrx calls out to different external tools to support different archive
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
14 types. Most of these are already installed on most GNU/Linux systems, so
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
15 you probably won't have to worry about these too much, but just for
18
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
42
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
33 gem archives
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
34 tar, zcat
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
35
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
36 7z archives
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
37 7z
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
38
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
39 Microsoft Cabinet archives
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
40 cabextract
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
41
18
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
42 Files compressed with gzip or compress
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
43 zcat
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
44
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
45 Files compressed with bzip2
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
46 bzcat
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
47
42
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
48 Files compressed with lzma
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
49 lzcat
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
50
18
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
51 Installation
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
52 ------------
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
53
42
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
54 dtrx is just a simple script, making it easy to stash wherever you need it.
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
55 Just copy ``scripts/dtrx`` to a location that's convenient for you. If
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
56 you'd like to install the program system-wide, you can run the following as
4a4cab75d5e6 [svn] Update documentation.
brett
parents: 18
diff changeset
57 root or equivalent::
18
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
58
1600807a32bd [svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff changeset
59 python setup.py install

mercurial