Supply more information to the --to-command script.

[chaz/tar] / doc / tar.texi

diff --git a/doc/tar.texi b/doc/tar.texi
index 1102e32aba26be6b71a67f033c5f1e1cd69e501f..abc81df393f46fe4920583a479492dc2536783e2 100644 (file)
--- a/doc/tar.texi
+++ b/doc/tar.texi
@@ -2572,6 +2572,10 @@ during archive creation, it is order sensitive.  @xref{directory}.
 When performing operations, @command{tar} will skip files that match
 @var{pattern}.  @xref{exclude}.
 
 When performing operations, @command{tar} will skip files that match
 @var{pattern}.  @xref{exclude}.
 

+@opsummary{exclude-backups}
+@item --exclude-backups
+Exclude backup and lock files.  @xref{exclude,, exclude-backups}.
+

 @opsummary{exclude-from}
 @item --exclude-from=@var{file}
 @itemx -X @var{file}
 @opsummary{exclude-from}
 @item --exclude-from=@var{file}
 @itemx -X @var{file}


@@ -2585,7 +2589,7 @@ patterns in the file @var{file}.  @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.
 
 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}.
+@xref{exclude,, exclude-caches}.

 
 @opsummary{exclude-caches-under}
 @item --exclude-caches-under
 
 @opsummary{exclude-caches-under}
 @item --exclude-caches-under


@@ -2605,19 +2609,20 @@ tag file.  @xref{exclude}.
 @item --exclude-tag=@var{file}
 
 Exclude from dump any directory containing file named @var{file}, but
 @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}.
+dump the directory node and @var{file} itself.  @xref{exclude,, exclude-tag}.

 
 @opsummary{exclude-tag-under}
 @item --exclude-tag-under=@var{file}
 
 Exclude from dump the contents of any directory containing file
 
 @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}.
+named @var{file}, but dump the directory node itself.  @xref{exclude,,
+exclude-tag-under}.

 
 @opsummary{exclude-tag-all}
 @item --exclude-tag-all=@var{file}
 
 Exclude from dump any directory containing file named @var{file}.
 
 @opsummary{exclude-tag-all}
 @item --exclude-tag-all=@var{file}
 
 Exclude from dump any directory containing file named @var{file}.

-@xref{exclude}.
+@xref{exclude,,exclude-tag-all}.

 
 @opsummary{exclude-vcs}
 @item --exclude-vcs
 
 @opsummary{exclude-vcs}
 @item --exclude-vcs


@@ -2625,7 +2630,7 @@ Exclude from dump any directory containing file named @var{file}.
 Exclude from dump directories and files, that are internal for some
 widely used version control systems.
 
 Exclude from dump directories and files, that are internal for some
 widely used version control systems.
 

-@xref{exclude}.
+@xref{exclude,,exclude-vcs}.

 
 @opsummary{file}
 @item --file=@var{archive}
 
 @opsummary{file}
 @item --file=@var{archive}


@@ -5425,9 +5430,32 @@ UID of the file owner.
 GID of the file owner.
 @end table
 
 GID of the file owner.
 @end table
 

-In addition to these variables, @env{TAR_VERSION} contains the
+Additionally, the following variables contain information about
+tar mode and the archive being processed:
+
+@table @env
+@vrindex TAR_VERSION, to-command environment
+@item TAR_VERSION

 @GNUTAR{} version number.
 
 @GNUTAR{} version number.
 

+@vrindex TAR_ARCHIVE, to-command environment
+@item TAR_ARCHIVE
+The name of the archive @command{tar} is processing.
+
+@vrindex TAR_BLOCKING_FACTOR, to-command environment
+@item TAR_BLOCKING_FACTOR
+Current blocking factor (@pxref{Blocking}.
+
+@vrindex TAR_VOLUME, to-command environment
+@item TAR_VOLUME
+Ordinal number of the volume @command{tar} is processing.
+
+@vrindex TAR_FORMAT, to-command environment
+@item TAR_FORMAT
+Format of the archive being processed. @xref{Formats}, for a complete
+list of archive format names.
+@end table
+

 If @var{command} exits with a non-0 status, @command{tar} will print
 an error message similar to the following:
 
 If @var{command} exits with a non-0 status, @command{tar} will print
 an error message similar to the following:
 


@@ -7068,6 +7096,7 @@ which is difficult to catch using text editors.
 
 However, empty lines are OK.
 
 
 However, empty lines are OK.
 

+@table @option

 @cindex version control system, excluding files
 @cindex VCS, excluding files
 @cindex SCCS, excluding files
 @cindex version control system, excluding files
 @cindex VCS, excluding files
 @cindex SCCS, excluding files


@@ -7079,13 +7108,11 @@ However, empty lines are OK.
 @cindex Arch, excluding files
 @cindex Mercurial, excluding files
 @cindex Darcs, excluding files
 @cindex Arch, excluding files
 @cindex Mercurial, excluding files
 @cindex Darcs, excluding files

-@table @option

 @opindex exclude-vcs
 @item --exclude-vcs
 Exclude files and directories used by following version control
 systems: @samp{CVS}, @samp{RCS}, @samp{SCCS}, @samp{SVN}, @samp{Arch},
 @samp{Bazaar}, @samp{Mercurial}, and @samp{Darcs}.
 @opindex exclude-vcs
 @item --exclude-vcs
 Exclude files and directories used by following version control
 systems: @samp{CVS}, @samp{RCS}, @samp{SCCS}, @samp{SVN}, @samp{Arch},
 @samp{Bazaar}, @samp{Mercurial}, and @samp{Darcs}.

-@end table

 
 As of version @value{VERSION}, the following files are excluded:
 
 
 As of version @value{VERSION}, the following files are excluded:
 


@@ -7111,6 +7138,19 @@ As of version @value{VERSION}, the following files are excluded:
 @item @file{_darcs}
 @end itemize
 
 @item @file{_darcs}
 @end itemize
 

+@opindex exclude-backups
+@item --exclude-backups
+Exclude backup and lock files.  This option causes exclusion of files
+that match the following shell globbing patterns:
+
+@table @asis
+@item .#*
+@item *~
+@item #*#
+@end table
+
+@end table
+

 @findex exclude-caches
 When creating an archive, the @option{--exclude-caches} option family
 causes @command{tar} to exclude all directories that contain a @dfn{cache
 @findex exclude-caches
 When creating an archive, the @option{--exclude-caches} option family
 causes @command{tar} to exclude all directories that contain a @dfn{cache