Sun, 31 May 2009 22:51:00 -0400
Make README more like a man page, so it can be converted into one
112
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
1 | ==== |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
2 | dtrx |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
3 | ==== |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
4 | |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
5 | ---------------------------------- |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
6 | cleanly extract many archive types |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
7 | ---------------------------------- |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
8 | |
112
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
9 | :Author: brettcsmith@brettcsmith.org |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
10 | :Date: 2009-05-05 |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
11 | :Copyright: GNU General Public License, version 3 or later |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
12 | :Version: 6.4 |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
13 | :Manual section: 1 |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
14 | |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
15 | SYNOPSIS |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
16 | ======== |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
17 | |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
18 | dtrx [OPTIONS] ARCHIVE [ARCHIVE ...] |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
19 | |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
20 | DESCRIPTION |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
21 | =========== |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
22 | |
19 | 23 | dtrx extracts archives in a number of different formats; it currently |
93
6c20788653a8
Prepare for a 6.3 release
Brett Smith <brettcsmith@brettcsmith.org>
parents:
89
diff
changeset
|
24 | supports tar, zip, cpio, rpm, deb, gem, 7z, cab, and rar files. It can |
6c20788653a8
Prepare for a 6.3 release
Brett Smith <brettcsmith@brettcsmith.org>
parents:
89
diff
changeset
|
25 | also 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
|
26 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
27 | In addition to providing one command to handle many different archive |
19 | 28 | 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
|
29 | default, everything will be written to a dedicated directory that's named |
19 | 30 | 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
|
31 | owner can read and write all those files. |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
32 | |
19 | 33 | 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
|
34 | arguments. For example:: |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
35 | |
37 | 36 | $ dtrx coreutils-5.*.tar.gz |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
37 | |
112
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
38 | OPTIONS |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
39 | ======= |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
40 | |
19 | 41 | 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
|
42 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
43 | -r, --recursive |
19 | 44 | 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
|
45 | 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
|
46 | well. |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
47 | |
84
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
48 | --one, --one-entry |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
49 | Normally, if an archive only contains one file or directory with a name |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
50 | that doesn't match the archive's, dtrx will ask you how to handle it. |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
51 | With this option, you can specify ahead of time what should happen. |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
52 | Possible values are: |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
53 | |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
54 | inside |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
55 | Extract the file/directory inside another directory named after the |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
56 | archive. This is the default. |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
57 | |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
58 | rename |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
59 | Extract the file/directory in the current directory, and then rename |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
60 | it to match the name of the archive. |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
61 | |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
62 | here |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
63 | Extract the file/directory in the current directory. |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
64 | |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
65 | -o, --overwrite |
19 | 66 | 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
|
67 | and instead try to find an alternative name to use. If this option is |
19 | 68 | 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
|
69 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
70 | -f, --flat |
84
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
71 | Extract all archive contents into the current directory, instead of |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
72 | their own dedicated directory. This is handy if you have multiple |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
73 | archive files which all need to be extracted into the same directory |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
74 | structure. Note that existing files may be overwritten with this |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
75 | option. |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
76 | |
24 | 77 | -n, --noninteractive |
78 | dtrx will normally ask the user how to handle certain corner cases, such | |
79 | as how to handle an archive that only contains one file. This option | |
37 | 80 | suppresses those questions; dtrx will instead use sane, conservative |
81 | defaults. | |
24 | 82 | |
19 | 83 | -l, -t, --list, --table |
84 | Don't extract the archives; just list their contents on standard output. | |
85 | ||
37 | 86 | -m, --metadata |
87 | Extract the metadata from .deb and .gem archives, instead of their normal | |
88 | contents. | |
89 | ||
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
90 | -q, --quiet |
56 | 91 | Suppress warning messages. Listing this option twice will cause dtrx to |
92 | be silent. | |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
93 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
94 | -v, --verbose |
56 | 95 | Show the files that are being extracted. Listing this option twice will |
96 | cause dtrx to print debugging information. | |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
97 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
98 | --help |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
99 | Display basic help. |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
100 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
101 | --version |
44 | 102 | Display dtrx's version, copyright, and license information. |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
103 | |
112
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
104 | COPYRIGHT |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
105 | ========= |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
106 | |
101 | 107 | dtrx 6.4 is copyright ⓒ 2006, 2007, 2008 `Brett Smith`_ and others. Feel |
93
6c20788653a8
Prepare for a 6.3 release
Brett Smith <brettcsmith@brettcsmith.org>
parents:
89
diff
changeset
|
108 | free to send comments, bug reports, patches, and so on. You can find the |
6c20788653a8
Prepare for a 6.3 release
Brett Smith <brettcsmith@brettcsmith.org>
parents:
89
diff
changeset
|
109 | latest version of dtrx on `its home page`_. |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
110 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
111 | .. _`Brett Smith`: mailto:brettcsmith@brettcsmith.org |
42 | 112 | .. _`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
|
113 | |
19 | 114 | 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
|
115 | 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
|
116 | 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
|
117 | version. |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
118 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
119 | 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
|
120 | 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
|
121 | 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
|
122 | more details. |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
123 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
124 | You should have received a copy of the GNU General Public License along |
42 | 125 | with this program; if not, see <http://www.gnu.org/licenses/>. |