From 8b44fe6976bc998d4f0e2aad3f16532a857e5794 Mon Sep 17 00:00:00 2001 From: Aaron Campbell Date: Fri, 4 Jun 1999 02:45:26 +0000 Subject: start to remove non-escaped trailing whitespace, it can confuse troff; pjanzen@ --- bin/pax/cpio.1 | 4 +- bin/pax/pax.1 | 173 +++++++++++++++++++++++++++------------------------------ 2 files changed, 84 insertions(+), 93 deletions(-) (limited to 'bin/pax') diff --git a/bin/pax/cpio.1 b/bin/pax/cpio.1 index 138d60730d3..df9acbe4b21 100644 --- a/bin/pax/cpio.1 +++ b/bin/pax/cpio.1 @@ -27,7 +27,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $OpenBSD: cpio.1,v 1.7 1998/12/15 01:20:24 aaron Exp $ +.\" $OpenBSD: cpio.1,v 1.8 1999/06/04 02:45:14 aaron Exp $ .\" .Dd February 16, 1997 .Dt CPIO 1 @@ -261,7 +261,7 @@ specific archive format specification. .Xr pax 1 , .Xr tar 1 .Sh BUGS -The +The .Fl s and .Fl S diff --git a/bin/pax/pax.1 b/bin/pax/pax.1 index fb5b8480f20..469cd03fa1f 100644 --- a/bin/pax/pax.1 +++ b/bin/pax/pax.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pax.1,v 1.13 1999/06/03 09:50:33 aaron Exp $ +.\" $OpenBSD: pax.1,v 1.14 1999/06/04 02:45:14 aaron Exp $ .\" $NetBSD: pax.1,v 1.3 1995/03/21 09:07:37 cgd Exp $ .\" .\" Copyright (c) 1992 Keith Muller. @@ -205,20 +205,17 @@ and .It .Em List . .Nm -will write to -.Dv standard output +will write to standard output a table of contents of the members of the archive file read from -.Dv standard input , -whose pathnames match the specified +standard input, whose pathnames match the specified .Ar patterns . The table of contents contains one filename per line and is written using single line buffering. .It Fl r .Em Read . .Nm -extracts the members of the archive file read from the -.Dv standard input , -with pathnames matching the specified +extracts the members of the archive file read from the standard input, +with pathnames matching the specified .Ar patterns . The archive format and blocking is automatically determined on input. When an extracted file is a directory, the entire file hierarchy @@ -231,16 +228,15 @@ option. .It Fl w .Em Write . .Nm -writes an archive containing the +writes an archive containing the .Ar file -operands to -.Dv standard output +operands to standard output using the specified archive format. -When no +When no .Ar file -operands are specified, a list of files to copy with one per line is read from -.Dv standard input . -When a +operands are specified, a list of files to copy with one per line is read from +standard input. +When a .Ar file operand is also a directory, the entire file hierarchy rooted at that directory will be included. @@ -251,11 +247,10 @@ copies the .Ar file operands to the destination .Ar directory . -When no +When no .Ar file operands are specified, a list of files to copy with one per line is read from -the -.Dv standard input . +the standard input. When a .Ar file operand is also a directory the entire file @@ -308,10 +303,10 @@ operand is used to select one or more pathnames of archive members. Archive members are selected using the pattern matching notation described by .Xr fnmatch 3 . -When the +When the .Ar pattern operand is not supplied, all members of the archive will be selected. -When a +When a .Ar pattern matches a directory, the entire file hierarchy rooted at that directory will be selected. @@ -321,8 +316,7 @@ operand does not select at least one archive member, .Nm will write these .Ar pattern -operands in a diagnostic message to -.Dv standard error +operands in a diagnostic message to standard error. and then exit with a non-zero exit status. .Pp The @@ -334,41 +328,36 @@ operand does not select at least one archive member, .Nm will write these .Ar file -operand pathnames in a diagnostic message to -.Dv standard error +operand pathnames in a diagnostic message to standard error and then exit with a non-zero exit status. .Sh OPTIONS The following options are supported: .Bl -tag -width 4n .It Fl r -Read an archive file from -.Dv standard input +Read an archive file from standard input and extract the specified .Ar files . If any intermediate directories are needed in order to extract an archive member, these directories will be created as if .Xr mkdir 2 was called with the bitwise inclusive -.Dv OR +.Tn OR of .Dv S_IRWXU , S_IRWXG , and -.Dv S_IRWXO +.Dv S_IRWXO as the mode argument. When the selected archive format supports the specification of linked files and these files cannot be linked while the archive is being extracted, .Nm -will write a diagnostic message to -.Dv standard error +will write a diagnostic message to standard error and exit with a non-zero exit status at the completion of operation. .It Fl w -Write files to the -.Dv standard output +Write files to the standard input in the specified archive format. When no .Ar file -operands are specified, -.Dv standard input +operands are specified, standard input is read for a list of pathnames with one per line without any leading or trailing .Aq blanks . @@ -380,7 +369,7 @@ If an archive format is not specified with a .Fl x option, the format currently being used in the archive will be selected. Any attempt to append to an archive in a format different from the -format already used in the archive will cause +format already used in the archive will cause .Nm to exit immediately with a non-zero exit status. @@ -421,7 +410,7 @@ can be separated by to indicate a product. A specific archive device may impose additional restrictions on the size of blocking it will support. -When blocking is not specified, the default +When blocking is not specified, the default .Ar blocksize is dependent on the specific archive format being used (see the .Fl x @@ -442,13 +431,11 @@ member and not the file hierarchy rooted at the directory. Specify .Ar archive as the pathname of the input or output archive, overriding the default -.Dv standard input -(for +standard input (for .Em list and .Em read ) -or -.Dv standard output +or standard output (for .Em write ) . A single archive may span multiple files and different archive devices. @@ -475,8 +462,8 @@ If this line consists of a single period, the file or archive member is processed with no modification to its name. Otherwise, its name is replaced with the contents of the line. .Nm -will immediately exit with a non-zero exit status if -.Dv +will immediately exit with a non-zero exit status if +.Dv EOF is encountered when reading a response or if .Pa /dev/tty cannot be opened for reading and writing. @@ -500,7 +487,7 @@ No more than one archive member is matched for each .Ar pattern . When members of type directory are matched, the file hierarchy rooted at that directory is also matched (unless -.Fl d +.Fl d is also specified). .It Fl o Ar options Information to modify the algorithm for extracting or writing archive files @@ -522,7 +509,7 @@ and .Cm p . Multiple characteristics can be concatenated within the same string and multiple -.Fl p +.Fl p options can be specified. The meaning of the specification characters are as follows: .Bl -tag -width 2n @@ -537,10 +524,10 @@ This is intended to be used by .Em root , someone with all the appropriate privileges, in order to preserve all aspects of the files as they are recorded in the archive. -The +The .Cm e flag is the sum of the -.Cm o +.Cm o and .Cm p flags. @@ -553,7 +540,7 @@ Preserve the user ID and group ID. .Sq Preserve the file mode bits. This intended to be used by a -.Em user +.Em user with regular privileges who wants to preserve all aspects of the file other than the ownership. The file times are preserved by default, but two other flags are offered to @@ -567,7 +554,7 @@ extracted file, subject to the permissions of the invoking process. Otherwise the attribute of the extracted file is determined as part of the normal file creation action. -If neither the +If neither the .Cm e nor the .Cm o @@ -575,7 +562,7 @@ specification character is specified, or the user ID and group ID are not preserved for any reason, .Nm will not set the -.Dv S_ISUID +.Dv S_ISUID .Em ( setuid ) and .Dv S_ISGID @@ -583,8 +570,7 @@ and bits of the file mode. If the preservation of any of these items fails for any reason, .Nm -will write a diagnostic message to -.Dv standard error . +will write a diagnostic message to standard error. Failure to preserve these items will affect the final exit status, but will not cause the extracted file to be deleted. If the file characteristic letters in any of the string option-arguments are @@ -610,14 +596,21 @@ As in .Cm old is a basic regular expression and .Cm new -can contain an ampersand (&), \\n (where n is a digit) back-references, +can contain an ampersand +.Pq Ql & , +.Ql \en +(where +.Ar n +is a digit) back-references, or subexpression matching. The .Cm old -string may also contain -.Dv -characters. -Any non-null character can be used as a delimiter (/ is shown here). +string may also contain newline characters. +Any non-null character can be used as a delimiter +.Po +.Ql / +is shown here +.Pc . Multiple .Fl s expressions can be specified. @@ -633,8 +626,7 @@ option. The optional trailing .Cm p will cause the final result of a successful substitution to be written to -.Dv standard error -in the following format: +standard error in the following format: .Dl >> File or archive member names that substitute to the empty string are not selected and will be skipped. @@ -672,7 +664,7 @@ the output has the format: .Dl == For pathnames representing a symbolic link, the output has the format: .Dl => -Where is the output format specified by the +Where is the output format specified by the .Xr ls 1 utility when used with the .Fl l @@ -680,15 +672,12 @@ option. Otherwise for all the other operational modes .Po Em read , write , Li and Em copy .Pc , -pathnames are written and flushed to -.Dv standard error -without a trailing -.Dv +pathnames are written and flushed to standard error +without a trailing newline as soon as processing begins on that file or archive member. -The trailing -.Dv , -is not buffered, and is written only after the file has been read or written. +The trailing newline +is not buffered and is written only after the file has been read or written. .It Fl x Ar format Specify the output archive format, with the default format being .Ar ustar . @@ -761,7 +750,7 @@ file. .It Fl z Use .Xr gzip 1 -to compress (decompress) the archive while writing (reading). +to compress (decompress) the archive while writing (reading). Incompatible with .Fl a . .It Fl B Ar bytes @@ -784,7 +773,7 @@ to indicate a product. .Em Warning : Only use this option when writing an archive to a device which supports an end of file read condition based on last (or largest) write offset -(such as a regular file or a tape drive). +(such as a regular file or a tape drive). The use of this option with a floppy or hard disk is not recommended. .It Fl D This option is the same as the @@ -815,11 +804,11 @@ of will cause .Nm to attempt to recover from read errors forever. -The default +The default .Ar limit is a small positive number of retries. .Pp -.Em Warning: +.Em Warning: Using this option with .Li NONE should be used with extreme caution as @@ -831,9 +820,11 @@ Select a file based on its name, or when starting with a .Cm # , a numeric gid. -A '\\' can be used to escape the +A +.Ql \e +can be used to escape the .Cm # . -Multiple +Multiple .Fl G options may be supplied and checking stops with the first match. .It Fl H @@ -846,12 +837,12 @@ Do not follow symbolic links, perform a physical file system traversal. This is the default mode. .It Fl T Ar [from_date][,to_date][/[c][m]] Allow files to be selected based on a file modification or inode change -time falling within a specified time range of +time falling within a specified time range of .Ar from_date to .Ar to_date (the dates are inclusive). -If only a +If only a .Ar from_date is supplied, all files with a modification or inode change time equal to or younger are selected. @@ -859,7 +850,7 @@ If only a .Ar to_date is supplied, all files with a modification or inode change time equal to or older will be selected. -When the +When the .Ar from_date is equal to the .Ar to_date , @@ -868,7 +859,7 @@ time will be selected. .Pp When .Nm -is in the +is in the .Em write or .Em copy @@ -885,7 +876,7 @@ The .Ar c specifies the comparison of inode change time (the time when the file inode was last changed; e.g. a change of owner, group, mode, etc). -When +When .Ar c and .Ar m @@ -926,14 +917,14 @@ The minute field is required, while the other fields are optional and must be added in the following order: .Dl Cm hh , dd , mm , yy . -The +The .Cm ss field may be added independently of the other fields. Time ranges are relative to the current time, so .Dl Fl T Ar 1234/cm would select all files with a modification or inode change time of 12:34 PM today or later. -Multiple +Multiple .Fl T time range can be supplied and checking stops with the first match. .It Fl U Ar user @@ -942,16 +933,18 @@ Select a file based on its name, or when starting with a .Cm # , a numeric UID. -A '\\' can be used to escape the +A +.Ql \e +can be used to escape the .Cm # . -Multiple +Multiple .Fl U options may be supplied and checking stops with the first match. .It Fl X When traversing the file hierarchy specified by a pathname, do not descend into directories that have a different device ID. See the -.Li st_dev +.Li st_dev field as described in .Xr stat 2 for more information about device IDs. @@ -1007,7 +1000,7 @@ Then the and .Fl Z options will be applied based on the final pathname. -Finally, the +Finally, the .Fl v option will write the names resulting from these modifications. .Pp @@ -1023,13 +1016,13 @@ based only on the user specified pathnames as modified by the .Fl D , .Fl G , .Fl T , -and +and .Fl U options (the .Fl D option only applies during a copy operation). Then any -.Fl s +.Fl s and .Fl i options will modify in that order, the names of these selected files. @@ -1074,7 +1067,7 @@ directory hierarchy to .Pp The command: .Dl pax -r -s ',^//*usr//*,,' -f a.pax -reads the archive +reads the archive .Pa a.pax , with all files rooted in .Pa /usr @@ -1145,7 +1138,7 @@ will exit with one of the following values: .Bl -tag -width 2n .It 0 All files were processed successfully. -.It 1 +.It 1 An error occurred. .El .Pp @@ -1155,8 +1148,7 @@ cannot create a file or a link when reading an archive or cannot find a file when writing an archive, or cannot preserve the user ID, group ID, or file mode when the .Fl p -option is specified, a diagnostic message is written to -.Dv standard error +option is specified, a diagnostic message is written to standard error and a non-zero exit status will be returned, but processing will continue. In the case where .Nm @@ -1181,8 +1173,7 @@ If while doing a .Em copy , .Nm detects a file is about to overwrite itself, the file is not copied, -a diagnostic message is written to -.Dv standard error +a diagnostic message is written to standard error and when .Nm completes it will exit with a non-zero exit status. -- cgit v1.2.3