INSTALL@dcf005ef7070 (annotated)
INSTALL
Sun, 12 Apr 2009 11:21:51 -0400
- author
- Brett Smith <brettcsmith@brettcsmith.org>
- date
- Sun, 12 Apr 2009 11:21:51 -0400
- branch
- trunk
- changeset 106
- dcf005ef7070
- parent 93
- 6c20788653a8
- child 120
- 0b13df37c884
- permissions
- -rw-r--r--
Start printing results ASAP with -l or -t.
Doing -l on a large archive was painful because dtrx would wait until it
had all the listings before it displayed any. It did this to make sure
that the listing would be successful.
On reconsidering, though, I think it's really unlikely that there'll be a
case where a lister process provides *some* good output for a given file in
the wrong format. So, now -l will try to get one good line out of the
lister. If it gets that, then it will immediately start displaying results
as they come in. On the off chance that it detects an error later on, it
will display an error about that, and then try again with a different
extractor if appropriate.
| 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 | |
|
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 | ||
|
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
57 | Installation |
|
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 | |
| 42 | 60 | dtrx is just a simple script, making it easy to stash wherever you need it. |
| 61 | Just copy ``scripts/dtrx`` to a location that's convenient for you. If | |
| 62 | you'd like to install the program system-wide, you can run the following as | |
| 63 | root or equivalent:: | |
|
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
64 | |
| 56 | 65 | python setup.py install --prefix=/usr/local |
| 66 | ||
| 67 | Running Tests | |
| 68 | ------------- | |
| 69 | ||
| 70 | dtrx comes with a suite of tests that are designed to ensure it's running | |
| 71 | properly. If you'd like, you can run these tests on your own system. | |
| 72 | Simply run the following command from the dtrx source directory:: | |
| 73 | ||
| 74 | python tests/compare.py | |
| 75 | ||
| 57 | 76 | To run the tests, you'll need the `syck module`_. |
| 77 | ||
| 78 | .. _syck module: http://whytheluckystiff.net/syck/ | |
| 79 | ||
| 56 | 80 | If everything's in order, all the tests should pass. Note that some of |
| 81 | them will fail if some of the programs listed above aren't installed on | |
| 82 | your system. Many of the tests will fail if for some reason you're missing | |
| 83 | the very common commands, like tar and zcat. |
