Wed, 13 Jan 2010 19:39:36 +0000
Add support for fetching archives from URLs
42 | 1 | dtrx Installation Documentation |
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 | 7 | dtrx will work out of the box with Python_ 2.4 or greater. You can also |
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 | 13 | dtrx calls out to different external tools to support different archive |
14 | types. Most of these are already installed on most GNU/Linux systems, so | |
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 |
120
0b13df37c884
add missing tools that you might need for .deb packages
Brett Smith <brettcsmith@brettcsmith.org>
parents:
93
diff
changeset
|
31 | ar, tar, zcat, bzcat, lzcat |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
32 | |
42 | 33 | gem archives |
34 | tar, zcat | |
35 | ||
36 | 7z archives | |
37 | 7z | |
38 | ||
39 | Microsoft Cabinet archives | |
40 | cabextract | |
41 | ||
72
c4cfaf634bb9
Add support for InstallShield archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
57
diff
changeset
|
42 | InstallShield archives |
c4cfaf634bb9
Add support for InstallShield archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
57
diff
changeset
|
43 | unshield |
c4cfaf634bb9
Add support for InstallShield archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
57
diff
changeset
|
44 | |
93
6c20788653a8
Prepare for a 6.3 release
Brett Smith <brettcsmith@brettcsmith.org>
parents:
72
diff
changeset
|
45 | rar archives |
6c20788653a8
Prepare for a 6.3 release
Brett Smith <brettcsmith@brettcsmith.org>
parents:
72
diff
changeset
|
46 | unrar |
6c20788653a8
Prepare for a 6.3 release
Brett Smith <brettcsmith@brettcsmith.org>
parents:
72
diff
changeset
|
47 | |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
48 | Files compressed with gzip or compress |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
49 | zcat |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
50 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
51 | Files compressed with bzip2 |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
52 | bzcat |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
53 | |
42 | 54 | Files compressed with lzma |
55 | lzcat | |
56 | ||
123
8570c14304bb
add support for xz compression
Brett Smith <brettcsmith@brettcsmith.org>
parents:
122
diff
changeset
|
57 | Files compressed with xz |
8570c14304bb
add support for xz compression
Brett Smith <brettcsmith@brettcsmith.org>
parents:
122
diff
changeset
|
58 | xzcat |
8570c14304bb
add support for xz compression
Brett Smith <brettcsmith@brettcsmith.org>
parents:
122
diff
changeset
|
59 | |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
60 | Installation |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
61 | ------------ |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
62 | |
42 | 63 | dtrx is just a simple script, making it easy to stash wherever you need it. |
64 | Just copy ``scripts/dtrx`` to a location that's convenient for you. If | |
65 | you'd like to install the program system-wide, you can run the following as | |
66 | root or equivalent:: | |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
67 | |
56 | 68 | python setup.py install --prefix=/usr/local |
69 | ||
70 | Running Tests | |
71 | ------------- | |
72 | ||
73 | dtrx comes with a suite of tests that are designed to ensure it's running | |
74 | properly. If you'd like, you can run these tests on your own system. | |
75 | Simply run the following command from the dtrx source directory:: | |
76 | ||
77 | python tests/compare.py | |
78 | ||
122
2b676283366a
use the PyYAML library for tests, instead of Syck
Brett Smith <brettcsmith@brettcsmith.org>
parents:
120
diff
changeset
|
79 | To run the tests, you'll need the `PyYAML module`_. |
57 | 80 | |
122
2b676283366a
use the PyYAML library for tests, instead of Syck
Brett Smith <brettcsmith@brettcsmith.org>
parents:
120
diff
changeset
|
81 | .. _PyYAML module: http://pyyaml.org/ |
57 | 82 | |
56 | 83 | If everything's in order, all the tests should pass. Note that some of |
84 | them will fail if some of the programs listed above aren't installed on | |
85 | your system. Many of the tests will fail if for some reason you're missing | |
86 | the very common commands, like tar and zcat. |