xref: /tar/
Name Date Size

..29-Nov-20194 KiB

.gitignoreH A D12-Jan-2019262

.gitmodulesH A D13-Aug-2017156

acinclude.m4H A D02-Jan-20192.2 KiB

AUTHORSH A D13-Aug-2017601

bootstrapH A D02-Jan-201930.9 KiB

bootstrap.confH A D02-Jan-20193.3 KiB

ChangeLog.1H A D13-Aug-2017201.8 KiB

ChangeLog.amendH A D13-Aug-20171.4 KiB

ChangeLog.CVSH A D13-Aug-2017324.6 KiB

configure.acH A D27-Nov-201912.4 KiB

COPYINGH A D13-Aug-201734.3 KiB

directoryH A D02-Jan-20192.7 KiB

doc/H28-Mar-20194 KiB

gnulib/H13-Aug-20174 KiB

gnulib.modulesH A D02-Jan-20191.6 KiB

lib/H02-Jan-20194 KiB

Makefile.amH A D02-Jan-20191.2 KiB

NEWSH A D27-Nov-201962.7 KiB

paxutils/H13-Aug-20174 KiB

po/H02-Jan-20194 KiB

READMEH A D02-Jan-20199.5 KiB

README-alphaH A D02-Jan-20192.2 KiB

README-hackingH A D02-Jan-20191.9 KiB

scripts/H28-Mar-20194 KiB

src/H03-Dec-20194 KiB

tests/H25-Nov-201912 KiB

THANKSH A D14-Jan-201920 KiB

TODOH A D02-Jan-20192.1 KiB

README

1README for GNU tar
2See the end of file for copying conditions.
3
4* Introduction
5
6Please glance through *all* sections of this
7'README' file before starting configuration.  Also make sure you read files
8'ABOUT-NLS' and 'INSTALL' if you are not familiar with them already.
9
10If you got the 'tar' distribution in 'shar' format, time stamps ought to be
11properly restored; do not ignore such complaints at 'unshar' time.
12
13GNU 'tar' saves many files together into a single tape or disk
14archive, and can restore individual files from the archive.  It includes
15multivolume support, the ability to archive sparse files, automatic archive
16compression/decompression, remote archives and special features that allow
17'tar' to be used for incremental and full backups.  This distribution
18also includes 'rmt', the remote tape server.  The 'mt' tape drive control
19program is in the GNU 'cpio' distribution.
20
21GNU 'tar' is derived from John Gilmore's public domain 'tar'.
22
23See file 'ABOUT-NLS' for how to customize this program to your language.
24See file 'COPYING' for copying conditions.
25See file 'INSTALL' for compilation and installation instructions.
26See file 'NEWS' for a list of major changes in the current release.
27See file 'THANKS' for a list of contributors.
28
29Besides those configure options documented in files 'INSTALL' and
30'ABOUT-NLS', an extra option may be accepted after './configure':
31
32* Install
33
34** Selecting the default archive format.
35
36The default archive format is GNU, this can be overridden by
37presetting DEFAULT_ARCHIVE_FORMAT while configuring. The allowed
38values are GNU, V7, OLDGNU, USTAR and POSIX.
39
40** Selecting the default archive device
41
42The default archive device is now 'stdin' on read and 'stdout' on write.
43The installer can still override this by presetting 'DEFAULT_ARCHIVE'
44in the environment before configuring (the behavior of '-[0-7]' or
45'-[0-7]lmh' options in 'tar' are then derived automatically).  Similarly,
46'DEFAULT_BLOCKING' can be preset to something else than 20.
47
48** Selecting full pathname of the "rmt" binary.
49
50Previous versions of tar always looked for "rmt" binary in the
51directory "/etc/rmt". However, the "rmt" program included
52in the distribution was installed under "$prefix/libexec/rmt".
53To fix this discrepancy, tar now looks for "$prefix/libexec/rmt".
54If you do not want this behavior, specify full path name of
55"rmt" binary using DEFAULT_RMT_DIR variable, e.g.:
56
57./configure DEFAULT_RMT_DIR=/etc
58
59If you already have a copy of "rmt" installed and wish to use it
60instead of the version supplied with the distribution, use --with-rmt
61option:
62
63./configure --with-rmt=/etc/rmt
64
65This will also disable building the included version of rmt.
66
67** Installing backup scripts.
68
69This version of tar is shipped with the shell scripts for producing
70incremental backups (dumps) and restoring filesystems from them.
71The name of the backup script is "backup". The name of the
72restore script is "restore". They are installed in "$prefix/sbin"
73directory.
74
75Use option --enable-backup-scripts to compile and install these
76scripts.
77
78** '--disable-largefile' omits support for large files, even if the
79operating system supports large files.  Typically, large files are
80those larger than 2 GB on a 32-bit host.
81
82* Installation hints
83
84Here are a few hints which might help installing 'tar' on some systems.
85
86** gzip and bzip2.
87
88GNU tar uses the gzip and bzip2 programs to read and write compressed
89archives.  If you don't have these programs already, you need to
90install them.  Their sources can be found at:
91
92ftp://ftp.gnu.org/gnu/gzip/
93http://sourceware.cygnus.com/bzip2/
94
95If you see the following symptoms:
96
97   $ tar -xzf file.tar.gz
98   gzip: stdin: decompression OK, trailing garbage ignored
99   tar: Child returned status 2
100
101then you have encountered a gzip incompatibility that should be fixed
102in gzip test version 1.3, which as of this writing is available at
103<ftp://alpha.gnu.org/gnu/gzip/>.  You can work around the
104incompatibility by using a shell command like
105 'gzip -d <file.tar.gz | tar -xzf -'.
106
107** Solaris issues.
108
109GNU tar exercises many features that can cause problems with older GCC
110versions.  In particular, GCC 2.8.1 (sparc, -O1 or -O2) is known to
111miscompile GNU tar.  No compiler-related problems have been reported
112when using GCC 2.95.2 or later.
113
114Recent versions of Solaris tar sport a new -E option to generate
115extended headers in an undocumented format.  GNU tar does not
116understand these headers.
117
118** Static linking.
119
120Some platform will, by default, prepare a smaller 'tar' executable
121which depends on shared libraries.  Since GNU 'tar' may be used for
122system-level backups and disaster recovery, installers might prefer to
123force static linking, making a bigger 'tar' executable maybe, but able to
124work standalone, in situations where shared libraries are not available.
125The way to achieve static linking varies between systems.  Set LDFLAGS
126to a value from the table below, before configuration (see 'INSTALL').
127
128	Platform	Compiler	LDFLAGS
129
130	(any)		Gnu C		-static
131	AIX		(vendor)	-bnso -bI:/lib/syscalls.exp
132	HPUX		(vendor)	-Wl,-a,archive
133	IRIX		(vendor)	-non_shared
134	OSF		(vendor)	-non_shared
135	SCO 3.2v5	(vendor)	-dn
136	Solaris		(vendor)	-Bstatic
137	SunOS		(vendor)	-Bstatic
138
139** Failed tests 'ignfail.sh' or 'incremen.sh'.
140
141In an NFS environment, lack of synchronization between machine clocks
142might create difficulties to any tool comparing dates and file time stamps,
143like 'tar' in incremental dumps.  This has been a recurrent problem with
144GNU Make for the last few years.  We would like a general solution.
145
146** BSD compatibility matters.
147
148Set LIBS to '-lbsd' before configuration (see 'INSTALL') if the linker
149complains about 'bsd_ioctl' (Slackware).  Also set CPPFLAGS to
150'-I/usr/include/bsd' if <sgtty.h> is not found (Slackware).
151
152** OPENStep 4.2 swap files
153
154Tar cannot read the file /private/vm/swapfile.front (even as root).
155This file is not a real file, but some kind of uncompressed view of
156the real compressed swap file; there is no reason to back it up, so
157the simplest workaround is to avoid tarring this file.
158
159* Special topics
160
161Here are a few special matters about GNU 'tar', not related to build
162matters.  See previous section for such.
163
164** File attributes.
165
166About *security*, it is probable that future releases of 'tar' will have
167some behavior changed.  There are many pending suggestions to choose from.
168Today, extracting an archive not being 'root', 'tar' will restore suid/sgid
169bits on files but owned by the extracting user.  'root' automatically gets
170a lot of special privileges, '-p' might later become required to get them.
171
172GNU 'tar' does not properly restore symlink attributes.  Various systems
173implement flavors of symbolic links showing different behavior and
174properties.  We did not successfully sorted all these out yet.  Currently,
175the 'lchown' call will be used if available, but that's all.
176
177** POSIX compliance.
178
179GNU 'tar' is able to create archive in the following formats:
180
181  *** The format of UNIX version 7
182  *** POSIX.1-1988 format, also known as "ustar format"
183  *** POSIX.1-2001 format, also known as "pax format"
184  *** Old GNU format (described below)
185
186In addition to those, GNU 'tar' is also able to read archives
187produced by 'star' archiver.
188
189A so called 'Old GNU' format is based on an early draft of the
190POSIX 1003.1 'ustar' standard which is different from the final
191standard. It defines its extensions (such as incremental backups
192and handling of the long file names) in a way incompatible with
193any existing tar archive format, therefore the use of old GNU
194format is strongly discouraged.
195
196Please read the file NEWS for more information about POSIX compliance
197and new 'tar' features.
198
199* What's next?
200
201GNU tar will be merged into GNU paxutils: a project containing
202several utilities related to creating and handling archives in
203various formats. The project will include tar, cpio and pax
204utilities.
205
206* Bug reporting.
207
208Send bug reports to <bug-tar@gnu.org>.  A bug report should contain
209an adequate description of the problem, your input, what you expected,
210what you got, and why this is wrong.  Diffs are welcome, but they only
211describe a solution, from which the problem might be uneasy to infer.
212If needed, submit actual data files with your report.  Small data files
213are preferred.  Big files may sometimes be necessary, but do not send them
214to the report address; rather take special arrangement with the maintainer.
215
216Your feedback will help us to make a better and more portable package.
217Consider documentation errors as bugs, and report them as such.  If you
218develop anything pertaining to 'tar' or have suggestions, let us know
219and share your findings by writing to <bug-tar@gnu.org>.
220
221
222* Copying
223
224Copyright 1990-2019 Free Software Foundation, Inc.
225
226This file is part of GNU tar.
227
228GNU tar is free software; you can redistribute it and/or modify
229it under the terms of the GNU General Public License as published by
230the Free Software Foundation; either version 3 of the License, or
231(at your option) any later version.
232
233GNU tar is distributed in the hope that it will be useful,
234but WITHOUT ANY WARRANTY; without even the implied warranty of
235MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
236GNU General Public License for more details.
237
238You should have received a copy of the GNU General Public License
239along with this program.  If not, see <http://www.gnu.org/licenses/>.
240
241NOTE ON COPYRIGHT YEARS
242
243In copyright notices where the copyright holder is the Free Software
244Foundation, then where a range of years appears, this is an inclusive
245range that applies to every year in the range.  For example: 2005-2008
246represents the years 2005, 2006, 2007, and 2008.
247
248Local Variables:
249mode: outline
250paragraph-separate: "[	]*$"
251version-control: never
252End:
253

README-alpha

1This is GNU tar.
2
3This is a *pre-release* version, and not ready for production use yet.
4Please send comments and problem reports to <bug-tar@gnu.org>.
5
6If you have taken the sources from CVS you will need the following
7packages (or later) to build GNU tar.  We don't make any extra effort
8to accommodate older versions of these packages, so please make sure
9that you have the latest stable version.
10
11- Automake <http://www.gnu.org/software/automake/>
12- Autoconf <http://www.gnu.org/software/autoconf/>
13- Bison <http://www.gnu.org/software/bison/>
14- Gettext <http://www.gnu.org/software/gettext/>
15- Gzip <http://www.gnu.org/software/gzip/>
16- M4 <http://www.gnu.org/software/m4/>
17- Texinfo <http://www.gnu.org/software/texinfo>
18- Wget <http://www.gnu.org/software/wget/>
19
20As of this writing, the latest stable version of Gzip is 1.2.4 but we
21suggest using test version 1.3.5 (or later, if one becomes available).
22
23Valgrind <http://valgrind.org/> is also highly recommended, if
24Valgrind supports your architecture.
25
26Before building the package, run "bootstrap".  It will obtain gnulib
27and paxutils files from their Git repositories on Savannah.  Then, it will
28fetch the po files from tar page at Translation Project, and, finally, it
29will start autoconfiguration process.  Simply running bootstrap without
30arguments should do in most cases.
31
32Bootstrap reads its configuration from file bootstrap.conf located on the
33top of tar source tree.  Several options are provided that modify its
34behavior.  Run 'bootstrap --help' for a list.
35
36
37
38Copyright 2001-2019 Free Software Foundation, Inc.
39
40This file is part of GNU tar.
41
42GNU tar is free software; you can redistribute it and/or modify
43it under the terms of the GNU General Public License as published by
44the Free Software Foundation; either version 3 of the License, or
45(at your option) any later version.
46
47GNU tar is distributed in the hope that it will be useful,
48but WITHOUT ANY WARRANTY; without even the implied warranty of
49MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
50GNU General Public License for more details.
51
52You should have received a copy of the GNU General Public License
53along with this program.  If not, see <http://www.gnu.org/licenses/>.
54

README-hacking

1These notes intend to help people working on the Git version of
2this package.
3
4* Requirements
5
6You need the following packages to build the Git version of GNU
7tar.  We do not make any efforts to accommodate older versions of
8these packages, so please make sure that you have the latest stable
9version.
10
11- Automake <http://www.gnu.org/software/automake/>
12- Autoconf <http://www.gnu.org/software/autoconf/>
13- M4 <http://www.gnu.org/software/m4/>
14- Texinfo <http://www.gnu.org/software/texinfo>
15- Git <http://git.or.cz>
16
17* Bootstrapping
18
19Obviously, if you are reading these notes, you did manage to clone
20tar from Git. The next step is to get other files needed to build,
21which are extracted from other source packages:
22
231. Change to the source tree directory
24
25   cd tar
26
272. Run
28
29   ./bootstrap
30
31Once done, proceed as described in the file README (section
32INSTALLATION).
33
34Normally you will have to run bootstrap only once. However, if you
35intend to hack on GNU tar, you might need to run it again later.
36There are lots of options that you may find useful in this case.
37See 'bootstrap --help' for a detailed list.
38
39
40* Copyright information
41
42Copyright 2007-2019 Free Software Foundation, Inc.
43
44This file is part of GNU tar.
45
46GNU tar is free software; you can redistribute it and/or modify
47it under the terms of the GNU General Public License as published by
48the Free Software Foundation; either version 3 of the License, or
49(at your option) any later version.
50
51GNU tar is distributed in the hope that it will be useful,
52but WITHOUT ANY WARRANTY; without even the implied warranty of
53MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
54GNU General Public License for more details.
55
56You should have received a copy of the GNU General Public License
57along with this program.  If not, see <http://www.gnu.org/licenses/>.
58
59^L
60Local Variables:
61mode: outline
62paragraph-separate: "[	^L]*$"
63version-control: never
64End:
65