X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=doc%2Ftar.texi;h=7da3fac87ae4e6eea103b3b4cad8d5178c38f802;hb=bbf7dec45e3390840ee02fe401aee5a121ea3d88;hp=ac5f7175bce4ab3dbf58e73e049407d63b0c44d7;hpb=4d753fced1ed3e2b6edf322c8ae7c3e8b48c948d;p=chaz%2Ftar diff --git a/doc/tar.texi b/doc/tar.texi index ac5f717..7da3fac 100644 --- a/doc/tar.texi +++ b/doc/tar.texi @@ -13,14 +13,14 @@ @c Maintenance notes: @c 1. Pay attention to @FIXME{}s and @UNREVISED{}s @c 2. Before creating final variant: -@c 1.1. Run `make check-options' to make sure all options are properly +@c 2.1. Run `make check-options' to make sure all options are properly @c documented; -@c 2.1. Run `make master-menu' (see comment before the master menu). +@c 2.2. Run `make master-menu' (see comment before the master menu). @include rendition.texi @include value.texi -@defcodeindex op +@defcodeindex op @c Put everything in one index (arbitrarily chosen to be the concept index). @syncodeindex fn cp @@ -35,7 +35,7 @@ This manual is for @acronym{GNU} @command{tar} (version from archives. Copyright @copyright{} 1992, 1994, 1995, 1996, 1997, 1999, 2000, 2001, -2003, 2004, 2005, 2006 Free Software Foundation, Inc. +2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -526,7 +526,7 @@ pipes). @command{tar} may even access remote devices or files (as archives). You can use @command{tar} archives in many ways. We want to stress a few of them: storage, backup, and transportation. -@FIXME{the following table entries need a bit of work..} +@FIXME{the following table entries need a bit of work.} @table @asis @item Storage Often, @command{tar} archives are used to store related files for @@ -796,7 +796,7 @@ Similarly, the term ``command'' can be confusing, as it is often used in two different ways. People sometimes refer to @command{tar} ``commands''. A @command{tar} @dfn{command} is the entire command line of user input which tells @command{tar} what to do --- including the operation, options, -and any arguments (file names, pipes, other commands, etc). However, +and any arguments (file names, pipes, other commands, etc.). However, you will also sometimes hear the term ``the @command{tar} command''. When the word ``command'' is used specifically like this, a person is usually referring to the @command{tar} @emph{operation}, not the whole line. @@ -898,7 +898,7 @@ clear, and we will give many examples both using and not using @option{--verbose} to show the differences. Each instance of @option{--verbose} on the command line increases the -verbosity level by one, so if you need more details on the output, +verbosity level by one, so if you need more details on the output, specify it twice. When reading archives (@option{--list}, @option{--extract}, @@ -911,7 +911,7 @@ In contrast, when writing archives (@option{--create}, @option{--append}, default. So, a single @option{--verbose} option shows the file names being added to the archive, while two @option{--verbose} options enable the full listing. - + For example, to create an archive in verbose mode: @smallexample @@ -995,16 +995,10 @@ not encounter this. The archive member is a GNU @dfn{volume header} (@pxref{Tape Files}). @item --Continued at byte @var{n}-- -Encountered only at the beginning of a multy-volume archive +Encountered only at the beginning of a multi-volume archive (@pxref{Using Multiple Tapes}). This archive member is a continuation from the previous volume. The number @var{n} gives the offset where -the original file was split. - -@item --Mangled file names-- -This archive member contains @dfn{mangled file names} declarations, -a special member type that was used by early versions of @GNUTAR{}. -You probably will never encounter this, unless you are reading a very -old archive. +the original file was split. @item unknown file type @var{c} An archive member of unknown type. @var{c} is the type character from @@ -1378,7 +1372,7 @@ particular archive contains. You can use the @option{--list} appear in the archive, as well as various attributes of the files at the time they were archived. For example, you can examine the archive @file{collection.tar} that you created in the last section with the -command, +command, @smallexample $ @kbd{tar --list --file=collection.tar} @@ -1580,7 +1574,7 @@ mistakenly deleted one of the files you had placed in the archive @file{collection.tar} earlier (say, @file{blues}), you can extract it from the archive without changing the archive's structure. Its contents will be identical to the original file @file{blues} that you -deleted. +deleted. First, make sure you are in the @file{practice} directory, and list the files in the directory. Now, delete the file, @samp{blues}, and list @@ -1630,7 +1624,7 @@ Here, @option{--wildcards} instructs @command{tar} to treat command line arguments as globbing patterns and @option{--no-anchored} informs it that the patterns apply to member names after any @samp{/} delimiter. The use of globbing patterns is discussed in detail in -@xref{wildcards}. +@xref{wildcards}. You can extract a file to standard output by combining the above options with the @option{--to-stdout} (@option{-O}) option (@pxref{Writing to Standard @@ -1894,13 +1888,33 @@ All abnormal exits, whether immediate or delayed, should always be clearly diagnosed on @code{stderr}, after a line stating the nature of the error. -@GNUTAR{} returns only a few exit statuses. I'm really -aiming simplicity in that area, for now. If you are not using the -@option{--compare} @option{--diff}, @option{-d}) option, zero means -that everything went well, besides maybe innocuous warnings. Nonzero -means that something went wrong. Right now, as of today, ``nonzero'' -is almost always 2, except for remote operations, where it may be -128. +Possible exit codes of @GNUTAR{} are summarized in the following +table: + +@table @asis +@item 0 +@samp{Successful termination}. + +@item 1 +@samp{Some files differ}. If tar was invoked with @option{--compare} +(@option{--diff}, @option{-d}) command line option, this means that +some files in the archive differ from their disk counterparts +(@pxref{compare}). If tar was given @option{--create}, +@option{--append} or @option{--update} option, this exit code means +that some files were changed while being archived and so the resulting +archive does not contain the exact copy of the file set. + +@item 2 +@samp{Fatal error}. This means that some fatal, unrecoverable error +occurred. +@end table + +If @command{tar} has invoked a subprocess and that subprocess exited with a +nonzero exit code, @command{tar} exits with that code as well. +This can happen, for example, if @command{tar} was given some +compression option (@pxref{gzip}) and the external compressor program +failed. Another example is @command{rmt} failure during backup to the +remote device (@pxref{Remote Tape Server}). @node using tar options @section Using @command{tar} Options @@ -1980,7 +1994,7 @@ Some options @emph{may} take an argument. Such options may have at most long and short forms, they do not have old style equivalent. The rules for specifying an argument for such options are stricter than those for specifying mandatory arguments. Please, pay special -attention to them. +attention to them. @menu * Long Options:: Long Option Style @@ -1995,7 +2009,7 @@ attention to them. Each option has at least one @dfn{long} (or @dfn{mnemonic}) name starting with two dashes in a row, e.g., @option{--list}. The long names are more clear than their corresponding short or old names. It sometimes happens that a -single long option has many different different names which are +single long option has many different names which are synonymous, such as @option{--compare} and @option{--diff}. In addition, long option names can be given unique abbreviations. For example, @option{--cre} can be used in place of @option{--create} because there is no @@ -2433,7 +2447,7 @@ total number of hard links for the file, a warning message will be output @footnote{Earlier versions of @GNUTAR{} understood @option{-l} as a synonym for @option{--one-file-system}. The current semantics, which complies to UNIX98, was introduced with version -1.15.91. @xref{Changes}, for more information.}. +1.15.91. @xref{Changes}, for more information.}. @opsummary{compress} @opsummary{uncompress} @@ -2488,8 +2502,42 @@ patterns in the file @var{file}. @xref{exclude}. @opsummary{exclude-caches} @item --exclude-caches -Automatically excludes all directories -containing a cache directory tag. @xref{exclude}. +Exclude from dump any directory containing a valid cache directory +tag file, but still dump the directory node and the tag file itself. + +@xref{exclude}. + +@opsummary{exclude-caches-under} +@item --exclude-caches-under + +Exclude from dump any directory containing a valid cache directory +tag file, but still dump the directory node itself. + +@xref{exclude}. + +@opsummary{exclude-caches-all} +@item --exclude-caches-all + +Exclude from dump any directory containing a valid cache directory +tag file. @xref{exclude}. + +@opsummary{exclude-tag} +@item --exclude-tag=@var{file} + +Exclude from dump any directory containing file named @var{file}, but +dump the directory node and @var{file} itself. @xref{exclude}. + +@opsummary{exclude-tag-under} +@item --exclude-tag-under=@var{file} + +Exclude from dump the contents of any directory containing file +named @var{file}, but dump the directory node itself. @xref{exclude}. + +@opsummary{exclude-tag-all} +@item --exclude-tag-all=@var{file} + +Exclude from dump any directory containing file named @var{file}. +@xref{exclude}. @opsummary{file} @item --file=@var{archive} @@ -2576,7 +2624,7 @@ options to @command{tar} and exit. @xref{help}. @opsummary{ignore-case} @item --ignore-case Ignore case when matching member or file names with -patterns. @xref{controlling pattern-matching}. +patterns. @xref{controlling pattern-matching}. @opsummary{ignore-command-error} @item --ignore-command-error @@ -2807,7 +2855,7 @@ and group IDs when creating a @command{tar} file, rather than names. @item -o The function of this option depends on the action @command{tar} is performing. When extracting files, @option{-o} is a synonym for -@option{--no-same-owner}, i.e. it prevents @command{tar} from +@option{--no-same-owner}, i.e., it prevents @command{tar} from restoring ownership of files being extracted. When creating an archive, it is a synonym for @@ -2888,7 +2936,7 @@ discussion, @xref{transform}. To see transformed member names in verbose listings, use @option{--show-transformed-names} option -(@pxref{show-transformed-names}). +(@pxref{show-transformed-names}). @opsummary{quote-chars} @item --quote-chars=@var{string} @@ -2980,7 +3028,7 @@ appending it to an archive. @xref{remove files}. @item --restrict Disable use of some potentially harmful @command{tar} options. -Currently this option disables shell invocaton from multi-volume menu +Currently this option disables shell invocation from multi-volume menu (@pxref{Using Multiple Tapes}). @opsummary{rmt-command} @@ -3277,7 +3325,7 @@ them with the equivalent long option. @item -m @tab @ref{--touch}. @item -o @tab When creating, @ref{--no-same-owner}, when extracting --- -@ref{--portability}. +@ref{--portability}. The later usage is deprecated. It is retained for compatibility with the earlier versions of @GNUTAR{}. In the future releases @@ -3406,14 +3454,14 @@ information about @GNUTAR{} is this Texinfo documentation. @opindex show-defaults @GNUTAR{} has some predefined defaults that are used when you do not -explicitely specify another values. To obtain a list of such +explicitly specify another values. To obtain a list of such defaults, use @option{--show-defaults} option. This will output the values in the form of @command{tar} command line options: @smallexample @group @kbd{tar --show-defaults} ---format=gnu -f- -b20 --quoting-style=escape +--format=gnu -f- -b20 --quoting-style=escape --rmt-command=/etc/rmt --rsh-command=/usr/bin/rsh @end group @end smallexample @@ -3528,14 +3576,14 @@ statistics is to be printed: Print statistics upon delivery of signal @var{signo}. Valid arguments are: @code{SIGHUP}, @code{SIGQUIT}, @code{SIGINT}, @code{SIGUSR1} and @code{SIGUSR2}. Shortened names without @samp{SIG} prefix are also -accepted. +accepted. @end table Both forms of @option{--totals} option can be used simultaneously. Thus, @kbd{tar -x --totals --totals=USR1} instructs @command{tar} to extract all members from its default archive and print statistics after finishing the extraction, as well as when receiving signal -@code{SIGUSR1}. +@code{SIGUSR1}. @anchor{Progress information} @cindex Progress information @@ -3690,7 +3738,7 @@ consequence of doing so. The usual consequence is that the single file, which was meant to be saved, is rather destroyed. @end enumerate -So, recognizing the likelihood and the catastrophical nature of these +So, recognizing the likelihood and the catastrophic nature of these errors, @GNUTAR{} now takes some distance from elegance, and cowardly refuses to create an archive when @option{--create} option is given, there are no arguments besides options, and @@ -3940,7 +3988,7 @@ archive in the order in which they were archived. Thus, when the archive is extracted, a file archived later in time will replace a file of the same name which was archived earlier, even though the older version of the file will remain in the archive unless you delete -all versions of the file. +all versions of the file. Supposing you change the file @file{blues} and then append the changed version to @file{collection.tar}. As you saw above, the original @@ -4252,7 +4300,7 @@ tar: funk not found in archive The spirit behind the @option{--compare} (@option{--diff}, @option{-d}) option is to check whether the archive represents the current state of files on disk, more than validating the integrity of -the archive media. For this later goal, @xref{verify}. +the archive media. For this later goal, @xref{verify}. @node create options @section Options Used by @option{--create} @@ -4461,7 +4509,7 @@ The @option{--ignore-zeros} (@option{-i}) option is turned off by default becaus versions of @command{tar} write garbage after the end-of-archive entry, since that part of the media is never supposed to be read. @GNUTAR{} does not write after the end of an archive, but seeks to -maintain compatiblity among archiving utilities. +maintain compatibility among archiving utilities. @table @option @item --ignore-zeros @@ -4659,7 +4707,7 @@ Use in conjunction with @option{--extract} (@option{--get}, @option{-x}). To set the modes (access permissions) of extracted files to those recorded for those files in the archive, use @option{--same-permissions} in conjunction with the @option{--extract} (@option{--get}, -@option{-x}) operation. +@option{-x}) operation. @table @option @opindex preserve-permissions @@ -4676,7 +4724,7 @@ archive, instead of current umask settings. Use in conjunction with @node Directory Modification Times and Permissions @unnumberedsubsubsec Directory Modification Times and Permissions -After sucessfully extracting a file member, @GNUTAR{} normally +After successfully extracting a file member, @GNUTAR{} normally restores its permissions and modification times, as described in the previous sections. This cannot be done for directories, because after extracting a directory @command{tar} will almost certainly @@ -4707,9 +4755,9 @@ incremental archives (@pxref{Incremental Dumps}). The member order in an incremental archive is reversed: first all directory members are stored, followed by other (non-directory) members. So, when extracting from incremental archives, @GNUTAR{} alters the above procedure. It -remebers all restored directories, and restores their meta-data +remembers all restored directories, and restores their meta-data only after the entire archive has been processed. Notice, that you do -not need to specity any special options for that, as @GNUTAR{} +not need to specify any special options for that, as @GNUTAR{} automatically detects archives in incremental format. There may be cases, when such processing is required for normal archives @@ -4792,7 +4840,7 @@ or even like this if you want to process the concatenation of the files: tar -xOzf foo.tgz bigfile1 bigfile2 | process @end smallexample -Hovewer, @option{--to-command} may be more convenient for use with +However, @option{--to-command} may be more convenient for use with multiple files. See the next section. @node Writing to an External Program @@ -5395,7 +5443,7 @@ then in order to restore the exact contents the file system had when the last level was created, you will need to restore from all backups in turn. Continuing our example, to restore the state of @file{/usr} file system, one would do@footnote{Notice, that since both archives -were created withouth @option{-P} option (@pxref{absolute}), these +were created without @option{-P} option (@pxref{absolute}), these commands should be run from the root file system.}: @smallexample @@ -5423,7 +5471,7 @@ Versions of @GNUTAR{} up to 1.15.1 used to dump verbatim binary contents of the DUMPDIR header (with terminating nulls) when @option{--incremental} or @option{--listed-incremental} option was given, no matter what the verbosity level. This behavior, and, -especially, the binary output it produced were considered incovenient +especially, the binary output it produced were considered inconvenient and were changed in version 1.16}: @smallexample @@ -5574,7 +5622,7 @@ normally be the host that actually contains the file system. However, the host machine must have @GNUTAR{} installed, and must be able to access the directory containing the backup scripts and their support files using the same file name that is used on the -machine where the scripts are run (i.e. what @command{pwd} will print +machine where the scripts are run (i.e., what @command{pwd} will print when in that directory on that machine). If the host that contains the file system does not have this capability, you can specify another host as long as it can access the file system through NFS. @@ -5623,7 +5671,7 @@ to use public key authentication. @defvr {Backup variable} RSH_COMMAND -Full file name of @command{rsh} binary on remote mashines. This will +Full file name of @command{rsh} binary on remote machines. This will be passed via @option{--rsh-command} option to the remote invocation of @GNUTAR{}. @end defvr @@ -5908,7 +5956,7 @@ Force backup even if today's log file already exists. @item -v[@var{level}] @itemx --verbose[=@var{level}] Set verbosity level. The higher the level is, the more debugging -information will be output during execution. Devault @var{level} +information will be output during execution. Default @var{level} is 100, which means the highest debugging level. @item -t @var{start-time} @@ -5980,7 +6028,7 @@ Start restoring from the given backup level, instead of the default 0. @item -v[@var{level}] @itemx --verbose[=@var{level}] Set verbosity level. The higher the level is, the more debugging -information will be output during execution. Devault @var{level} +information will be output during execution. Default @var{level} is 100, which means the highest debugging level. @item -h @@ -6083,7 +6131,7 @@ floppy disk, or CD write drive. If you do not name the archive, @command{tar} uses the value of the environment variable @env{TAPE} as the file name for the archive. If that is not available, @command{tar} uses a default, compiled-in archive -name, usually that for tape unit zero (i.e. @file{/dev/tu00}). +name, usually that for tape unit zero (i.e., @file{/dev/tu00}). @cindex Standard input and output @cindex tar to standard input and output @@ -6150,7 +6198,7 @@ can be inhibited by using the @option{--force-local} option. When the archive is being created to @file{/dev/null}, @GNUTAR{} tries to minimize input and output operations. The Amanda backup system, when used with @GNUTAR{}, has an initial sizing pass which -uses this feature. +uses this feature. @node Selecting Archive Members @section Selecting Archive Members @@ -6178,9 +6226,9 @@ name, replacing @dfn{escape sequences} according to the following table: @multitable @columnfractions 0.20 0.60 -@headitem Escape @tab Replaced with +@headitem Escape @tab Replaced with @item \a @tab Audible bell (ASCII 7) -@item \b @tab Backspace (ASCII 8) +@item \b @tab Backspace (ASCII 8) @item \f @tab Form feed (ASCII 12) @item \n @tab New line (ASCII 10) @item \r @tab Carriage return (ASCII 13) @@ -6236,7 +6284,7 @@ By default, @command{tar} takes file names from the command line. However, there are other ways to specify file or member names, or to modify the manner in which @command{tar} selects the files or members upon which to operate. In general, these methods work both for specifying the names -of files and archive members. +of files and archive members. @node files @section Reading Names from a File @@ -6248,7 +6296,7 @@ Instead of giving the names of files or archive members on the command line, you can put the names into a file, and then use the @option{--files-from=@var{file-of-names}} (@option{-T @var{file-of-names}}) option to @command{tar}. Give the name of the -file which contains the list of files to include as the argument to +file which contains the list of files to include as the argument to @option{--files-from}. In the list, the file names should be separated by newlines. You will frequently use this option when you have generated the list of files to archive with the @command{find} utility. @@ -6377,7 +6425,7 @@ The @option{--null} option causes @option{--files-from=@var{file-of-names}} (@option{-T @var{file-of-names}}) to read file names terminated by a @code{NUL} instead of a newline, so files whose names contain newlines can be archived using -@option{--files-from}. +@option{--files-from}. @table @option @opindex null @@ -6428,7 +6476,7 @@ Causes @command{tar} to ignore files that match the @var{pattern}. @findex exclude The @option{--exclude=@var{pattern}} option prevents any file or member whose name matches the shell wildcard (@var{pattern}) from -being operated on. +being operated on. For example, to create an archive with all the contents of the directory @file{src} except for files whose names end in @file{.o}, use the command @samp{tar -cf src.tar --exclude='*.o' src}. @@ -6451,15 +6499,9 @@ called as @w{@samp{tar -c -X foo .}} and the file @file{foo} contains a single line @file{*.o}, no files whose names end in @file{.o} will be added to the archive. -@table @option -@opindex exclude-caches -@item --exclude-caches -Causes @command{tar} to ignore directories containing a cache directory tag. -@end table - @findex exclude-caches -When creating an archive, the @option{--exclude-caches} option causes -@command{tar} to exclude all directories that contain a @dfn{cache +When creating an archive, the @option{--exclude-caches} option family +causes @command{tar} to exclude all directories that contain a @dfn{cache directory tag}. A cache directory tag is a short file with the well-known name @file{CACHEDIR.TAG} and having a standard header specified in @url{http://www.brynosaurus.com/cachedir/spec.html}. @@ -6467,6 +6509,107 @@ Various applications write cache directory tags into directories they use to hold regenerable, non-precious data, so that such data can be more easily excluded from backups. +There are three @samp{exclude-caches} option, providing a different +exclusion semantics: + +@table @option +@opindex exclude-caches +@item --exclude-caches +Do not archive the contents of the directory, but archive the +directory itself and the @file{CACHEDIR.TAG} file. + +@opindex exclude-caches-under +@item --exclude-caches-under +Do not archive the contents of the directory, nor the +@file{CACHEDIR.TAG} file, archive only the directory itself. + +@opindex exclude-caches-all +@item --exclude-caches-all +Omit directories containing @file{CACHEDIR.TAG} file entirely. +@end table + +@findex exclude-tag +Another option family, @option{--exclude-tag}, provides a generalization of +this concept. It takes a single argument, a file name to look for. +Any directory that contains this file will be excluded from the dump. +Similarly to @samp{exclude-caches}, there are three options in this +option family: + +@table @option +@opindex exclude-tag +@item --exclude-tag=@var{file} +Do not dump the contents of the directory, but dump the +directory itself and the @var{file}. + +@opindex exclude-tag-under +@item --exclude-tag-under=@var{file} +Do not dump the contents of the directory, nor the +@var{file}, archive only the directory itself. + +@opindex exclude-tag-all +@item --exclude-tag-all=@var{file} +Omit directories containing @var{file} file entirely. +@end table + +Multiple @option{--exclude-tag*} options can be given. + +For example, given this directory: + +@smallexample +@group +$ @kbd{find dir} +dir +dir/blues +dir/jazz +dir/folk +dir/folk/tagfile +dir/folk/sanjuan +dir/folk/trote +@end group +@end smallexample + +The @option{--exclude-tag} will produce the following: + +@smallexample +$ @kbd{tar -cf archive.tar --exclude-tag=tagfile -v dir} +dir/ +dir/blues +dir/jazz +dir/folk/ +tar: dir/folk/: contains a cache directory tag tagfile; + contents not dumped +dir/folk/tagfile +@end smallexample + +Both the @file{dir/folk} directory and its tagfile are preserved in +the archive, however the rest of files in this directory are not. + +Now, using the @option{--exclude-tag-under} option will exclude +@file{tagfile} from the dump, while still preserving the directory +itself, as shown in this example: + +@smallexample +$ @kbd{tar -cf archive.tar --exclude-tag-under=tagfile -v dir} +dir/ +dir/blues +dir/jazz +dir/folk/ +./tar: dir/folk/: contains a cache directory tag tagfile; + contents not dumped +@end smallexample + +Finally, using @option{--exclude-tag-all} omits the @file{dir/folk} +directory entirely: + +@smallexample +$ @kbd{tar -cf archive.tar --exclude-tag-all=tagfile -v dir} +dir/ +dir/blues +dir/jazz +./tar: dir/folk/: contains a cache directory tag tagfile; + directory not dumped +@end smallexample + @menu * problems with exclude:: @end menu @@ -6526,7 +6669,7 @@ might fail. @item @FIXME{The change in semantics must have occurred before 1.11, so I doubt if it is worth mentioning at all. Anyway, should at -least specify in which version the semantics changed.} +least specify in which version the semantics changed.} In earlier versions of @command{tar}, what is now the @option{--exclude-from} option was called @option{--exclude} instead. Now, @option{--exclude} applies to patterns listed on the command @@ -6611,7 +6754,7 @@ There are no inclusion members in create mode (@option{--create} and command line refer to @emph{files}, not archive members. By default, inclusion members are compared with archive members -literally @footnote{Notice that earlier @GNUTAR{} versions used +literally @footnote{Notice that earlier @GNUTAR{} versions used globbing for inclusion members, which contradicted to UNIX98 specification and was not documented. @xref{Changes}, for more information on this and other changes.} and exclusion members are @@ -6639,7 +6782,7 @@ This behavior can be altered by using the following options: @table @option @opindex wildcards @item --wildcards -Treat all member names as wildcards. +Treat all member names as wildcards. @opindex no-wildcards @item --no-wildcards @@ -6658,7 +6801,7 @@ b.c Notice quoting of the pattern to prevent the shell from interpreting it. -The effect of @option{--wildcards} option is cancelled by +The effect of @option{--wildcards} option is canceled by @option{--no-wildcards}. This can be used to pass part of the command line arguments verbatim and other part as globbing patterns. For example, the following invocation: @@ -6822,7 +6965,7 @@ Quoting styles: No quoting, display each character as is: @smallexample -@group +@group $ @kbd{tar tf arch.tar --quoting-style=literal} ./ ./a space @@ -6965,7 +7108,7 @@ quoting style would not quote them. @end table For example, using @samp{escape} quoting (compare with the usual -escape listing above): +escape listing above): @smallexample @group @@ -7038,7 +7181,7 @@ $ @kbd{tar -xf usr.tar --strip=2 usr/include/stdlib.h} The option @option{--strip=2} instructs @command{tar} to strip the two leading components (@file{usr/} and @file{include/}) off the file -name. +name. If you add to the above invocation @option{--verbose} (@option{-v}) option, you will note that the verbose listing still contains the @@ -7131,10 +7274,10 @@ Only replace the @var{number}th match of the @var{regexp}. Note: the @var{posix} standard does not specify what should happen when you mix the @samp{g} and @var{number} modifiers. @GNUTAR{} follows the GNU @command{sed} implementation in this regard, so -the the interaction is defined to be: ignore matches before the +the interaction is defined to be: ignore matches before the @var{number}th, and then match and replace all matches from the @var{number}th on. - + @end table Any delimiter can be used in lieue of @samp{/}, the only requirement being @@ -7202,7 +7345,7 @@ $ @kbd{tar -cf arch.tar --transform='s,^usr/,var/,' \ If both @option{--strip-components} and @option{--transform} are used together, then @option{--transform} is applied first, and the required number of components is then stripped from its result. - + @node after @section Operating Only on New Files @UNREVISED @@ -7418,7 +7561,6 @@ mentioned by name on the standard error. @node directory @subsection Changing the Working Directory -@UNREVISED @FIXME{need to read over this node now for continuity; i've switched things around some.} @@ -7504,12 +7646,10 @@ For instance, the file list for the above example will be: @smallexample @group --C -/etc +-C/etc passwd hosts --C -/lib +--directory=/lib libc.a @end group @end smallexample @@ -7521,9 +7661,6 @@ To use it, you would invoke @command{tar} as follows: $ @kbd{tar -c -f foo.tar --files-from list} @end smallexample -Notice also that you can only use the short option variant in the file -list, i.e., always use @option{-C}, not @option{--directory}. - The interpretation of @option{--directory} is disabled by @option{--null} option. @@ -7687,7 +7824,7 @@ cases the maximum file name length will be shorter than 256 characters. @item The maximum length of a symbolic link name is limited to 100 characters. -@item Maximum size of a file the archive is able to accomodate +@item Maximum size of a file the archive is able to accommodate is 8GB @item Maximum value of UID/GID is 2097151. @item Maximum number of bits in device major and minor numbers is 21. @@ -7754,7 +7891,7 @@ switch to @samp{posix}. @GNUTAR{} is able to create and read compressed archives. It supports @command{gzip} and @command{bzip2} compression programs. For backward -compatibilty, it also supports @command{compress} command, although +compatibility, it also supports @command{compress} command, although we strongly recommend against using it, since there is a patent covering the algorithm it uses and you could be sued for patent infringement merely by running @command{compress}! Besides, it is less @@ -7890,10 +8027,10 @@ and produce uncompressed data on the standard output. @cindex Using encrypted archives The @option{--use-compress-program} option, in particular, lets you implement your own filters, not necessarily dealing with -compression/decomression. For example, suppose you wish to implement +compression/decompression. For example, suppose you wish to implement PGP encryption on top of compression, using @command{gpg} (@pxref{Top, gpg, gpg ---- encryption and signing tool, gpg, GNU Privacy Guard -Manual}). The following script does that: +Manual}). The following script does that: @smallexample @group @@ -7907,7 +8044,7 @@ esac @end smallexample Suppose you name it @file{gpgz} and save it somewhere in your -@env{PATH}. Then the following command will create a commpressed +@env{PATH}. Then the following command will create a compressed archive signed with your private key: @smallexample @@ -7946,9 +8083,9 @@ The above is based on the following discussion: that capability. Supposing I were to actually do such a thing and get it (apparently) working, do you accept contributed changes to utilities like that? (Leigh Clayton @file{loc@@soliton.com}, May 1995). - + Isn't that exactly the role of the - @option{--use-compress-prog=@var{program}} option? + @option{--use-compress-prog=@var{program}} option? I never tried it myself, but I suspect you may want to write a @var{prog} script or program able to filter stdin to stdout to way you want. It should recognize the @option{-d} option, for when @@ -7985,7 +8122,7 @@ won't take more space than the original. @opindex sparse @item -S @itemx --sparse -This option istructs @command{tar} to test each file for sparseness +This option instructs @command{tar} to test each file for sparseness before attempting to archive it. If the file is found to be sparse it is treated specially, thus allowing to decrease the amount of space used by its image in the archive. @@ -7996,7 +8133,7 @@ has no effect on extraction. Consider using @option{--sparse} when performing file system backups, to avoid archiving the expanded forms of files stored sparsely in the -system. +system. Even if your system has no sparse files currently, some may be created in the future. If you use @option{--sparse} while making file @@ -8044,7 +8181,7 @@ formats}. A sparse format is identified by its @dfn{number}, consisting, as usual of two decimal numbers, delimited by a dot. By default, format @samp{1.0} is used. If, for some reason, you wish to use an earlier format, you can select it using -@option{--sparse-version} option. +@option{--sparse-version} option. @table @option @opindex sparse-version @@ -8122,7 +8259,7 @@ separately. If it can't find a user name (because the user id is not in @file{/etc/passwd}), then it does not write one. When restoring, it tries to look the name (if one was written) up in @file{/etc/passwd}. If it fails, then it uses the user id stored in -the archive instead. +the archive instead. @opindex no-same-owner @item --no-same-owner @@ -8353,7 +8490,7 @@ Starting from version 1.14 @GNUTAR{} features full support for A @acronym{POSIX} conformant archive will be created if @command{tar} was given @option{--format=posix} (@option{--format=pax}) option. No special option is required to read and extract from a @acronym{POSIX} -archive. +archive. @menu * PAX keywords:: Controlling Extended Header Keywords. @@ -8550,13 +8687,13 @@ POSIX-aware tars.} @node Other Tars @subsection How to Extract GNU-Specific Data Using Other @command{tar} Implementations -In previous sections you became acquainted with various quircks +In previous sections you became acquainted with various quirks necessary to make your archives portable. Sometimes you may need to extract archives containing GNU-specific members using some third-party @command{tar} implementation or an older version of @GNUTAR{}. Of course your best bet is to have @GNUTAR{} installed, but if it is for some reason impossible, this section will explain -how to cope without it. +how to cope without it. When we speak about @dfn{GNU-specific} members we mean two classes of them: members split between the volumes of a multi-volume archive and @@ -8573,6 +8710,7 @@ describe the required procedures in detail. @node Split Recovery @subsubsection Extracting Members Split Between Volumes +@cindex Mutli-volume archives, extracting using non-GNU tars If a member is split between several volumes of an old GNU format archive most third party @command{tar} implementation will fail to extract it. To extract it, use @command{tarcat} program (@pxref{Tarcat}). @@ -8580,17 +8718,18 @@ This program is available from @uref{http://www.gnu.org/@/software/@/tar/@/utils/@/tarcat.html, @GNUTAR{} home page}. It concatenates several archive volumes into a single valid archive. For example, if you have three volumes named from -@file{vol-1.tar} to @file{vol-2.tar}, you can do the following to +@file{vol-1.tar} to @file{vol-3.tar}, you can do the following to extract them using a third-party @command{tar}: @smallexample $ @kbd{tarcat vol-1.tar vol-2.tar vol-3.tar | tar xf -} @end smallexample -You could use this approach for many (although not all) PAX +@cindex Mutli-volume archives in PAX format, extracting using non-GNU tars +You could use this approach for most (although not all) PAX format archives as well. However, extracting split members from a PAX archive is a much easier task, because PAX volumes are constructed in -such a way that each part of a split member is extracted as a +such a way that each part of a split member is extracted to a different file by @command{tar} implementations that are not aware of GNU extensions. More specifically, the very first part retains its original name, and all subsequent parts are named using the pattern: @@ -8614,7 +8753,7 @@ created the archive. @item %n @tab Ordinal number of this particular part. @end multitable -For example, if, a file @file{var/longfile} was split during archive +For example, if the file @file{var/longfile} was split during archive creation between three volumes, and the creator @command{tar} process had process ID @samp{27962}, then the member names will be: @@ -8640,7 +8779,7 @@ $ rm -f GNUFileParts.27962 Notice, that if the @command{tar} implementation you use supports PAX format archives, it will probably emit warnings about unknown keywords -during extraction. They will lool like this: +during extraction. They will look like this: @smallexample @group @@ -8655,13 +8794,13 @@ Unknown extended header keyword 'GNU.volume.offset' ignored. You can safely ignore these warnings. If your @command{tar} implementation is not PAX-aware, you will get -more warnigns and more files generated on your disk, e.g.: +more warnings and more files generated on your disk, e.g.: @smallexample @group $ @kbd{tar xf vol-1.tar} var/PaxHeaders.27962/longfile: Unknown file type 'x', extracted as -normal file +normal file Unexpected EOF in archive $ @kbd{tar xf vol-2.tar} tmp/GlobalHead.27962.1: Unknown file type 'g', extracted as normal file @@ -8678,24 +8817,27 @@ members. Read further to learn more about them. @node Sparse Recovery @subsubsection Extracting Sparse Members +@cindex sparse files, extracting with non-GNU tars Any @command{tar} implementation will be able to extract sparse members from a PAX archive. However, the extracted files will be @dfn{condensed}, -i.e. any zero blocks will be removed from them. When we restore such +i.e., any zero blocks will be removed from them. When we restore such a condensed file to its original form, by adding zero bloks (or @dfn{holes}) back to their original locations, we call this process @dfn{expanding} a compressed sparse file. +@pindex xsparse To expand a file, you will need a simple auxiliary program called @command{xsparse}. It is available in source form from @uref{http://www.gnu.org/@/software/@/tar/@/utils/@/xsparse.html, @GNUTAR{} home page}. +@cindex sparse files v.1.0, extracting with non-GNU tars Let's begin with archive members in @dfn{sparse format version 1.0}@footnote{@xref{PAX 1}.}, which are the easiest to expand. The condensed file will contain both file map and file data, so no additional data will be needed to restore it. If the original file name was @file{@var{dir}/@var{name}}, then the condensed file will be -named @file{@var{dir}/@/GNUSparseFile.@var{n}/@/@var{name}}, where +named @file{@var{dir}/@/GNUSparseFile.@var{n}/@/@var{name}}, where @var{n} is a decimal number@footnote{technically speaking, @var{n} is a @dfn{process ID} of the @command{tar} process which created the archive (@pxref{PAX keywords}).}. @@ -8726,11 +8868,11 @@ name will be @file{@var{dir}/@var{name}}. @end enumerate In the unlikely case when this algorithm does not suite your needs, -you can explicitely specify output file name as a second argument to +you can explicitly specify output file name as a second argument to the command: @smallexample -$ @kbd{xsparse @file{cond-file}} +$ @kbd{xsparse @file{cond-file} @file{out-file}} @end smallexample It is often a good idea to run @command{xsparse} in @dfn{dry run} mode @@ -8758,7 +8900,7 @@ $ @kbd{xsparse /home/gray/GNUSparseFile.6058/sparsefile} The program behaves the same way all UNIX utilities do: it will keep quiet unless it has simething important to tell you (e.g. an error condition or something). If you wish it to produce verbose output, -similar to that from the dry run mode, give it @option{-v} option: +similar to that from the dry run mode, use @option{-v} option: @smallexample @group @@ -8792,18 +8934,21 @@ Done @end group @end smallexample +@anchor{extracting sparse v.0.x} +@cindex sparse files v.0.1, extracting with non-GNU tars +@cindex sparse files v.0.0, extracting with non-GNU tars An @dfn{extended header} is a special @command{tar} archive header that precedes an archive member and contains a set of @dfn{variables}, describing the member properties that cannot be stored in the standard @code{ustar} header. While optional for expanding sparse version 1.0 members, use of extended headers is mandatory when expanding sparse members in older sparse formats: v.0.0 -and v.0.1 (The sparse formats are described in detail in @pxref{Sparse -Formats}). So, for this format, the question is: how to obtain -extended headers from the archive? +and v.0.1 (The sparse formats are described in detail in @ref{Sparse +Formats}.) So, for this format, the question is: how to obtain +extended headers from the archive? If you use a @command{tar} implementation that does not support PAX -format, extended headers for each member will be extracted as a +format, extended headers for each member will be extracted as a separate file. If we represent the member name as @file{@var{dir}/@var{name}}, then the extended header file will be named @file{@var{dir}/@/PaxHeaders.@var{n}/@/@var{name}}, where @@ -8814,15 +8959,15 @@ does support PAX headers, because in this case you will have to manually extract the headers. We recommend the following algorithm: @enumerate 1 -@item -Consult the documentation for your @command{tar} implementation for an -option that will print @dfn{block numbers} along with the archive +@item +Consult the documentation of your @command{tar} implementation for an +option that prints @dfn{block numbers} along with the archive listing (analogous to @GNUTAR{}'s @option{-R} option). For example, @command{star} has @option{-block-number}. @item -Obtain the verbose listing using the @samp{block number} option, and -find the position of the sparse member in question and the member +Obtain verbose listing using the @samp{block number} option, and +find block numbers of the sparse member in question and the member immediately following it. For example, running @command{star} on our archive we obtain: @@ -8846,7 +8991,7 @@ block 897: 65391 -rw-r--r-- gray/users Jun 24 20:06 2006 README @item Let @var{size} be the size of the sparse member, @var{Bs} be its block number and @var{Bn} be the block number of the next member. -Compute: +Compute: @smallexample @var{N} = @var{Bs} - @var{Bn} - @var{size}/512 - 2 @@ -9426,7 +9571,7 @@ examples of format parameter considerations. @opindex blocking-factor The data in an archive is grouped into blocks, which are 512 bytes. Blocks are read and written in whole number multiples called -@dfn{records}. The number of blocks in a record (i.e. the size of a +@dfn{records}. The number of blocks in a record (i.e., the size of a record in units of 512 bytes) is called the @dfn{blocking factor}. The @option{--blocking-factor=@var{512-size}} (@option{-b @var{512-size}}) option specifies the blocking factor of an archive. @@ -9484,7 +9629,7 @@ it would normally. To extract files from an archive with a non-standard blocking factor (particularly if you're not sure what the blocking factor is), you can usually use the @option{--read-full-records} (@option{-B}) option while specifying a blocking factor larger then the blocking factor of the archive -(i.e. @samp{tar --extract --read-full-records --blocking-factor=300}. +(i.e., @samp{tar --extract --read-full-records --blocking-factor=300}. @xref{list}, for more information on the @option{--list} (@option{-t}) operation. @xref{Reading}, for a more detailed explanation of that option. @@ -9890,15 +10035,15 @@ on several media volumes of fixed size. Although in this section we will often call @samp{volume} a @dfn{tape}, there is absolutely no requirement for multi-volume archives to be stored on tapes. Instead, they can use whatever media type the user finds convenient, they can -even be located on files. +even be located on files. -When creating a multi-volume arvhive, @GNUTAR{} continues to fill +When creating a multi-volume archive, @GNUTAR{} continues to fill current volume until it runs out of space, then it switches to next volume (usually the operator is queried to replace the tape on this point), and continues working on the new volume. This operation -continues untill all requested files are dumped. If @GNUTAR{} detects +continues until all requested files are dumped. If @GNUTAR{} detects end of media while dumping a file, such a file is archived in split -form. Some very big files can even be split across several volumes. +form. Some very big files can even be split across several volumes. Each volume is itself a valid @GNUTAR{} archive, so it can be read without any special options. Consequently any file member residing @@ -9976,7 +10121,7 @@ $ @kbd{tar --create --tape-length=41943040 --file=/dev/tape @var{files}} When @GNUTAR{} comes to the end of a storage media, it asks you to change the volume. The built-in prompt for POSIX locale is@footnote{If you run @GNUTAR{} under a different locale, the -translation to the locale's language will be used.}: +translation to the locale's language will be used.}: @smallexample Prepare volume #@var{n} for `@var{archive}' and hit return: @@ -10015,7 +10160,7 @@ otherwise @command{tar} will write over the volume it just finished.) The volume number used by @command{tar} in its tape-changing prompt can be changed; if you give the @option{--volno-file=@var{file-of-number}} option, then -@var{file-of-number} should be an unexisting file to be created, or +@var{file-of-number} should be an non-existing file to be created, or else, a file already containing a decimal number. That number will be used as the volume number of the first volume written. When @command{tar} is finished, it will rewrite the file with the @@ -10031,7 +10176,7 @@ the number used in the prompt.) If you want more elaborate behavior than this, you can write a special @dfn{new volume script}, that will be responsible for changing the volume, and instruct @command{tar} to use it instead of its normal -prompting procedure: +prompting procedure: @table @option @item --info-script=@var{script-name} @@ -10095,7 +10240,7 @@ $ @kbd{tar cMff /dev/tape0 /dev/tape1 @var{files}} @end smallexample The second method is to use the @samp{n} response to the tape-change -prompt. +prompt. Finally, the most flexible approach is to use a volume script, that writes new archive name to the file descriptor #3. For example, the @@ -10145,7 +10290,7 @@ To extract an archive member from one volume (assuming it is described that volume), use @option{--extract}, again without @option{--multi-volume}. -If an archive member is split across volumes (i.e. its entry begins on +If an archive member is split across volumes (i.e., its entry begins on one volume of the media and ends on another), you need to specify @option{--multi-volume} to extract it successfully. In this case, you should load the volume where the archive member starts, and use @@ -10165,22 +10310,10 @@ added later. To label subsequent volumes, specify @option{--label=@var{archive-label}} again in conjunction with the @option{--append}, @option{--update} or @option{--concatenate} operation. -@FIXME{This is no longer true: Multivolume archives in @samp{POSIX} -format can be extracted using any posix-compliant tar -implementation. The split members can then be recreated from parts -using a simple shell script. Provide more information about it:} -Beware that there is @emph{no} real standard about the proper way, for -a @command{tar} archive, to span volume boundaries. If you have a -multi-volume created by some vendor's @command{tar}, there is almost -no chance you could read all the volumes with @GNUTAR{}. -The converse is also true: you may not expect -multi-volume archives created by @GNUTAR{} to be -fully recovered by vendor's @command{tar}. Since there is little -chance that, in mixed system configurations, some vendor's -@command{tar} will work on another vendor's machine, and there is a -great chance that @GNUTAR{} will work on most of -them, your best bet is to install @GNUTAR{} on all -machines between which you know exchange of files is possible. +Notice that multi-volume support is a GNU extension and the archives +created in this mode should be read only using @GNUTAR{}. If you +absolutely have to process such archives using a third-party @command{tar} +implementation, read @ref{Split Recovery}. @node Tape Files @subsection Tape Files @@ -10278,7 +10411,7 @@ creating multiple volume archives. @cindex Listing volume label The volume label will be displayed by @option{--list} along with the file contents. If verbose display is requested, it will also be -explicitely marked as in the example below: +explicitly marked as in the example below: @smallexample @group @@ -10323,7 +10456,7 @@ with using @option{--label} option, @command{tar} will first check if the archive label matches the one specified and will refuse to proceed if it does not. Use this as a safety precaution to avoid accidentally overwriting existing archives. For example, if you wish to add files -to @file{archive}, presumably labelled with string @samp{My volume}, +to @file{archive}, presumably labeled with string @samp{My volume}, you will get: @smallexample @@ -10335,7 +10468,7 @@ tar: Archive not labeled to match `My volume' @noindent in case its label does not match. This will work even if -@file{archive} is not labelled at all. +@file{archive} is not labeled at all. Similarly, @command{tar} will refuse to list or extract the archive if its label doesn't match the @var{archive-label} @@ -10566,7 +10699,7 @@ This option is deprecated. Please use @option{--format=posix} instead. @appendix Configuring Help Summary Running @kbd{tar --help} displays the short @command{tar} option -summary (@pxref{help}). This summary is organised by @dfn{groups} of +summary (@pxref{help}). This summary is organized by @dfn{groups} of semantically close options. The options within each group are printed in the following order: a short option, eventually followed by a list of corresponding long option names, followed by a short description of @@ -10800,7 +10933,7 @@ Right margin of the text output. Used for wrapping. @appendix Index of Command Line Options This appendix contains an index of all @GNUTAR{} long command line -options. The options are listed without the preceeding double-dash. +options. The options are listed without the preceding double-dash. For a cross-reference of short command line options, @ref{Short Option Summary}. @printindex op