In tar's info document a few options (--seek, -transform, --quote*)
are not in their alphabetical place. Attached patch fixes this.
The second patch removes a "used to" that could be misread as
"obsolete", corrects a "has" to "have", and makes several other
small consistency tweaks.
Benno
diff -ur cvs-tar/doc/tar.texi tar-new/doc/tar.texi
--- cvs-tar/doc/tar.texi 2007-05-08 19:49:55.000000000 +0200
+++ tar-new/doc/tar.texi 2007-05-08 21:45:05.000000000 +0200
@@ -2740,15 +2740,6 @@
(see --info-script)
[EMAIL PROTECTED]
[EMAIL PROTECTED] --seek
[EMAIL PROTECTED] -n
-
-Assume that the archive media supports seeks to arbitrary
-locations. Usually @command{tar} determines automatically whether
-the archive can be seeked or not. This option is intended for use
-in cases when such recognition fails.
-
@opsummary{newer}
@item [EMAIL PROTECTED]
@itemx [EMAIL PROTECTED]
@@ -2919,39 +2910,6 @@
This option does not affect extraction from archives.
[EMAIL PROTECTED]
[EMAIL PROTECTED] [EMAIL PROTECTED]
-
-Transform file or member names using @command{sed} replacement expression
[EMAIL PROTECTED] For example,
-
[EMAIL PROTECTED]
-$ @kbd{tar cf archive.tar --transform 's,^\./,usr/,' .}
[EMAIL PROTECTED] smallexample
-
[EMAIL PROTECTED]
-will add to @file{archive} files from the current working directory,
-replacing initial @samp{./} prefix with @samp{usr/}. For the detailed
-discussion, @xref{transform}.
-
-To see transformed member names in verbose listings, use
[EMAIL PROTECTED] option
-(@pxref{show-transformed-names}).
-
[EMAIL PROTECTED]
[EMAIL PROTECTED] [EMAIL PROTECTED]
-Always quote characters from @var{string}, even if the selected
-quoting style would not quote them (@pxref{quoting styles}).
-
[EMAIL PROTECTED]
[EMAIL PROTECTED] [EMAIL PROTECTED]
-Set quoting style to use when printing member and file names
-(@pxref{quoting styles}). Valid @var{style} values are:
[EMAIL PROTECTED], @code{shell}, @code{shell-always}, @code{c},
[EMAIL PROTECTED], @code{locale}, and @code{clocale}. Default quoting
-style is @code{escape}, unless overridden while configuring the
-package.
-
@opsummary{pax-option}
@item [EMAIL PROTECTED]
This option is meaningful only with @acronym{POSIX.1-2001} archives
@@ -2992,6 +2950,20 @@
Specifying this option instructs @command{tar} that it should use the
permissions directly from the archive. @xref{Setting Access Permissions}.
[EMAIL PROTECTED]
[EMAIL PROTECTED] [EMAIL PROTECTED]
+Always quote characters from @var{string}, even if the selected
+quoting style would not quote them (@pxref{quoting styles}).
+
[EMAIL PROTECTED]
[EMAIL PROTECTED] [EMAIL PROTECTED]
+Set quoting style to use when printing member and file names
+(@pxref{quoting styles}). Valid @var{style} values are:
[EMAIL PROTECTED], @code{shell}, @code{shell-always}, @code{c},
[EMAIL PROTECTED], @code{locale}, and @code{clocale}. Default quoting
+style is @code{escape}, unless overridden while configuring the
+package.
+
@opsummary{read-full-records}
@item --read-full-records
@itemx -B
@@ -3066,6 +3038,15 @@
(See @option{--preserve-permissions}; @pxref{Setting Access Permissions}.)
[EMAIL PROTECTED]
[EMAIL PROTECTED] --seek
[EMAIL PROTECTED] -n
+
+Assume that the archive media supports seeks to arbitrary
+locations. Usually @command{tar} determines automatically whether
+the archive can be seeked or not. This option is intended for use
+in cases when such recognition fails.
+
@opsummary{show-defaults}
@item --show-defaults
@@ -3180,6 +3161,25 @@
rather than the data modification time stored in the archive.
@xref{Data Modification Times}.
[EMAIL PROTECTED]
[EMAIL PROTECTED] [EMAIL PROTECTED]
+
+Transform file or member names using @command{sed} replacement expression
[EMAIL PROTECTED] For example,
+
[EMAIL PROTECTED]
+$ @kbd{tar cf archive.tar --transform 's,^\./,usr/,' .}
[EMAIL PROTECTED] smallexample
+
[EMAIL PROTECTED]
+will add to @file{archive} files from the current working directory,
+replacing initial @samp{./} prefix with @samp{usr/}. For the detailed
+discussion, @xref{transform}.
+
+To see transformed member names in verbose listings, use
[EMAIL PROTECTED] option
+(@pxref{show-transformed-names}).
+
@opsummary{uncompress}
@item --uncompress
diff -ur cvs-tar/doc/tar.texi tar-new/doc/tar.texi
--- cvs-tar/doc/tar.texi 2007-05-08 19:49:55.000000000 +0200
+++ tar-new/doc/tar.texi 2007-05-08 21:57:01.000000000 +0200
@@ -2558,7 +2558,7 @@
@opsummary{force-local}
@item --force-local
-Forces @command{tar} to interpret the filename given to @option{--file}
+Forces @command{tar} to interpret the file name given to @option{--file}
as a local file, even if it looks like a remote tape drive name.
@xref{local and remote archives}.
@@ -2595,7 +2595,7 @@
@opsummary{group}
@item [EMAIL PROTECTED]
-Files added to the @command{tar} archive will have a group id of @var{group},
+Files added to the @command{tar} archive will have a group ID of @var{group},
rather than the group from the source file. @var{group} is first decoded
as a group symbolic name, but if this interpretation fails, it has to be
a decimal numeric group ID. @xref{override}.
@@ -2647,7 +2647,7 @@
@item --incremental
@itemx -G
-Used to inform @command{tar} that it is working with an old
+Informs @command{tar} that it is working with an old
@acronym{GNU}-format incremental backup archive. It is intended
primarily for backwards compatibility only. @xref{Incremental Dumps},
for a detailed discussion of incremental archives.
@@ -2775,9 +2775,10 @@
@opsummary{no-delay-directory-restore}
@item --no-delay-directory-restore
-Setting modification times and permissions of extracted
-directories when all files from this directory has been
-extracted. This is the default. @xref{Directory Modification Times and Permissions}.
+Modification times and permissions of extracted
+directories are set when all files from this directory have been
+extracted. This is the default.
[EMAIL PROTECTED] Modification Times and Permissions}.
@opsummary{no-ignore-case}
@item --no-ignore-case
@@ -2786,7 +2787,7 @@
@opsummary{no-ignore-command-error}
@item --no-ignore-command-error
-Print warnings about subprocesses terminated with a non-zero exit
+Print warnings about subprocesses that terminated with a nonzero exit
code. @xref{Writing to an External Program}.
@opsummary{no-overwrite-dir}
@@ -2841,7 +2842,7 @@
@item --null
When @command{tar} is using the @option{--files-from} option, this option
-instructs @command{tar} to expect filenames terminated with @option{NUL}, so
+instructs @command{tar} to expect file names terminated with @option{NUL}, so
@command{tar} can correctly work with file names that contain newlines.
@xref{nul}.
@@ -3008,7 +3009,7 @@
@opsummary{recursion}
@item --recursion
-With this option, @command{tar} recurses into directories.
+With this option, @command{tar} recurses into directories (default).
@xref{recurse}.
@opsummary{recursive-unlink}
@@ -3082,7 +3083,7 @@
@opsummary{show-omitted-dirs}
@item --show-omitted-dirs
-Instructs @command{tar} to mention directories its skipping over when
+Instructs @command{tar} to mention the directories it is skipping when
operating on a @command{tar} archive. @xref{show-omitted-dirs}.
@opsummary{show-transformed-names}
@@ -3092,8 +3093,8 @@
Display file or member names after applying any transformations
(@pxref{transform}). In particular, when used in conjunction with one of
-archive creation operations it instructs tar to list the member names
-stored in the archive, as opposed to the actual file
+the archive creation operations it instructs @command{tar} to list the
+member names stored in the archive, as opposed to the actual file
names. @xref{listing member and file names}.
@opsummary{sparse}
@@ -3106,7 +3107,7 @@
@opsummary{sparse-version}
@item [EMAIL PROTECTED]
-Specified the @dfn{format version} to use when archiving sparse
+Specifies the @dfn{format version} to use when archiving sparse
files. Implies @option{--sparse}. @xref{sparse}. For the description
of the supported sparse formats, @xref{Sparse Formats}.
@@ -3122,7 +3123,7 @@
@item [EMAIL PROTECTED]
Strip given @var{number} of leading components from file names before
[EMAIL PROTECTED] option was called @option{--strip-path} in
-version 1.14.} For example, if archive @file{archive.tar} contained
+version 1.14.} For example, if archive @file{archive.tar} contained
@file{/some/file/name}, then running
@smallexample
@@ -3218,7 +3219,7 @@
@item --verbose
@itemx -v
-Specifies that @command{tar} should be more verbose about the operations its
+Specifies that @command{tar} should be more verbose about the operations it's
performing. This option can be specified multiple times for some
operations to increase the amount of information displayed.
@xref{verbose}.
@@ -3241,7 +3242,7 @@
@item [EMAIL PROTECTED]
Used in conjunction with @option{--multi-volume}. @command{tar} will
-keep track of which volume of a multi-volume archive its working in
+keep track of which volume of a multi-volume archive it's working in in
@var{file}. @xref{volno-file}.
@opsummary{wildcards}
@@ -3328,7 +3329,7 @@
@ref{--portability}.
The later usage is deprecated. It is retained for compatibility with
-the earlier versions of @GNUTAR{}. In the future releases
+the earlier versions of @GNUTAR{}. In future releases
@option{-o} will be equivalent to @option{--no-same-owner} only.
@item -p @tab @ref{--preserve-permissions}.
@@ -4407,7 +4408,7 @@
@item [EMAIL PROTECTED]
@opindex group
-Files added to the @command{tar} archive will have a group id of @var{group},
+Files added to the @command{tar} archive will have a group ID of @var{group},
rather than the group from the source file. The argument @var{group}
can be either an existing group symbolic name, or a decimal numeric group ID.
@end table
@@ -7807,7 +7808,7 @@
This format has traditionally been used by Automake when producing
Makefiles. This practice will change in the future, in the meantime,
-however this means that projects containing filenames more than 99
+however, this means that projects containing file names more than 99
characters long will not be able to use @GNUTAR{} @value{VERSION} and
Automake prior to 1.9.
@@ -7818,8 +7819,8 @@
@enumerate
@item The maximum length of a file name is limited to 256 characters,
-provided that the filename can be split at directory separator in
-two parts, first of them being at most 155 bytes long. So, in most
+provided that the file name can be split at a directory separator in
+two parts, the first of them being at most 155 bytes long. So, in most
cases the maximum file name length will be shorter than 256
characters.
@item The maximum length of a symbolic link name is limited to
@@ -7838,7 +7839,7 @@
@item posix
Archive format defined by @acronym{POSIX.1-2001} specification. This is the
most flexible and feature-rich format. It does not impose any
-restrictions on file sizes or filename lengths. This format is quite
+restrictions on file sizes or file name lengths. This format is quite
recent, so not all tar implementations are able to handle it properly.
However, this format is designed in such a way that any tar
implementation able to read @samp{ustar} archives will be able to read
@@ -8254,11 +8255,11 @@
they occupy. Also, the @code{suid} or @code{sgid} attributes of
files are easily and silently lost when files are given away.
-When writing an archive, @command{tar} writes the user id and user name
-separately. If it can't find a user name (because the user id is not
+When writing an archive, @command{tar} writes the user ID and user name
+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
[EMAIL PROTECTED]/etc/passwd}. If it fails, then it uses the user id stored in
[EMAIL PROTECTED]/etc/passwd}. If it fails, then it uses the user ID stored in
the archive instead.
@opindex no-same-owner
@@ -8274,7 +8275,7 @@
without user/group name information or such information to be ignored
when extracting. It effectively disables the generation and/or use
of user/group name information. This option forces extraction using
-the numeric ids from the archive, ignoring the names.
+the numeric IDs from the archive, ignoring the names.
This is useful in certain circumstances, when restoring a backup from
an emergency floppy with different passwd/group files for example.
@@ -8285,11 +8286,11 @@
had booted from an emergency floppy with no password file or put your
disk into another machine to do the restore.
-The numeric ids are @emph{always} saved into @command{tar} archives.
+The numeric IDs are @emph{always} saved into @command{tar} archives.
The identifying names are added at create time when provided by the
-system, unless @option{--old-archive} (@option{-o}) is used. Numeric ids could be
+system, unless @option{--old-archive} (@option{-o}) is used. Numeric IDs could be
used when moving archives between a collection of machines using
-a centralized management for attribution of numeric ids to users
+a centralized management for attribution of numeric IDs to users
and groups. This is often made through using the NIS capabilities.
When making a @command{tar} file for distribution to other sites, it
@@ -8473,8 +8474,8 @@
@command{tar} programs that follow it.
In the majority of cases, @command{tar} will be configured to create
-this format by default. This will change in the future releases, since
-we plan to make @samp{POSIX} format the default.
+this format by default. This will change in future releases, since
+we plan to make the @samp{POSIX} format the default.
To force creation a @GNUTAR{} archive, use option
@option{--format=gnu}.
@@ -8520,7 +8521,7 @@
to ignore any keywords matching the given @var{pattern} in the extended
header records. In both cases, matching is performed using the pattern
matching notation described in @acronym{POSIX 1003.2}, 3.13
-(@pxref{wildcards}). For example:
+(@pxref{wildcards}). For example:
@smallexample
--pax-option delete=security.*
@@ -8538,7 +8539,7 @@
@headitem Meta-character @tab Replaced By
@item %d @tab The directory name of the file, equivalent to the
result of the @command{dirname} utility on the translated pathname.
[EMAIL PROTECTED] %f @tab The filename of the file, equivalent to the result
[EMAIL PROTECTED] %f @tab The file name of the file, equivalent to the result
of the @command{basename} utility on the translated pathname.
@item %p @tab The process ID of the @command{tar} process.
@item %% @tab A @samp{%} character.
@@ -8671,7 +8672,7 @@
two's-complement base-256 notation to store values that do not fit
into standard @acronym{ustar} range. Such archives can generally be
read only by a @GNUTAR{} implementation. Moreover, they sometimes
-cannot be correctly restored on another hosts even by @GNUTAR{}. For
+cannot be correctly restored on another hosts even by @GNUTAR{}. For
example, using two's complement representation for negative time
stamps that assumes a signed 32-bit @code{time_t} generates archives
that are not portable to hosts with differing @code{time_t}
@@ -9375,7 +9376,7 @@
This means that the @option{--append}, @option{--concatenate}, and
@option{--delete} commands will not work on any other kind of file.
Some media simply cannot be backspaced, which means these commands and
-options will never be able to work on them. These non-backspacing
+options will never be able to work on them. These non-backspacing
media include pipes and cartridge tape drives.
Some other media can be backspaced, and @command{tar} will work on them
@@ -9757,9 +9758,8 @@
If @option{--read-full-records} is used, @command{tar}
will not panic if an attempt to read a record from the archive does
-not return a full record. Instead, @command{tar} will keep reading
-until it has obtained a full
-record.
+not return a full record. Instead, @command{tar} will keep reading
+until it has obtained a full record.
This option is turned on by default when @command{tar} is reading
an archive from standard input, or from a remote machine. This is
