changeset
Make README more like a man page, so it can be converted into one
Sun, 31 May 2009 22:51:00 -0400
- author
- Brett Smith <brettcsmith@brettcsmith.org>
- date
- Sun, 31 May 2009 22:51:00 -0400
- branch
- trunk
- changeset 112
- a849ad478a02
- parent 111
- 09be2149c500
- child 113
- 1c754ecdcef3
Make README more like a man page, so it can be converted into one
| README | file | annotate | diff | comparison | revisions |
--- a/README Tue May 05 21:04:52 2009 -0400 +++ b/README Sun May 31 22:51:00 2009 -0400 @@ -1,8 +1,24 @@ -dtrx - Intelligent archive extraction -===================================== +==== +dtrx +==== + +---------------------------------- +cleanly extract many archive types +---------------------------------- -Introduction ------------- +:Author: brettcsmith@brettcsmith.org +:Date: 2009-05-05 +:Copyright: GNU General Public License, version 3 or later +:Version: 6.4 +: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 @@ -14,14 +30,14 @@ 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 @@ -85,8 +101,8 @@ --version Display dtrx's version, copyright, and license information. -Other Useful Information ------------------------- +COPYRIGHT +========= 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
