[svn] Update documentation. trunk

Mon, 26 Nov 2007 22:39:29 -0500

author
brett
date
Mon, 26 Nov 2007 22:39:29 -0500
branch
trunk
changeset 42
4a4cab75d5e6
parent 41
e3675644bbb6
child 43
4591a32eedc8

[svn] Update documentation.

INSTALL file | annotate | diff | comparison | revisions
README file | annotate | diff | comparison | revisions
scripts/dtrx file | annotate | diff | comparison | revisions
setup.py file | annotate | diff | comparison | revisions
tests/compare.py file | annotate | diff | comparison | revisions
--- a/INSTALL	Mon Nov 26 22:31:25 2007 -0500
+++ b/INSTALL	Mon Nov 26 22:39:29 2007 -0500
@@ -1,18 +1,18 @@
-x Installation Documentation
-============================
+dtrx Installation Documentation
+===============================
 
 Requirements
 ------------
 
-To run x, you'll need Python_ 2.4 or greater.  You can also use Python 2.3
-if you separately install the `subprocess module`_.
+dtrx will work out of the box with Python_ 2.4 or greater.  You can also
+use Python 2.3 if you separately install the `subprocess module`_.
 
 .. _Python: http://www.python.org/
 .. _`subprocess module`: http://www.lysator.liu.se/~astrand/popen5/
 
-x calls out to different external tools to support different archive types.
-Most of these are already installed on most GNU/Linux systems, so you
-probably won't have to worry about these too much, but just for
+dtrx calls out to different external tools to support different archive
+types.  Most of these are already installed on most GNU/Linux systems, so
+you probably won't have to worry about these too much, but just for
 completeness, the exact requirements for each format are as follows:
 
 tar archives
@@ -30,18 +30,30 @@
 deb archives
   ar, tar, zcat
 
+gem archives
+  tar, zcat
+
+7z archives
+  7z
+
+Microsoft Cabinet archives
+  cabextract
+
 Files compressed with gzip or compress
   zcat
 
 Files compressed with bzip2
   bzcat
 
+Files compressed with lzma
+  lzcat
+
 Installation
 ------------
 
-x is just a simple script, making it easy to stash wherever you need it.
-Just copy ``scripts/x`` to a location that's convenient for you.  If you'd
-like to install the program system-wide, you can run the following as root
-or equivalent::
+dtrx is just a simple script, making it easy to stash wherever you need it.
+Just copy ``scripts/dtrx`` to a location that's convenient for you.  If
+you'd like to install the program system-wide, you can run the following as
+root or equivalent::
 
    python setup.py install
--- a/README	Mon Nov 26 22:31:25 2007 -0500
+++ b/README	Mon Nov 26 22:39:29 2007 -0500
@@ -14,24 +14,6 @@
 after the archive.  dtrx will also change the permissions to ensure that the
 owner can read and write all those files.
 
-Requirements
-------------
-
-If you have Python 2.4, this should work out of the box.  If you're stuck
-on Python 2.3, you can use this if you install the `subprocess module`_.
-You'll need the usual tools for the archive types you want to extract: for
-example, if you're extracting zip files, you'll need zipinfo and unzip.
-
-.. _`subprocess module`: http://www.lysator.liu.se/~astrand/popen5/
-
-Installation
-------------
-
-You can just put scripts/dtrx wherever is convenient for you, but if you
-want to install the program system-wide, you can also run::
-
-   # python setup.py install
-
 Running dtrx
 ------------
 
@@ -93,7 +75,7 @@
 of dtrx on `its home page`_.
 
 .. _`Brett Smith`: mailto:brettcsmith@brettcsmith.org
-.. _`its home page`: http://www.brettcsmith.org/2006/x/
+.. _`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
@@ -106,5 +88,4 @@
 more details.
 
 You should have received a copy of the GNU General Public License along
-with this program; if not, write to the Free Software Foundation, Inc., 51
-Franklin Street, 5th Floor, Boston, MA, 02111.
+with this program; if not, see <http://www.gnu.org/licenses/>.
--- a/scripts/dtrx	Mon Nov 26 22:31:25 2007 -0500
+++ b/scripts/dtrx	Mon Nov 26 22:39:29 2007 -0500
@@ -14,8 +14,7 @@
 # Public License for more details.
 #
 # You should have received a copy of the GNU General Public License along
-# with this program; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, 5th Floor, Boston, MA, 02111.
+# with this program; if not, see <http://www.gnu.org/licenses/>.
 
 import errno
 import logging
--- a/setup.py	Mon Nov 26 22:31:25 2007 -0500
+++ b/setup.py	Mon Nov 26 22:39:29 2007 -0500
@@ -7,7 +7,7 @@
       description = "Script to intelligently extract multiple archive types",
       author = "Brett Smith",
       author_email = "brettcsmith@brettcsmith.org",
-      url = "http://www.brettcsmith.org/2007/dtrx",
+      url = "http://www.brettcsmith.org/2007/dtrx/",
       scripts = ['scripts/dtrx'],
       license = "GNU General Public License, version 3 or later"
      )
--- a/tests/compare.py	Mon Nov 26 22:31:25 2007 -0500
+++ b/tests/compare.py	Mon Nov 26 22:39:29 2007 -0500
@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# compare.py -- High-level tests for x.
+# compare.py -- High-level tests for dtrx.
 # Copyright (c) 2006, 2007 Brett Smith <brettcsmith@brettcsmith.org>.
 #
 # This program is free software; you can redistribute it and/or modify it
@@ -14,8 +14,7 @@
 # Public License for more details.
 #
 # You should have received a copy of the GNU General Public License along
-# with this program; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, 5th Floor, Boston, MA, 02111.
+# with this program; if not, see <http://www.gnu.org/licenses/>.
 
 import os
 import re

mercurial