summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README79
1 files changed, 46 insertions, 33 deletions
diff --git a/README b/README
index 962db19..204bd2f 100644
--- a/README
+++ b/README
@@ -1,12 +1,48 @@
-dtrx - Intelligent archive extraction
-=====================================
-
-Introduction
-------------
+====
+dtrx
+====
+
+----------------------------------
+cleanly extract many archive types
+----------------------------------
+
+:Author: Brett Smith <brettcsmith@brettcsmith.org>
+:Date: 2009-07-04
+:Copyright:
+
+ dtrx 6.5 is copyright © 2006-2009 Brett Smith and others. Feel free to
+ send comments, bug reports, patches, and so on. You can find the latest
+ version of dtrx on its home page at
+ <http://www.brettcsmith.org/2007/dtrx/>.
+
+ dtrx is free software; you can redistribute it and/or modify it under the
+ terms of the GNU General Public License as published by the Free Software
+ Foundation; either version 3 of the License, or (at your option) any
+ later version.
+
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
+ Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, see <http://www.gnu.org/licenses/>.
+
+:Version: 6.5
+:Manual section: 1
+
+SYNOPSIS
+========
+
+dtrx [OPTIONS] ARCHIVE [ARCHIVE ...]
+
+DESCRIPTION
+===========
dtrx extracts archives in a number of different formats; it currently
-supports tar, zip, cpio, rpm, deb, gem, 7z, cab, and rar files. It can
-also decompress files compressed with gzip, bzip2, lzma, or compress.
+supports tar, zip (including self-extracting .exe files), cpio, rpm, deb,
+gem, 7z, cab, rar, and InstallShield files. It can also decompress files
+compressed with gzip, bzip2, lzma, or compress.
In addition to providing one command to handle many different archive
types, dtrx also aids the user by extracting contents consistently. By
@@ -14,14 +50,14 @@ default, everything will be written to a dedicated directory that's named
after the archive. dtrx will also change the permissions to ensure that the
owner can read and write all those files.
-Running dtrx
-------------
-
To run dtrx, simply call it with the archive(s) you wish to extract as
arguments. For example::
$ dtrx coreutils-5.*.tar.gz
+OPTIONS
+=======
+
dtrx supports a number of options to mandate specific behavior:
-r, --recursive
@@ -84,26 +120,3 @@ dtrx supports a number of options to mandate specific behavior:
--version
Display dtrx's version, copyright, and license information.
-
-Other Useful Information
-------------------------
-
-dtrx 6.4 is copyright ⓒ 2006, 2007, 2008 `Brett Smith`_ and others. Feel
-free to send comments, bug reports, patches, and so on. You can find the
-latest version of dtrx on `its home page`_.
-
-.. _`Brett Smith`: mailto:brettcsmith@brettcsmith.org
-.. _`its home page`: http://www.brettcsmith.org/2007/dtrx/
-
-dtrx is free software; you can redistribute it and/or modify it under the
-terms of the GNU General Public License as published by the Free Software
-Foundation; either version 3 of the License, or (at your option) any later
-version.
-
-This program is distributed in the hope that it will be useful, but WITHOUT
-ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
-more details.
-
-You should have received a copy of the GNU General Public License along
-with this program; if not, see <http://www.gnu.org/licenses/>.