Wed, 13 Jan 2010 19:39:36 +0000
Add support for fetching archives from URLs
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 | |
113
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
9 | :Author: Brett Smith <brettcsmith@brettcsmith.org> |
121 | 10 | :Date: 2009-07-04 |
113
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
11 | :Copyright: |
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
12 | |
124 | 13 | dtrx 6.6 is copyright © 2006-2009 Brett Smith and others. Feel free to |
121 | 14 | send comments, bug reports, patches, and so on. You can find the latest |
15 | version of dtrx on its home page at | |
113
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
16 | <http://www.brettcsmith.org/2007/dtrx/>. |
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
17 | |
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
18 | dtrx is free software; you can redistribute it and/or modify it under the |
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
19 | terms of the GNU General Public License as published by the Free Software |
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
20 | Foundation; either version 3 of the License, or (at your option) any |
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
21 | later version. |
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
22 | |
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
23 | This program is distributed in the hope that it will be useful, but |
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
24 | WITHOUT ANY WARRANTY; without even the implied warranty of |
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
25 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General |
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
26 | Public License for more details. |
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
27 | |
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
28 | You should have received a copy of the GNU General Public License along |
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
29 | with this program; if not, see <http://www.gnu.org/licenses/>. |
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
30 | |
124 | 31 | :Version: 6.6 |
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
|
32 | :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
|
33 | |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
34 | 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
|
35 | ======== |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
36 | |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
37 | 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
|
38 | |
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 | 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
|
40 | =========== |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
41 | |
19 | 42 | dtrx extracts archives in a number of different formats; it currently |
113
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
43 | supports tar, zip (including self-extracting .exe files), cpio, rpm, deb, |
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
44 | gem, 7z, cab, rar, and InstallShield files. It can also decompress files |
1c754ecdcef3
more reformatting for better manpageification
Brett Smith <brettcsmith@brettcsmith.org>
parents:
112
diff
changeset
|
45 | compressed with gzip, bzip2, lzma, or compress. |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
46 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
47 | In addition to providing one command to handle many different archive |
19 | 48 | 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
|
49 | default, everything will be written to a dedicated directory that's named |
19 | 50 | 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
|
51 | owner can read and write all those files. |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
52 | |
19 | 53 | 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
|
54 | arguments. For example:: |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
55 | |
37 | 56 | $ dtrx coreutils-5.*.tar.gz |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
57 | |
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
|
58 | 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
|
59 | ======= |
a849ad478a02
Make README more like a man page, so it can be converted into one
Brett Smith <brettcsmith@brettcsmith.org>
parents:
101
diff
changeset
|
60 | |
19 | 61 | 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
|
62 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
63 | -r, --recursive |
19 | 64 | 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
|
65 | 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
|
66 | well. |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
67 | |
84
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
68 | --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
|
69 | 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
|
70 | 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
|
71 | 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
|
72 | 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
|
73 | |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
74 | inside |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
75 | 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
|
76 | 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
|
77 | |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
78 | rename |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
79 | 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
|
80 | 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
|
81 | |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
82 | here |
d78d63cb4c4e
Add --one-entry option to specify default handling for one-entry archives.
Brett Smith <brettcsmith@brettcsmith.org>
parents:
74
diff
changeset
|
83 | 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
|
84 | |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
85 | -o, --overwrite |
19 | 86 | 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
|
87 | and instead try to find an alternative name to use. If this option is |
19 | 88 | 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
|
89 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
90 | -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
|
91 | 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
|
92 | 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
|
93 | 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
|
94 | 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
|
95 | option. |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
96 | |
24 | 97 | -n, --noninteractive |
98 | dtrx will normally ask the user how to handle certain corner cases, such | |
99 | as how to handle an archive that only contains one file. This option | |
37 | 100 | suppresses those questions; dtrx will instead use sane, conservative |
101 | defaults. | |
24 | 102 | |
19 | 103 | -l, -t, --list, --table |
104 | Don't extract the archives; just list their contents on standard output. | |
105 | ||
37 | 106 | -m, --metadata |
107 | Extract the metadata from .deb and .gem archives, instead of their normal | |
108 | contents. | |
109 | ||
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
110 | -q, --quiet |
56 | 111 | Suppress warning messages. Listing this option twice will cause dtrx to |
112 | be silent. | |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
113 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
114 | -v, --verbose |
56 | 115 | Show the files that are being extracted. Listing this option twice will |
116 | cause dtrx to print debugging information. | |
18
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
117 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
118 | --help |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
119 | Display basic help. |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
120 | |
1600807a32bd
[svn] Add basic documentation, and make this version 3.0.
brett
parents:
diff
changeset
|
121 | --version |
44 | 122 | Display dtrx's version, copyright, and license information. |