summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2010-02-25 10:34:29 +0200
committerSergey Poznyakoff <gray@gnu.org.ua>2010-02-25 10:41:18 +0200
commit762be4f2bd696b3fcc381da7d78fcdd4114215ec (patch)
treeecfc58a4cf397af582d873cd7ad4f513422a4dd7 /doc
parentb7899bb121c496f95f3d6f071bc38e493f15370b (diff)
downloadtar-762be4f2bd696b3fcc381da7d78fcdd4114215ec.tar.gz
Supply more information to the --to-command script.
* src/system.c (stat_to_env): Pass information about the current volume in variables TAR_ARCHIVE, TAR_VOLUME, TAR_BLOCKING_FACTOR, TAR_FORMAT. * doc/tar.texi: Document new environment variables. * NEWS: Likewise. * configure.ac: Version number 1.22.91.
Diffstat (limited to 'doc')
-rw-r--r--doc/tar.texi25
1 files changed, 24 insertions, 1 deletions
diff --git a/doc/tar.texi b/doc/tar.texi
index 9a8b1719..abc81df3 100644
--- a/doc/tar.texi
+++ b/doc/tar.texi
@@ -5430,9 +5430,32 @@ UID of the file owner.
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.
+@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: