]> Dogcows Code - chaz/tar/blobdiff - doc/tar.texi
The actual default for exclude patterns is --no-anchored. Fixed.
[chaz/tar] / doc / tar.texi
index 065f4ee84a6a21e756006f8b64823990705d633a..7e052981db8a05ef94e4fa7d4fa8835e4acbbb51 100644 (file)
 @set xref-owner @xref{Option Summary}
 @set pxref-owner @pxref{Option Summary}
 
-@set op-format @kbd{--format}
+@set op-format @kbd{--format} (@kbd{-H})
 @set ref-format @ref{format}
 @set xref-format @xref{format}
 @set pxref-format @pxref{format}
 @set xref-remove-files @xref{Writing}
 @set pxref-remove-files @pxref{Writing}
 
+@set op-rmt-command @kbd{rmt-command=@var{command}}
 @set op-rsh-command @kbd{rsh-command=@var{command}}
 
 @set op-same-order @kbd{--same-order} (@kbd{--preserve-order}, @kbd{-s})
 @set xref-starting-file @xref{Scarce}
 @set pxref-starting-file @pxref{Scarce}
 
-@set op-strip-path @kbd{--strip-path
-@set ref-strip-path @ref{--strip-path}
-@set xref-strip-path @xref{--strip-path}
-@set pxref-strip-path @pxref{--strip-path}
+@set op-strip-components @kbd{--strip-components
+@set ref-strip-components @ref{--strip-components}
+@set xref-strip-components @xref{--strip-components}
+@set pxref-strip-components @pxref{--strip-components}
 
 @set op-suffix @kbd{--suffix=@var{suffix}}
 @set ref-suffix @ref{Backup options}
@@ -1104,8 +1105,9 @@ thing.}
 For version 1.12, Daniel Hagerty contributed a great deal of technical
 consulting.  In particular, he is the primary author of @ref{Backups}.
 
-In July, 2003 @GNUTAR{} was put on CVS at @url{savannah.gnu.org}, and
-an active development and maintenance work has started
+In July, 2003 @GNUTAR{} was put on CVS at savannah.gnu.org
+(see @url{http://savannah.gnu.org/projects/tar}), and
+active development and maintenance work has started
 again. Currently @GNUTAR{} is being maintained by Paul Eggert, Sergey
 Poznyakoff and Jeff Bailey.
 
@@ -2027,8 +2029,8 @@ $ @kbd{tar -xvf ../untrusted.tar}
 @end smallexample
 
 It is also a good practice to examine contents of the archive
-before extracting it, using @option{op-list} option, possibly combined
-with @option{op-verbose}.
+before extracting it, using @value{op-list} option, possibly combined
+with @value{op-verbose}.
 
 @node failing commands
 @subsection Commands That Will Fail
@@ -3206,6 +3208,11 @@ from the archive.  @xref{Writing}.
 Directs @command{tar} to remove the source file from the file system after
 appending it to an archive.  @FIXME-xref{}
 
+@item --rmt-command=@var{cmd}
+
+Notifies @command{tar} that it should use @var{cmd} instead of
+the default @file{/usr/libexec/rmt} (@pxref{Remote Tape Server}).
+
 @item --rsh-command=@var{cmd}
 
 Notifies @command{tar} that is should use @var{cmd} to communicate with remote
@@ -3260,13 +3267,14 @@ This option affects extraction only; @command{tar} will skip extracting
 files in the archive until it finds one that matches @var{name}.
 @xref{Scarce}.
 
-@item --strip-path=@var{number}
+@item --strip-components=@var{number}
 Strip given @var{number} of leading components from file names before
-extraction. For example, if archive @file{archive.tar} contained
+extraction.@footnote{This option was called @option{--strip-path} in
+version 1.14.} For example, if archive @file{archive.tar} contained
 @file{/some/file/name}, then running
 
 @smallexample
-tar --extract --file archive.tar --strip-path=2
+tar --extract --file archive.tar --strip-components=2
 @end smallexample
 
 @noindent
@@ -3686,8 +3694,8 @@ The @value{op-totals} option---which is only meaningful when used with
 amount written to the archive, after it has been fully created.
 
 The @value{op-checkpoint} option prints an occasional message
-as @command{tar} reads or writes the archive.  In fact, it print
-directory names while reading the archive.  It is designed for
+as @command{tar} reads or writes the archive. In fact, it prints
+a message each 10 records read or written. It is designed for
 those who don't need the more detailed (and voluminous) output of
 @value{op-block-number}, but do want visual confirmation that @command{tar}
 is actually making forward progress.
@@ -4573,7 +4581,7 @@ renamed the whole hierarchy from @file{/usr/local2} to
 not be welcome at all that @GNUTAR{} removes the
 whole hierarchy just to make room for the link to be reinstated
 (unless it @emph{also} simultaneously restores the full
-@file{/usr/local2}, of course!  @GNUTAR{} is indeed
+@file{/usr/local2}, of course!)  @GNUTAR{} is indeed
 able to remove a whole hierarchy to reestablish a symbolic link, for
 example, but @emph{only if} @value{op-recursive-unlink} is specified
 to allow this behavior.  In any case, single files are silently
@@ -5038,7 +5046,7 @@ distribution.
 
 @end ifclear
 
-This chapter documents both the provided FSF scripts and @command{tar}
+This chapter documents both the provided shell scripts and @command{tar}
 options which are more specific to usage as a backup tool.
 
 To @dfn{back up} a file system means to create archives that contain
@@ -5464,7 +5472,7 @@ located on the remote machine and containing the list of files to
 be excluded from the backup. Exclude file lists are searched in
 /etc/tar-backup directory. A common use for exclude file lists
 is to exclude files containing security-sensitive information
-(e.g. @file{/etc/shadow} from backups.
+(e.g. @file{/etc/shadow} from backups).
 
 This variable affects only @code{backup}.
 @end defvr
@@ -5518,7 +5526,7 @@ mt_begin() @{
 @end defvr
 
 @defvr {Backup variable} MT_REWIND
-THe name of @dfn{rewind} function. The default definition is as
+The name of @dfn{rewind} function. The default definition is as
 follows:
 
 @smallexample
@@ -5561,14 +5569,14 @@ mt_status() @{
 @subsection User Hooks
 
 @dfn{User hooks} are shell functions executed before and after
-each @command{tar} invocations. Thus, there are @dfn{backup 
+each @command{tar} invocation. Thus, there are @dfn{backup 
 hooks}, which are executed before and after dumping each file
 system, and @dfn{restore hooks}, executed before and
 after restoring a file system. Each user hook is a shell function
 taking four arguments:
 
 @deffn {User Hook Function} hook @var{level} @var{host} @var{fs} @var{fsname}
-The arguments are:
+Its arguments are:
 
 @table @var
 @item level
@@ -5607,7 +5615,7 @@ Executed after restoring the filesystem.
 @node backup-specs example
 @subsection An Example Text of @file{Backup-specs}
 
-The following is the text of @file{backup-specs} as it appears at FSF:
+The following is an example of @file{backup-specs}:
 
 @smallexample
 # site-specific parameters for file system backup.
@@ -5709,8 +5717,8 @@ and files dumped, what time the backup was made, and any error
 messages that were generated, as well as how much space was left in
 the media volume after the last volume of the archive was written.
 You should check this log file after every backup.  The file name is
-@file{log-@var{mmm-ddd-yyyy}-level-@var{n}}, where @var{n} represents
-current dump level number.
+@file{log-@var{mm-dd-yyyy}-level-@var{n}}, where @var{mm-dd-yyyy}
+represents current date, and @var{n} represents current dump level number.
 
 The script also prints the name of each system being dumped to the
 standard output.
@@ -5727,7 +5735,7 @@ Do backup level @var{level} (default 0).
 @itemx --force
 Force backup even if today's log file already exists.
 
-@item -v@var{level}
+@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}
@@ -5798,7 +5806,7 @@ The full list of options accepted by @code{restore} follows:
 @itemx --level=@var{level}
 Start restoring from the given backup level, instead of the default 0.
 
-@item -v@var{level}
+@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}
@@ -5950,8 +5958,11 @@ program, with a username of @var{user}.  If the username is omitted
 (along with the @samp{@@} sign), then your user name will be used.
 (This is the normal @command{rsh} behavior.)  It is necessary for the
 remote machine, in addition to permitting your @command{rsh} access, to
-have the @file{/usr/ucb/rmt} program installed.  If you need to use a
-file whose name includes a colon, then the remote tape drive behavior
+have the @file{rmt} program installed (This command is included in
+the @GNUTAR{} distribution and by default is installed under
+@file{@var{prefix}/libexec/rmt}, were @var{prefix} means your
+installation prefix). If you need to use a file whose name includes a
+colon, then the remote tape drive behavior
 can be inhibited by using the @value{op-force-local} option.
 
 @FIXME{i know we went over this yesterday, but bob (and now i do again,
@@ -6160,8 +6171,9 @@ ignores case when excluding @samp{makefile}, but not when excluding
 @table @option
 @item --anchored
 @itemx --no-anchored
-If anchored (the default), a pattern must match an initial subsequence
-of the name's components.  Otherwise, the pattern can match any subsequence.
+If anchored, a pattern must match an initial subsequence
+of the name's components. Otherwise, the pattern can match any
+subsequence. Default is @option{--no-anchored}.
 
 @item --ignore-case
 @itemx --no-ignore-case
@@ -7165,7 +7177,7 @@ To use the older, obsolete, @command{compress} program, use the
 uses.  You could be sued for patent infringement merely by running
 @command{compress}.
 
-I have one question, or maybe it's a suggestion if there isn't a way
+@FIXME{I have one question, or maybe it's a suggestion if there isn't a way
 to do it now. I would like to use @value{op-gzip}, but I'd also like
 the output to be fed through a program like @acronym{GNU}
 @command{ecc} (actually, right now that's @samp{exactly} what I'd like
@@ -7197,7 +7209,7 @@ extraction is needed rather than creation.
 It has been reported that if one writes compressed data (through the
 @value{op-gzip} or @value{op-compress} options) to a DLT and tries to use
 the DLT compression mode, the data will actually get bigger and one will
-end up with less space on the tape.
+end up with less space on the tape.}
 
 @node sparse
 @subsection Archiving Sparse Files
@@ -7918,12 +7930,19 @@ If the file name contains a @samp{:}, it is interpreted as
 @samp{hostname:file name}.  If the @var{hostname} contains an @dfn{at}
 sign (@kbd{@@}), it is treated as @samp{user@@hostname:file name}.  In
 either case, @command{tar} will invoke the command @command{rsh} (or
-@command{remsh}) to start up an @file{/etc/rmt} on the remote machine.  If
-you give an alternate login name, it will be given to the @command{rsh}.
-Naturally, the remote machine must have an executable @file{/etc/rmt}.
-This program is free software from the University of California, and a
-copy of the source code can be found with the sources for @command{tar};
-it's compiled and installed by default.
+@command{remsh}) to start up an @command{/usr/libexec/rmt} on the remote
+machine. If you give an alternate login name, it will be given to the
+@command{rsh}.
+Naturally, the remote machine must have an executable
+@command{/usr/libexec/rmt}. This program is free software from the
+University of California, and a copy of the source code can be found
+with the sources for @command{tar}; it's compiled and installed by default.
+The exact path to this utility is determined when configuring the package.
+It is @file{@var{prefix}/libexec/rmt}, where @var{prefix} stands for
+your installation prefix. This location may also be overridden at
+runtime by using @value{op-rmt-command} option (@xref{Option Summary,
+---rmt-command}, for detailed description of this option. @xref{Remote
+Tape Server}, for the description of @command{rmt} command).
 
 If this option is not given, but the environment variable @env{TAPE}
 is set, its value is used; otherwise, old versions of @command{tar}
@@ -8009,15 +8028,16 @@ nonzero status, exit.  This implies @value{op-multi-volume}.
 @pindex rmt
 In order to access the tape drive on a remote machine, @command{tar}
 uses the remote tape server written at the University of California at
-Berkeley.  The remote tape server must be installed as @file{/etc/rmt}
-on any machine whose tape drive you want to use.  @command{tar} calls
-@file{/etc/rmt} by running an @command{rsh} or @command{remsh} to the remote
-machine, optionally using a different login name if one is supplied.
+Berkeley.  The remote tape server must be installed as
+@file{@var{prefix}/libexec/rmt} on any machine whose tape drive you
+want to use.  @command{tar} calls @command{rmt} by running an
+@command{rsh} or @command{remsh} to the remote machine, optionally
+using a different login name if one is supplied.
 
 A copy of the source for the remote tape server is provided.  It is
 Copyright @copyright{} 1983 by the Regents of the University of
-California, but can be freely distributed.  Instructions for compiling
-and installing it are included in the @file{Makefile}.
+California, but can be freely distributed. It is compiled and
+installed by default.
 
 @cindex absolute file names
 Unless you use the @value{op-absolute-names} option, @GNUTAR{}
This page took 0.037376 seconds and 4 git commands to generate.