Sun, 13 Jul 2008 17:54:47 -0400
Don't assume .exe files are Cabinet archives just by extension.
.exe files are as likely as not to be archives, so I'd rather not bug the
user for recursive extraction every time they're in an archive. So we'll
detect these sorts of archives by their magic only, which prevents them
from triggering recursive extraction attempts.
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 |
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 | 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 | |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
45 | Files compressed with gzip or compress |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
46 | zcat |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
47 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
48 | Files compressed with bzip2 |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
49 | bzcat |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
50 | |
42 | 51 | Files compressed with lzma |
52 | lzcat | |
53 | ||
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
54 | Installation |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
55 | ------------ |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
56 | |
42 | 57 | dtrx is just a simple script, making it easy to stash wherever you need it. |
58 | Just copy ``scripts/dtrx`` to a location that's convenient for you. If | |
59 | you'd like to install the program system-wide, you can run the following as | |
60 | root or equivalent:: | |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
61 | |
56 | 62 | python setup.py install --prefix=/usr/local |
63 | ||
64 | Running Tests | |
65 | ------------- | |
66 | ||
67 | dtrx comes with a suite of tests that are designed to ensure it's running | |
68 | properly. If you'd like, you can run these tests on your own system. | |
69 | Simply run the following command from the dtrx source directory:: | |
70 | ||
71 | python tests/compare.py | |
72 | ||
57 | 73 | To run the tests, you'll need the `syck module`_. |
74 | ||
75 | .. _syck module: http://whytheluckystiff.net/syck/ | |
76 | ||
56 | 77 | If everything's in order, all the tests should pass. Note that some of |
78 | them will fail if some of the programs listed above aren't installed on | |
79 | your system. Many of the tests will fail if for some reason you're missing | |
80 | the very common commands, like tar and zcat. |