summaryrefslogtreecommitdiffstats
path: root/bin
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2001-05-08 08:12:53 +0000
committerru <ru@FreeBSD.org>2001-05-08 08:12:53 +0000
commit8476412152694863a0e6cc7dda24348533cf9d4e (patch)
tree51228718aad7d5ed0656130b5f308bf60d467cd8 /bin
parentb824fbe47c8163384ff2c1dac26ce3fdeab77aca (diff)
downloadFreeBSD-src-8476412152694863a0e6cc7dda24348533cf9d4e.zip
FreeBSD-src-8476412152694863a0e6cc7dda24348533cf9d4e.tar.gz
mdoc(7) police: fix markup, rename and reorder some sections.
Diffstat (limited to 'bin')
-rw-r--r--bin/pax/cpio.182
-rw-r--r--bin/pax/tar.1100
2 files changed, 104 insertions, 78 deletions
diff --git a/bin/pax/cpio.1 b/bin/pax/cpio.1
index 9bec498..4d7e218 100644
--- a/bin/pax/cpio.1
+++ b/bin/pax/cpio.1
@@ -37,16 +37,16 @@
.Nm cpio
.Nd copy file archives in and out
.Sh SYNOPSIS
-.Nm cpio
+.Nm
.Fl o
.Op Fl aABcLvzZ
.Op Fl C Ar bytes
.Op Fl F Ar archive
.Op Fl H Ar format
.Op Fl O Ar archive
-.Ar "< name-list"
-.Op Ar "> archive"
-.Nm cpio
+.No < Ar name-list
+.Op No > Ar archive
+.Nm
.Fl i
.Op Fl bBcdfmrsStuvzZ6
.Op Fl C Ar bytes
@@ -54,13 +54,13 @@
.Op Fl F Ar archive
.Op Fl H Ar format
.Op Fl I Ar archive
-.Op Ar "pattern ..."
-.Op Ar "< archive"
-.Nm cpio
+.Op Ar pattern ...
+.Op No < Ar archive
+.Nm
.Fl p
.Op Fl adlLmuv
.Ar destination-directory
-.Ar "< name-list"
+.No < Ar name-list
.Sh DESCRIPTION
The
.Nm
@@ -69,13 +69,13 @@ command copies files to and from a
archive.
.Pp
The options are as follows:
-.Bl -tag -width Ds
+.Bl -tag -width indent
.It Fl o
Create an archive.
Reads the list of files to store in the
archive from standard input, and writes the archive on standard
output.
-.Bl -tag -width Ds
+.Bl -tag -width indent
.It Fl a
Reset the access times on files that have been copied to the
archive.
@@ -84,7 +84,9 @@ Append to the specified archive.
.It Fl B
Set block size of output to 5120 bytes.
.It Fl c
-Use ASCII format for
+Use
+.Tn ASCII
+format for
.Nm
header for portability.
.It Fl C Ar bytes
@@ -98,22 +100,24 @@ Write the archive in the specified format.
Recognized formats are:
.Pp
.Bl -tag -width sv4cpio -compact
-.It Ar bcpio
+.It Cm bcpio
Old binary
.Nm
format.
-.It Ar cpio
+.It Cm cpio
Old octal character
.Nm
format.
-.It Ar sv4cpio
-SVR4 hex
+.It Cm sv4cpio
+.Tn SVR4
+hex
.Nm
format.
-.It Ar tar
+.It Cm tar
Old tar format.
-.It Ar ustar
-POSIX ustar format.
+.It Cm ustar
+.Tn POSIX
+ustar format.
.El
.It Fl L
Follow symbolic links.
@@ -135,7 +139,7 @@ Reads the archive file from
standard input and extracts files matching the
.Ar patterns
that were specified on the command line.
-.Bl -tag -width Ds
+.Bl -tag -width indent
.It Fl b
Do byte and word swapping after reading in data from the
archive, for restoring archives created on systems with
@@ -143,7 +147,9 @@ a different byte order.
.It Fl B
Set the block size of the archive being read to 5120 bytes.
.It Fl c
-Expect the archive headers to be in ASCII format.
+Expect the archive headers to be in
+.Tn ASCII
+format.
.It Fl C Ar bytes
Read archive written with a block size of
.Ar bytes .
@@ -157,30 +163,31 @@ Read list of file name patterns to extract or list from
Restore all files except those matching the
.Ar patterns
given on the command line.
-.It Fl F Ar archive
-.It Fl I Ar archive
+.It Fl F Ar archive , Fl I Ar archive
Use the specified file as the input for the archive.
.It Fl H Ar format
Read an archive of the specified format.
Recognized formats are:
.Pp
.Bl -tag -width sv4cpio -compact
-.It Ar bcpio
+.It Cm bcpio
Old binary
.Nm
format.
-.It Ar cpio
+.It Cm cpio
Old octal character
.Nm
format.
-.It Ar sv4cpio
-SVR4 hex
+.It Cm sv4cpio
+.Tn SVR4
+hex
.Nm
format.
-.It Ar tar
+.It Cm tar
Old tar format.
-.It Ar ustar
-POSIX ustar format.
+.It Cm ustar
+.Tn POSIX
+ustar format.
.El
.It Fl m
Restore modification times on files.
@@ -218,7 +225,7 @@ The list of files to copy are read from standard input and
written out to a directory relative to the specified
.Ar directory
argument.
-.Bl -tag -width Ds
+.Bl -tag -width indent
.It Fl a
Reset the access times on files that have been copied.
.It Fl d
@@ -239,7 +246,12 @@ Be verbose about operations.
List filenames as they are copied.
.El
.El
-.Sh ERRORS
+.Sh ENVIRONMENT
+.Bl -tag -width TMPDIR
+.It Ev TMPDIR
+Path in which to store temporary files.
+.El
+.Sh DIAGNOSTICS
.Nm
will exit with one of the following values:
.Bl -tag -width 2n
@@ -277,16 +289,12 @@ or error,
.Nm
may have only partially created the archive which may violate the
specific archive format specification.
-.Sh ENVIRONMENT
-.Bl -tag -width Fl
-.It Ev TMPDIR
-Path in which to store temporary files.
-.El
.Sh SEE ALSO
.Xr pax 1 ,
.Xr tar 1
.Sh AUTHORS
-Keith Muller at the University of California, San Diego.
+.An Keith Muller
+at the University of California, San Diego.
.Sh BUGS
The
.Fl s
diff --git a/bin/pax/tar.1 b/bin/pax/tar.1
index 9b2b569..0a5ef2d 100644
--- a/bin/pax/tar.1
+++ b/bin/pax/tar.1
@@ -37,9 +37,11 @@
.Nm tar
.Nd tape archiver
.Sh SYNOPSIS
-.Nm tar
+.Nm
.Sm off
-.Oo \&- Oc {crtux} Op befhmopqsvwzHLOPXZ014578
+.Op Fl
+.Brq Cm crtux
+.Op Cm befhmopqsvwzHLOPXZ014578
.Sm on
.Op Ar blocksize
.Op Ar archive
@@ -47,19 +49,21 @@
.\" XXX how to do this right?
.Op Fl C Ar directory
.Op Fl I Ar file
-.Op Ar file ...
+.Op Ar
.Sh DESCRIPTION
The
.Nm
command creates, adds files to, or extracts files from an
archive file in
-.Dq tar
+.Nm
format.
-A tar archive is often stored on a magnetic tape, but can be
+A
+.Nm
+archive is often stored on a magnetic tape, but can be
stored equally well on a floppy, CD-ROM, or in a regular disk file.
.Pp
One of the following flags must be present:
-.Bl -tag -width Ar
+.Bl -tag -width indent
.It Fl c
Create new archive, or overwrite an existing archive,
adding the specified files to it.
@@ -90,7 +94,7 @@ The file mode is subject to modification by the
.Pp
In addition to the flags mentioned above, any of the following
flags may be used:
-.Bl -tag -width Ar
+.Bl -tag -width indent
.It Fl b Ar "blocking factor"
Set blocking factor to use for the archive.
.Nm
@@ -109,11 +113,14 @@ Defaults to
Follow symbolic links as if they were normal files
or directories.
.It Fl j
-Compress archives using bzip2.
+Compress archives using
+.Xr bzip2 1 .
.It Fl m
Do not preserve modification time.
.It Fl O
-Write old-style (non-POSIX) archives.
+Write old-style
+.Pq non- Ns Tn POSIX
+archives.
.It Fl o
Don't write directory information that the older (V7) style
.Nm
@@ -155,14 +162,19 @@ 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 & ,
+.Li \e Ns Ar n
+(where
+.Ar n
+is a digit) back-references,
or subexpression matching.
The
.Cm old
-string may also contain
-.Dv <newline>
-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
+.Ql ( /
+is shown here).
Multiple
.Fl s
expressions can be specified.
@@ -179,9 +191,11 @@ option.
The optional trailing
.Cm p
will cause the final result of a successful substitution to be written to
-.Dv standard error
+standard error
in the following format:
+.Pp
.Dl <original pathname> >> <new pathname>
+.Pp
File or archive member names that substitute to the empty string
are not selected and will be skipped.
.It Fl v
@@ -193,9 +207,11 @@ This option causes
to prompt the user for the filename to use when storing or
extracting files in an archive.
.It Fl y
-Compress archives using bzip2.
+Compress archives using
+.Xr bzip2 1 .
.It Fl z
-Compress archive using gzip.
+Compress archive using
+.Xr gzip 1 .
.It Fl C Ar directory
This is a positional argument which sets the working directory for the
following files.
@@ -208,7 +224,7 @@ Follow symlinks given on command line only.
Follow all symlinks.
.It Fl P
Do not strip leading slashes
-.Pq Sq /
+.Pq Ql /
from pathnames.
The default is to strip leading slashes.
.It Fl I Ar file
@@ -217,13 +233,27 @@ archive or extract from the given file, one per line.
.It Fl X
Do not cross mount points in the file system.
.It Fl Z
-Compress archive using compress.
+Compress archive using
+.Xr compress 1 .
.El
.Pp
The options
.Op Fl 014578
can be used to select one of the compiled-in backup devices,
-.Pa /dev/rstN .
+.Pa /dev/rst Ns Ar N .
+.Sh ENVIRONMENT
+.Bl -tag -width TMPDIR
+.It Ev TMPDIR
+Path in which to store temporary files.
+.It Ev TAPE
+Default tape device to use instead of
+.Pa /dev/rst0 .
+.El
+.Sh FILES
+.Bl -tag -width "/dev/rst0"
+.It Pa /dev/rst0
+default archive name
+.El
.Sh DIAGNOSTICS
.Nm
will exit with one of the following values:
@@ -262,32 +292,20 @@ or error,
.Nm
may have only partially created the archive which may violate the
specific archive format specification.
-.Sh FILES
-.Bl -tag -width "/dev/rst0"
-.It Pa /dev/rst0
-default archive name
-.El
-.Sh ENVIRONMENT
-.Bl -tag -width Fl
-.It Ev TMPDIR
-Path in which to store temporary files.
-.It Ev TAPE
-Default tape device to use instead of
-.Pa /dev/rst0 .
-.El
+.Sh COMPATIBILITY
+The
+.Fl L
+flag is not portable to other versions of
+.Nm
+where it may have a different meaning.
.Sh SEE ALSO
.Xr cpio 1 ,
.Xr pax 1
-.Sh AUTHORS
-Keith Muller at the University of California, San Diego.
.Sh HISTORY
A
.Nm
command first appeared in
.At v7 .
-.Sh CAVEATS
-The
-.Fl L
-flag is not portable to other versions of
-.Nm
-where it may have a different meaning.
+.Sh AUTHORS
+.An Keith Muller
+at the University of California, San Diego.
OpenPOWER on IntegriCloud