[Bug-tar] Patch to improve how files are described in the documentation

[Martin Simmons]

Hi there,

Here is a patch for the documentation to make various descriptions of files
more consistent.  I had noticed some confusion about @var{snapshot-file}
v.s. @var{file} in the --listed-incremental sections, but then I found
inconsistencies for other options as well.

__Martin


------------------------------------------------------------------------------
diff -u -r1.57 tar.texi
--- doc/tar.texi        25 Jun 2004 10:32:27 -0000      1.57
+++ doc/tar.texi        26 Jun 2004 20:24:13 -0000
@@ -251,7 +251,7 @@
 @set xref-incremental @xref{Inc Dumps}
 @set pxref-incremental @pxref{Inc Dumps}
 
address@hidden op-info-script @address@hidden (@address@hidden, @kbd{-F 
@var{script-name}})
address@hidden op-info-script @address@hidden (@address@hidden, @kbd{-F 
@var{script-file}})
 @set ref-info-script @ref{Multi-Volume Archives}
 @set xref-info-script @xref{Multi-Volume Archives}
 @set pxref-info-script @pxref{Multi-Volume Archives}
@@ -2737,11 +2737,11 @@
 When performing operations, @command{tar} will skip files that match
 @var{pattern}.  @FIXME-xref{}
 
address@hidden address@hidden
address@hidden -X @var{file}
address@hidden address@hidden
address@hidden -X @var{file-of-patterns}
 
 Similar to @samp{--exclude}, except @command{tar} will use the list of
-patterns in the file @var{file}.  @FIXME-xref{}
+patterns in the file @var{file-of-patterns}.  @FIXME-xref{}
 
 @item address@hidden
 @itemx -f @var{archive}
@@ -2750,10 +2750,10 @@
 performs operations on, rather than @command{tar}'s compilation dependent
 default.  @FIXME-xref{}
 
address@hidden address@hidden
address@hidden -T @var{file}
address@hidden address@hidden
address@hidden -T @var{file-of-names}
 
address@hidden will use the contents of @var{file} as a list of archive members
address@hidden will use the contents of @var{file-of-names} as a list of 
archive members
 or files to operate on, in addition to those specified on the
 command-line.  @FIXME-xref{}
 
@@ -3352,10 +3352,10 @@
 it is and a copyright message, some credits, and then exit.
 @FIXME-xref{}
 
address@hidden address@hidden
address@hidden address@hidden
 
 Used in conjunction with @samp{--multi-volume}.  @command{tar} will keep track
-of which volume of a multi-volume archive its working in @var{file}.
+of which volume of a multi-volume archive its working in @var{file-of-number}.
 @FIXME-xref{}
 
 @item --wildcards
@@ -5155,15 +5155,15 @@
 incremental backup.  It has much the same effect as
 @value{op-incremental}, but also the time when the dump is done and
 the list of directories dumped is written to the given
address@hidden When restoring, only files newer than the saved time are
address@hidden When restoring, only files newer than the saved time are
 restored, and the directory list is used to speed up operations.
 
 @value{op-listed-incremental} acts like @value{op-incremental}, but when
 used in conjunction with @value{op-create} will also cause @command{tar} to
-use the file @var{file}, which contains information about the state
+use the file @var{snapshot-file}, which contains information about the state
 of the filesystem at the time of the last backup, to decide which
 files to include in the archive being created.  That file will then
-be updated by @command{tar}.  If the file @var{file} does not exist when
+be updated by @command{tar}.  If the file @var{snapshot-file} does not exist 
when
 this option is specified, @command{tar} will create it, and include all
 appropriate files in the archive.
 
@@ -5263,11 +5263,11 @@
 to use the file @var{snapshot-file}, which contains information about
 the state of the file system at the time of the last backup, to decide
 which files to include in the archive being created.  That file will
-then be updated by @command{tar}.  If the file @var{file} does not exist
+then be updated by @command{tar}.  If the file @var{snapshot-file} does not 
exist
 when this option is specified, @command{tar} will create it, and include
 all appropriate files in the archive.
 
-The file @var{file}, which is archive independent, contains the date
+The file @var{snapshot-file}, which is archive independent, contains the date
 it was last modified and a list of devices, inode numbers and
 directory names.  @command{tar} will archive files with newer mod dates
 or inode change times, and directories with an unchanged inode number
@@ -6024,9 +6024,9 @@
 the list of files to archive with the @command{find} utility.
 
 @table @kbd
address@hidden address@hidden name}
address@hidden -T @var{file name}
-Get names to extract or create from file @var{file name}.
address@hidden address@hidden
address@hidden -T @var{file-of-names}
+Get names to extract or create from file @var{file-of-names}.
 @end table
 
 If you give a single dash as a file name for @samp{--files-from}, (i.e.,
@@ -6123,15 +6123,15 @@
 You may give multiple @samp{--exclude} options.
 
 @table @kbd
address@hidden address@hidden
address@hidden -X @var{file}
address@hidden address@hidden
address@hidden -X @var{file-of-patterns}
 Causes @command{tar} to ignore files that match the patterns listed in
address@hidden
address@hidden
 @end table
 
 @findex exclude-from
 Use the @address@hidden option to read a
-list of patterns, one per line, from @var{file}; @command{tar} will
+list of patterns, one per line, from @var{file-of-patterns}; @command{tar} will
 ignore files matching those patterns.  Thus if @command{tar} is
 called as @address@hidden -c -X foo .}} and the file @file{foo} contains a
 single line @file{*.o}, no files whose names end in @file{.o} will be
@@ -8014,10 +8014,10 @@
 detect end of physical tapes.  By being slightly conservative on the
 maximum tape length, you might avoid the problem entirely.
 
address@hidden -F @var{file}
address@hidden address@hidden
address@hidden address@hidden
-Execute @file{file} at end of each tape.  If @file{file} exits with
address@hidden -F @var{script-file}
address@hidden address@hidden
address@hidden address@hidden
+Execute @var{script-file} at end of each tape.  If @var{script-file} exits with
 nonzero status, exit.  This implies @value{op-multi-volume}.
 @end table
 
@@ -8779,7 +8779,7 @@
 otherwise @command{tar} will write over the volume it just finished.)
 
 If you want more elaborate behavior than this, give @command{tar} the
address@hidden option.  The file @var{script-name} is expected
address@hidden option.  The file @var{script-file} is expected
 to be a program (or shell script) to be run instead of the normal
 prompting procedure.  If the program fails, @command{tar} exits;
 otherwise, @command{tar} begins writing the next volume.  The behavior
@@ -8881,9 +8881,9 @@
 @value{op-info-script} is like @value{op-multi-volume}, except that
 @command{tar} does not prompt you directly to change media volumes when
 a volume is full---instead, @command{tar} runs commands you have stored
-in @var{script-name}.  For example, this option can be used to eject
+in @var{script-file}.  For example, this option can be used to eject
 cassettes, or to broadcast messages such as @samp{Someone please come
-change my tape} when performing unattended backups.  When @var{script-name}
+change my tape} when performing unattended backups.  When @var{script-file}
 is done, @command{tar} will assume that the media has been changed.
 
 Multi-volume archives can be modified like any other archive.  To add
@@ -8911,8 +8911,8 @@
 archive, specify @value{op-multi-volume} in conjunction with that
 operation.
 
address@hidden address@hidden
address@hidden -F @var{program-file}
address@hidden address@hidden
address@hidden -F @var{script-file}
 Creates a multi-volume archive via a script.  Used in conjunction with
 @value{op-create}.
 @end table
------------------------------------------------------------------------------