Thu, 17 Jan 2008 22:44:46 -0500
[svn] Make dtrx -v print *something*.
paulv wants it to act like tar -v. I'm not yet convinced this is a good
idea because it makes less sense with dtrx moving things around on you. It
could do an ls for you, of course, but... why? But it definitely is weird
to have it be silent.
19 | 1 | dtrx - Intelligent archive extraction |
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 | Introduction |
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 | |
19 | 7 | dtrx extracts archives in a number of different formats; it currently |
37 | 8 | supports tar, zip, cpio, rpm, deb, gem, 7z, and cab files. It can also |
9 | decompress files compressed with gzip, bzip2, lzma, or compress. | |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
10 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
11 | In addition to providing one command to handle many different archive |
19 | 12 | types, dtrx also aids the user by extracting contents consistently. By |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
13 | default, everything will be written to a dedicated directory that's named |
19 | 14 | after the archive. dtrx will also change the permissions to ensure that the |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
15 | owner can read and write all those files. |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
16 | |
19 | 17 | Running dtrx |
18 | ------------ | |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
19 | |
19 | 20 | To run dtrx, simply call it with the archive(s) you wish to extract as |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
21 | arguments. For example:: |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
22 | |
37 | 23 | $ dtrx coreutils-5.*.tar.gz |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
24 | |
19 | 25 | dtrx supports a number of options to mandate specific behavior: |
18
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 | -r, --recursive |
19 | 28 | With this option, dtrx will search inside the archives you specify to see |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
29 | if any of the contents are themselves archives, and extract those as |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
30 | well. |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
31 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
32 | -o, --overwrite |
19 | 33 | Normally, dtrx will avoid extracting into a directory that already exists, |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
34 | and instead try to find an alternative name to use. If this option is |
19 | 35 | listed, dtrx will use the default directory name no matter what. |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
36 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
37 | -f, --flat |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
38 | Extract archive contents into the current directory, instead of their |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
39 | own dedicated directory. This is handy if you have multiple archive |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
40 | files which all need to be extracted into the same directory structure. |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
41 | Note that existing files may be overwritten with this option. |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
42 | |
24 | 43 | -n, --noninteractive |
44 | dtrx will normally ask the user how to handle certain corner cases, such | |
45 | as how to handle an archive that only contains one file. This option | |
37 | 46 | suppresses those questions; dtrx will instead use sane, conservative |
47 | defaults. | |
24 | 48 | |
19 | 49 | -l, -t, --list, --table |
50 | Don't extract the archives; just list their contents on standard output. | |
51 | ||
37 | 52 | -m, --metadata |
53 | Extract the metadata from .deb and .gem archives, instead of their normal | |
54 | contents. | |
55 | ||
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
56 | -q, --quiet |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
57 | Suppress warning messages. Listing this option twice will cause the |
19 | 58 | dtrx to be silent if at all possible. |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
59 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
60 | -v, --verbose |
44 | 61 | Print more information about dtrx's behavior. You can list this option |
62 | up to three times for more information. | |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
63 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
64 | --help |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
65 | Display basic help. |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
66 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
67 | --version |
44 | 68 | Display dtrx's version, copyright, and license information. |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
69 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
70 | Other Useful Information |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
71 | ------------------------ |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
72 | |
45
37d555407334
[svn] At work I was getting an unhelpful "No such file or directory" error when I
brett
parents:
44
diff
changeset
|
73 | dtrx 6.0 is copyright (c) 2006, 2007, 2008 `Brett Smith`_. Feel free to |
37d555407334
[svn] At work I was getting an unhelpful "No such file or directory" error when I
brett
parents:
44
diff
changeset
|
74 | send comments, bug reports, patches, and so on. You can find the latest |
37d555407334
[svn] At work I was getting an unhelpful "No such file or directory" error when I
brett
parents:
44
diff
changeset
|
75 | version of dtrx on `its home page`_. |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
76 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
77 | .. _`Brett Smith`: mailto:brettcsmith@brettcsmith.org |
42 | 78 | .. _`its home page`: http://www.brettcsmith.org/2007/dtrx/ |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
79 | |
19 | 80 | dtrx is free software; you can redistribute it and/or modify it under the |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
81 | terms of the GNU General Public License as published by the Free Software |
28
4d88f2231d33
[svn] Change all the license notices from GPLv2 to GPLv3.
brett
parents:
24
diff
changeset
|
82 | Foundation; either version 3 of the License, or (at your option) any later |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
83 | version. |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
84 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
85 | This program is distributed in the hope that it will be useful, but WITHOUT |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
86 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
87 | FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
88 | more details. |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
89 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
90 | You should have received a copy of the GNU General Public License along |
42 | 91 | with this program; if not, see <http://www.gnu.org/licenses/>. |