tar: quote 'like this', not `like this'

[chaz/tar] / tests / star / README

diff --git a/tests/star/README b/tests/star/README
index 552ddd6e93b0e4de62af63ed024f1b5b0108ed3d..21faf99f5b272a4912a2b47481945a403d0ca6fb 100644 (file)
--- a/tests/star/README
+++ b/tests/star/README
@@ -1,15 +1,23 @@
 This directory contains scripts for testing GNU tar using
-star "test archives". The archives themselves may be obtained
-from http://download.berlios.de/pub/star/testscripts.
+star "test archives". The archives themselves can be obtained
+from ftp://ftp.berlios.de/pub/star/testscripts.
 
-The tests are ignored unless environment variable STAR_TESTSCRIPTS
-is set and points to the directory where the test archives reside.
-Sample usage:
+These tests are disabled by default. There are two ways to run
+them.  The simplest is by 'make check-full' command.  It requires wget
+and GNU md5sum to be installed. If you don't have these utilities,
+download the test archives manually and set the environment variable
+STAR_TESTSCRIPTS to point to the directory where they reside, for
+example:
 
        make STAR_TESTSCRIPTS=testdir check
-or     
+or
        make TESTS_ENVIRONMENT='STAR_TESTSCRIPTS=testdir' check
 
+The file 'quicktest.sh' is a separate test. It is never executed
+within 'make check' command, you will need to run it manually.
+Please, carefully read section 'quicktest.sh' below before running
+it.
+
 Following is a short description of the tests:
 
 * gtarfail.at and gtarfail2.at
@@ -22,7 +30,7 @@ by previous versions of GNU tar.
 
 Requires gnu-multi-fail-volume1.gtar and gnu-multi-fail-volume2.gtar.
 These are two parts of a multi-volume archive that previous versions
-of tar refused to read (at least, without -B option). 
+of tar refused to read (at least, without -B option).
 
 * ustar-big-2g.at
 
@@ -40,6 +48,22 @@ format.
 Requires pax-big-10g.tar.bz2. It tests handling pax (POSIX.1-2001) archves
 containing very large files (in this case -- 10 GB).
 
+* quicktest.sh
+
+This is a test for compliance to POSIX.1-1990 tar specification. It
+requires two files: ustar-all-quicktest.tar and quicktest.filelist,
+(they usually reside in star/testscripts directory), and 'tartest' program
+(also part of star distribution). The test must be run only with root
+privileges, so it is a good idea to verify the contents of
+ustar-all-quicktest.tar before running it.
+
+If 'tartest' is not in your PATH, use TARTEST variable to specify its
+full file name. You may pass both STAR_TESTSCRIPTS and TARTEST
+variables as command line arguments to quicktest.sh, as shown in
+the example below:
+
+  ./quicktest.sh STAR_TESTSCRIPTS=testdir TARTEST=/path/to/tartest
+
 \f
 Local variables:
 mode: outline