BSD 4_3_Net_2 release
[unix-history] / usr / src / usr.bin / cpio / cpio.1
index c475b28..ccc7e4a 100644 (file)
@@ -1,40 +1,50 @@
 .\" Copyright (c) 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"
-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
 .\"
 .\"
-.\"     @(#)cpio.1     5.5 (Berkeley) 7/24/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
 .\"
 .\"
-.\"    @(#)cpio.1      5.3 (Berkeley) 3/29/88
+.\"     @(#)cpio.1     5.6 (Berkeley) 3/14/91
 .\"
 .\"
-.Dd July 24, 1990
+.Dd March 14, 1991
 .Dt CPIO 1
 .Dt CPIO 1
-.Os BSD 4.4
+.Os
 .Sh NAME
 .Nm cpio
 .Nd copy file archives in and out
 .Sh SYNOPSIS
 .Nm cpio
 .Sh NAME
 .Nm cpio
 .Nd copy file archives in and out
 .Sh SYNOPSIS
 .Nm cpio
-.Fl o
-.Op Fl acBv
-.br
-.Nm cpio
 .Fl i
 .Op Fl BcdmrtuvfsSb6
 .Op Ar patterns
 .Fl i
 .Op Fl BcdmrtuvfsSb6
 .Op Ar patterns
-.br
+.Nm cpio
+.Fl o
+.Op Fl acBv
 .Nm cpio
 .Fl p
 .Op Fl adlmruv
 .Nm cpio
 .Fl p
 .Op Fl adlmruv
 has three functional modes; copy out, copy in and pass.
 .Pp
 Functional Options:
 has three functional modes; copy out, copy in and pass.
 .Pp
 Functional Options:
-.Tw Ds
-.Tp Fl o
-Copy out \- reads the standard input to obtain a list
-of path names and copies those files onto the standard
-output together with path name and status information.
-Output is padded to a 512-byte boundary.
-.Pp
-.Tp Fl i
-Copy in \- extracts files from the standard input,
+.Bl -tag -width 4n
+.It Fl i
+.Em Copy in .
+Extracts files from the standard input,
 which is assumed to be the product of a previous
 .Nm cpio
 .Fl o .
 which is assumed to be the product of a previous
 .Nm cpio
 .Fl o .
@@ -60,16 +65,16 @@ Only files with names that match patterns are selected.
 Patterns are given in the name-generating notation of
 .Xr sh 1 .
 In patterns, meta-characters
 Patterns are given in the name-generating notation of
 .Xr sh 1 .
 In patterns, meta-characters
-.Sq Li \&? ,
-.Sq Li \&* ,
+.Ql \&? ,
+.Ql \&* ,
 and
 and
-.Sq Li [...]
+.Ql [...]
 match the
 slash
 match the
 slash
-.Sq Li \&/
+.Ql \&/
 character.  Multiple patterns may be specified and
 if no patterns are specified, the default for patterns is
 character.  Multiple patterns may be specified and
 if no patterns are specified, the default for patterns is
-.Sq Li \&*
+.Ql \&*
 (i.e., select all files).  The extracted files are
 conditionally created and copied into the current directory
 tree based upon the options described below.  The
 (i.e., select all files).  The extracted files are
 conditionally created and copied into the current directory
 tree based upon the options described below.  The
@@ -83,91 +88,97 @@ to retain the owner and group of the files of the
 previous
 .Nm cpio
 .Fl o .
 previous
 .Nm cpio
 .Fl o .
-.Pp
-.Tp Fl p
-Pass \- reads the standard input to obtain a list of
+.It Fl o
+.Em Copy out .
+Reads the standard input to obtain a list
+of path names and copies those files onto the standard
+output together with path name and status information.
+Output is padded to a 512-byte boundary.
+.It Fl p
+.Em Pass.
+Reads the standard input to obtain a list of
 path names of files that are conditionally created and
 copied into the destination directory tree based upon the
 options described below.
 path names of files that are conditionally created and
 copied into the destination directory tree based upon the
 options described below.
-.Tp
+.El
 .Pp
 Options for the above functional options:
 .Pp
 Options for the above functional options:
-.Tw Ds
-.Tp Fl a
-Reset access times of input files after they have been
-copied.
-.Tp Fl B
+.Bl -tag -width 4n
+.It Fl B
 Input/output is to be blocked 5,120 bytes to the record
 (does not apply to the pass options; meaningful only
 with data directed to or from
 .Pa /dev/rmt/??).
 Input/output is to be blocked 5,120 bytes to the record
 (does not apply to the pass options; meaningful only
 with data directed to or from
 .Pa /dev/rmt/??).
-.Tp Fl d
-Directories are to be created as needed.
-.Tp Fl c
+.It Fl S
+Swap halfwords.  Use only with the
+.Fl i
+option.
+.It Fl a
+Reset access times of input files after they have been
+copied.
+.It Fl b
+halfwords.  Use only with the
+.Fl i
+option.
+.It Fl c
 Write header information in ASCII character form for
 portability.
 Write header information in ASCII character form for
 portability.
-.Tp Fl r
+.It Fl d
+Directories are to be created as needed.
+.It Fl f
+Copy in all files except those in patterns.
+.It Fl l
+Whenever possible, link files rather than copying them.
+Usable only with the
+.Fl p
+option.
+.It Fl m
+Retain previous file modification time.  This option is
+ineffective on directories that are being copied.
+.It Fl r
 Interactively rename files.  If the user types a null
 line, the files is skipped.
 Interactively rename files.  If the user types a null
 line, the files is skipped.
-.Tp Fl t
+.It Fl s
+Swap bytes.  Use only with the
+.Fl i
+option.
+.It Fl t
 Print a table of contents of the input.  No files are
 created.
 Print a table of contents of the input.  No files are
 created.
-.Tp Fl u
+.It Fl u
 Copy unconditionally (normally, an older file will not
 replace a newer file with the same name).
 Copy unconditionally (normally, an older file will not
 replace a newer file with the same name).
-.Tp Fl v
+.It Fl v
 Verbose: causes a list of file names to be printed.
 When used with the t option, the table of contents
 looks like the output of an
 .Ql ls -l
 command (see
 .Xr ls 1 ) .
 Verbose: causes a list of file names to be printed.
 When used with the t option, the table of contents
 looks like the output of an
 .Ql ls -l
 command (see
 .Xr ls 1 ) .
-.Tp Fl l
-Whenever possible, link files rather than copying them.
-Usable only with the
-.Fl p
-option.
-.Tp Fl m
-Retain previous file modification time.  This option is
-ineffective on directories that are being copied.
-.Tp Fl f
-Copy in all files except those in patterns.
-.Tp Fl s
-Swap bytes.  Use only with the
-.Fl i
-option.
-.Tp Fl S
-Swap halfwords.  Use only with the
-.Fl i
-option.
-.Tp Fl b
-halfwords.  Use only with the
-.Fl i
-option.
-.Tp Fl 6
+.It Fl 6
 Process an old (i.e., UNIX System Sixth Edition format)
 file.  Only useful with
 .Fl i
 (copy in).
 Process an old (i.e., UNIX System Sixth Edition format)
 file.  Only useful with
 .Fl i
 (copy in).
-.Tp
+.El
 .Sh EXAMPLES
 The first example below copies the contents of a directory
 into an archive; the second duplicates a directory
 hierarchy:
 .Pp
 .Sh EXAMPLES
 The first example below copies the contents of a directory
 into an archive; the second duplicates a directory
 hierarchy:
 .Pp
-.Dl ls  \&| cpio -o >/dev/rmt/0m
-.Pp
-.Dl cd olddir
-.Dl find . -depth -print \&|  cpio -pdl newdir
+.Bd -literal -offset indent
+ls  \&| cpio -o > edev/rmt/0m
+
+cd olddir
+find \&. -depth -print \&|  cpio -pdl newdir
 .Pp
 The trivial case
 .Pp
 .Pp
 The trivial case
 .Pp
-.Dl find . -depth -print \&|  cpio -oB >/dev/fmt/0m
+.Dl find \&. -depth -print \&|  cpio -oB >/dev/fmt/0m
 .Pp
 can be handled more efficiently by:
 .Pp
 .Pp
 can be handled more efficiently by:
 .Pp
-.Dl find . -cpio /dev/rmt/0m
-.Pp
+.Dl find \&. -cpio /dev/rmt/0m
 .Sh SEE ALSO
 .Xr ar 1 ,
 .Xr find 1 ,
 .Sh SEE ALSO
 .Xr ar 1 ,
 .Xr find 1 ,