Dogcows Code - chaz/tar/blob - tests/star/README

   1 This directory contains scripts for testing GNU tar using
   2 star "test archives". The archives themselves can be obtained
   3 from ftp://ftp.berlios.de/pub/star/testscripts.
   4
   5 These tests are disabled by default. There are two ways to run
   6 them.  The simplest is by 'make check-full' command.  It requires wget
   7 and GNU md5sum to be installed. If you don't have these utilities,
   8 download the test archives manually and set the environment variable
   9 STAR_TESTSCRIPTS to point to the directory where they reside, for
  10 example:
  11
  12         make STAR_TESTSCRIPTS=testdir check
  13 or
  14         make TESTS_ENVIRONMENT='STAR_TESTSCRIPTS=testdir' check
  15
  16 The file 'quicktest.sh' is a separate test. It is never executed
  17 within 'make check' command, you will need to run it manually.
  18 Please, carefully read section 'quicktest.sh' below before running
  19 it.
  20
  21 Following is a short description of the tests:
  22
  23 * gtarfail.at and gtarfail2.at
  24
  25 These tests require gtarfile.tar and gtarfile2.tar, respectively.
  26 These files are POSIX compliant tar archives that were not accepted
  27 by previous versions of GNU tar.
  28
  29 * multi-fail.at
  30
  31 Requires gnu-multi-fail-volume1.gtar and gnu-multi-fail-volume2.gtar.
  32 These are two parts of a multi-volume archive that previous versions
  33 of tar refused to read (at least, without -B option).
  34
  35 * ustar-big-2g.at
  36
  37 Requires ustar-big-2g.tar.bz2. It is a tar archive containing a file with
  38 the largest size that a historic tar implementation is able to understand.
  39
  40 * ustar-big-8g.at
  41
  42 Requires ustar-big-8g.tar.bz2. This is a test for reading an archive containing
  43 files with the largest size that may be used with ustar (POSIX.1-1990)
  44 format.
  45
  46 * pax-big-10g.at
  47
  48 Requires pax-big-10g.tar.bz2. It tests handling pax (POSIX.1-2001) archves
  49 containing very large files (in this case -- 10 GB).
  50
  51 * quicktest.sh
  52
  53 This is a test for compliance to POSIX.1-1990 tar specification. It
  54 requires two files: ustar-all-quicktest.tar and quicktest.filelist,
  55 (they usually reside in star/testscripts directory), and 'tartest' program
  56 (also part of star distribution). The test must be run only with root
  57 privileges, so it is a good idea to verify the contents of
  58 ustar-all-quicktest.tar before running it.
  59
  60 If 'tartest' is not in your PATH, use TARTEST variable to specify its
  61 full file name. You may pass both STAR_TESTSCRIPTS and TARTEST
  62 variables as command line arguments to quicktest.sh, as shown in
  63 the example below:
  64
  65   ./quicktest.sh STAR_TESTSCRIPTS=testdir TARTEST=/path/to/tartest
  66
  67 \f
  68 * Copying
  69
  70 Copyright 2004, 2006-2008, 2010, 2012-2014 Free Software Foundation,
  71 Inc.
  72
  73 This file is part of GNU tar.
  74
  75 GNU tar is free software; you can redistribute it and/or modify
  76 it under the terms of the GNU General Public License as published by
  77 the Free Software Foundation; either version 3 of the License, or
  78 (at your option) any later version.
  79
  80 GNU tar is distributed in the hope that it will be useful,
  81 but WITHOUT ANY WARRANTY; without even the implied warranty of
  82 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  83 GNU General Public License for more details.
  84
  85 You should have received a copy of the GNU General Public License
  86 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  87 \f
  88 Local variables:
  89 mode: outline
  90 paragraph-separate: "[  \f]*$"
  91 end: