| 1 | dtrx Installation Documentation |
| 2 | =============================== |
| 3 | |
| 4 | Requirements |
| 5 | ------------ |
| 6 | |
| 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`_. |
| 9 | |
| 10 | .. _Python: http://www.python.org/ |
| 11 | .. _`subprocess module`: http://www.lysator.liu.se/~astrand/popen5/ |
| 12 | |
| 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 |
| 16 | completeness, the exact requirements for each format are as follows: |
| 17 | |
| 18 | tar archives |
| 19 | tar |
| 20 | |
| 21 | zip archives |
| 22 | unzip, zipinfo |
| 23 | |
| 24 | cpio archives |
| 25 | cpio |
| 26 | |
| 27 | rpm archives |
| 28 | rpm2cpio, cpio |
| 29 | |
| 30 | deb archives |
| 31 | ar, tar, zcat, bzcat, lzcat |
| 32 | |
| 33 | gem archives |
| 34 | tar, zcat |
| 35 | |
| 36 | 7z archives |
| 37 | 7z |
| 38 | |
| 39 | Microsoft Cabinet archives |
| 40 | cabextract |
| 41 | |
| 42 | InstallShield archives |
| 43 | unshield |
| 44 | |
| 45 | rar archives |
| 46 | unrar |
| 47 | |
| 48 | Files compressed with gzip or compress |
| 49 | zcat |
| 50 | |
| 51 | Files compressed with bzip2 |
| 52 | bzcat |
| 53 | |
| 54 | Files compressed with lzma |
| 55 | lzcat |
| 56 | |
| 57 | Files compressed with xz |
| 58 | xzcat |
| 59 | |
| 60 | Installation |
| 61 | ------------ |
| 62 | |
| 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:: |
| 67 | |
| 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 | |
| 79 | To run the tests, you'll need the `PyYAML module`_. |
| 80 | |
| 81 | .. _PyYAML module: http://pyyaml.org/ |
| 82 | |
| 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. |