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