.\" The FSF version of cpio; manpage redone from tmac(?) to mdoc
.\" by David Parsons <orc@pell.portland.or.us>
.\"
.Dd September 19, 2007
.Os Linux
.Dt CPIO 1L URM
.Sh NAME
.Nm cpio
.Nd copy files to and from archives
.Sh SYNOPSIS
.Nm
.Bro Fl o Li | Fl -create Brc
.Op Fl 0acvABLV
.Op Fl C Ar bytes
.Op Fl H Ar format
.Op Fl M Ar message
.Sm off
.Op Fl O Li \0  Oo Oo Ar user Li @ Oc Ar host Li : Oc Ar archive
.Sm on
.Sm off
.Op Fl F Li \0  Oo Oo Ar user Li @ Oc Ar host Li : Oc Ar archive
.Sm on
.Sm off
.Op Fl -file Ns = Oo Oo Ar user Li @ Oc Ar host Li : Oc Ar archive
.Sm on
.Sm off
.Op Fl -format Ns = Ar format
.Sm on
.Sm off
.Op Fl -message Ns = Ar message
.Sm on
.Op Fl -null
.Op Fl -reset-access-time
.Op Fl -verbose
.Op Fl -dot
.Op Fl -append
.Sm off
.Op Fl -block-size Ns = Ar blocks
.Sm on
.Op Fl -dereference
.Sm off
.Op Fl -io-size Ns = Ar bytes
.Sm on
.Op Fl -quiet
.Op Fl -force-local
.Sm off
.Op Fl -rsh-command Ns = Ar command
.Sm on
.Op Fl -help
.Op Fl -version
.Ar <name-list
.Op Ar >archive
.Pp
.Nm
.Bro Fl -i Li | Fl -extract Brc
.Op Fl bcdfmnrtsuvBSV
.Op Fl C Ar bytes
.Op Fl E Ar file
.Op Fl H Ar format
.Op Fl M Ar message
.Sm off
.Op Fl R Li \0  Ar user Oo Bro Sy : Li | Sy . Brc Ar group Oc
.Sm on
.Sm off
.Op Fl I Li \0  Oo Oo Ar user Li @ Oc Ar host Li : Oc Ar archive Li
.Sm on
.Sm off
.Op Fl F Li \0  Oo Oo Ar user Li @ Oc Ar host Li : Oc Ar archive Li 
.Sm on
.Sm off
.Op Fl -file Ns = Oo Oo Ar user Li @ Oc Ar host Li : Oc Ar archive
.Sm on
.Op Fl -make-directories
.Op Fl -nonmatching
.Op Fl -preserve-modification-time
.Op Fl -numeric-uid-gid
.Op Fl -rename
.Op Fl t Li | Fl -list
.Op Fl -swap-bytes
.Op Fl -swap
.Op Fl -dot
.Op Fl -unconditional
.Op Fl -verbose
.Sm off
.Op Fl -block-size Ns = Ar blocks
.Sm on
.Sm on
.Op Fl -swap-halfwords
.Sm on
.Sm off
.Op Fl -io-size Ns = Ar bytes
.Sm on
.Sm off
.Op Fl -pattern-file Ns = Ar file
.Sm on
.Sm off
.Op Fl -format Ns = Ar format
.Sm on
.Sm off
.Op Fl -owner Ns = Ar user Oo Bro Sy : Li | Sy . Brc Ar group Oc
.Sm on
.Op Fl -no-preserve-owner
.Sm off
.Op Fl -message Ns = Ar message
.Sm on
.Op Fl -force-local
.Op Fl -no-absolute-filenames
.Op Fl -sparse
.Op Fl -only-verify-crc
.Op Fl -quiet
.Sm off
.Op Fl -rsh-command Ns = Ar command
.Sm on
.Op Fl -help
.Op Fl -version
.Sm on
.Op Ar pattern... 
.Op Ar <archive
.Pp
.Nm
.Bro Fl p Li | Fl -pass-through Brc
.Op 0adlmuvLV
.Sm off
.Op Fl R Li \0 Ar user Oo Bro Sy : Li | Sy . Brc Ar group Oc
.Sm on
.Op Fl -null
.Op Fl -reset-access-time
.Op Fl -make-directories
.Op Fl -link
.Op Fl -quiet
.Op Fl -preserve-modification-time
.Op Fl -unconditional
.Op Fl -verbose
.Op Fl -dot
.Op Fl -dereference
.Sm off
.Op Fl -owner Ns = Ar user Oo Bro Sy : Li | Sy . Brc Ar group Oc
.Sm on
.Op Fl -no-preserve-owner
.Op Fl -sparse
.Op Fl -help
.Op Fl -version
.Sm on
.Ar destination-directory
.Ar <name-list
.Sh DESCRIPTION
.Nm
copies files into or out of a
.Nm or
.Xr tar 1 
archive, which is a file that
contains other files plus information about them, such as their
file name, owner, timestamps, and access permissions.  The archive can
be another file on the disk, a magnetic tape, or a pipe.
.Nm
has three operating modes.
.Pp
In copy-out mode,
.Nm
copies files into an archive.  It reads a list of filenames, one per
line, on the standard input, and writes the archive onto the standard
output.  A typical way to generate the list of filenames is with the
.Xr find 1
command; you should give
.Xr find 1
the 
.Fl depth
option to minimize problems with permissions on
directories that are unwritable or not searchable.
.Pp
In copy-in mode,
.Nm
copies files out of an archive or lists the archive contents.  It
reads the archive from the standard input.  Any non-option command
line arguments are shell globbing patterns; only files in the archive
whose names match one or more of those patterns are copied from the
archive.  Unlike in the shell, an initial `.' in a filename does
match a wildcard at the start of a pattern, and a `/' in a filename
can match wildcards.  If no patterns are given, all files are
extracted.
.Pp
In copy-pass mode,
.Nm
copies files from one directory tree to another, combining the
copy-out and copy-in steps without actually using an archive.
It reads the list of files to copy from the standard input; the
directory into which it will copy them is given as a non-option
argument.
.Pp
.Nm
supports the following archive formats: binary, old ASCII, new
ASCII, crc, HPUX binary, HPUX old ASCII, old tar, and POSIX.1 tar.  
The binary format 
is obsolete because it encodes information about the files in a way
that is not portable between different machine architectures.
The old ASCII format is portable between different machine architectures,
but should not be used on file systems with more than 65536 i-nodes.
The new ASCII format is portable between different machine architectures
and can be used on any size file system, but is not supported by all
versions of
.Nm ;
currently, it is only supported by GNU
.Pq Sx BUGS 
and Unix System V R4.
The crc format is
like the new ASCII format, but also contains a checksum for each file
which
.Nm
calculates when creating an archive
and verifies when the file is extracted from the archive.
The HPUX formats are provided for compatibility with HPUX's cpio which
stores device files differently.
.Pp
The tar format is provided for compatability with
the
.Xr tar 1
program.  It can not be used to archive files with names
longer than 100 characters, and can not be used to archive "special"
(block or character devices) files.
The POSIX.1 tar format can not be used to archive files with names longer
than 255 characters (less unless they have a "/" in just the right place).
.Pp
By default,  
.Nm
creates binary format archives, for compatibility with
older
.Nm
programs.
When extracting from archives,
.Nm
automatically recognizes which kind of archive it is reading and can
read archives created on machines with a different byte-order.
.Pp
Some of the options to
.Nm
apply only to certain operating modes; see the SYNOPSIS section for a
list of which options are allowed in which modes.
.Ss Options
.Bl -tag -width longer-than-thou -compact -offset indent
.It Fl 0 , Fl -null
In copy-out and copy-pass modes, read a list of filenames terminated
by a null character instead of a newline, so that files whose names
contain newlines can be archived.  GNU
.B find
is one way to produce a list of null-terminated filenames.
.Pp
.It Fl a , Fl -reset-access-time
Reset the access times of files after reading them, so that it does
not look like they have just been read.
.Pp
.It Fl A , Fl -append
Append to an existing archive.  Only works in copy-out mode.  The
archive must be a disk file specified with the
.Fl O
or
.Fl -F Pq Fl -file
option.
.Pp
.It Fl b , Fl -swap
In copy-in mode, swap both halfwords of words and bytes of halfwords
in the data.  Equivalent to
.Fl sS .
Use this option to convert 32-bit integers between big-endian and
little-endian machines.
.Pp
.It Fl B
Set the I/O block size to 5120 bytes.  Initially the block size is 512
bytes.
.Pp
.It Fl -block-size Ns = Ar BLOCK-SIZE
Set the I/O block size to BLOCK-SIZE * 512 bytes.
.Pp
.It Fl c
Identical to
.Fl H Ar newc ,
use the new (SVR4) portable format.
If you wish the old portable (ASCII) archive format, use
.Fl H Ar odc
instead.
.Pp
.It Fl C Ar IO-SIZE , Fl -io-size Ns = Ns Ar IO-SIZE
Set the I/O block size to
.Ar IO-SIZE
bytes.
.Pp
.It Fl d , Fl -make-directories
Create leading directories where needed.
.Pp
.It Fl E Ar FILE , Ar -pattern-file Ns = Ns Ar FILE 
In copy-in mode, read additional patterns specifying filenames to
extract or list from
.Ar FILE .
The lines of
.Ar FILE
are treated as if they
had been non-option arguments to
.Nm .
.Pp
.It FL f , Fl -nonmatching
Only copy files that do not match any of the given patterns.
.Pp
.It Fl F , Fl -file Ns = Ns Ar archive
Archive filename to use instead of standard input or output.  To use a
tape drive on another machine as the archive, use a filename that
starts with `HOSTNAME:'.  The hostname can be preceded by a
username and an 
.Sy @
to access the remote tape drive as that user, if
you have permission to do so (typically an entry in that user's
.Pa ~/.rhosts
file).
.Pp
.It Fl -force-local
With
.Fl F ,
.Fl I ,
or
.Fl O ,
take the archive file name to be a local file even if it contains a
colon, which would ordinarily indicate a remote host name.
.Pp
.It Fl H Ar FORMAT , Ar -format Ns = NS Ar FORMAT
Use archive format
.Ar FORMAT .
The valid formats are listed below;
the same names are also recognized in all-caps.  The default in
copy-in mode is to automatically detect the archive format, and in
copy-out mode is "bin".
.Pp
.Bl -tag -width ustarrr -compact
.It Ar bin
The obsolete binary format.
.It Ar odc
The old (POSIX.1) portable format.
.It Ar newc
The new (SVR4) portable format, which supports file systems having
more than 65536 i-nodes.
.It Ar crc
The new (SVR4) portable format with a checksum added.
.It Ar tar
The old tar format.
.It Ar ustar
The POSIX.1 tar format.  Also recognizes GNU
.Pq Sx BUGS
.Xr tar (1)
archives, which are similar but not identical.
.It Ar hpbin
The obsolete binary format used by HPUX's cpio (which stores device files
differently).
.It Ar hpodc
The portable format used by HPUX's cpio (which stores device files differently).
.El
.Pp
.It Fl i , Fl -extract
Run in copy-in mode.
.Pp
.It Fl I Ar archive
Archive filename to use instead of standard input.  To use a
tape drive on another machine as the archive, use a filename that
starts with `HOSTNAME:'.  The hostname can be preceded by a
username and an 
.Sy @
to access the remote tape drive as that user, if
you have permission to do so (typically an entry in that user's
.Pa ~/.rhosts
file).
.Pp
.It Fl k
Ignored; for compatibility with other versions of
.Nm .
.Pp
.It Fl l , Fl -link
Link files instead of copying them, when possible.
.Pp
.It Fl L , Fl -dereference
Dereference symbolic links (copy the files that they point to instead
of copying the links).
.Pp
.It Fl m , Fl -preserve-modification-time
Retain previous file modification times when creating files.
.Pp
.It Fl M Ar MESSAGE , Fl -message Ns = Ns Ar MESSAGE
Print
.Ar MESSAGE
when the end of a volume of the backup media (such as a
tape or a floppy disk) is reached, to prompt the user to insert a new
volume.  If
.Ar MESSAGE
contains the string 
.Dq Sy %d ,
it is replaced by the
current volume number (starting at 1).
.Pp
.It Fl n , Fl -numeric-uid-gid
In the verbose table of contents listing, show numeric UID and GID
instead of translating them into names.
Also extracts tar archives using the numeric UID and GID instead of the
user/group names.
.Po Nm
archives are always extracted using the numeric UID and GID.
.Pc
.Pp
.It Fl -no-absolute-filenames
In copy-in mode, create all files relative to the current directory,
even if they have an absolute file name in the archive.
.Pp
.It Fl -no-preserve-owner
In copy-in mode and copy-pass mode, do not change the ownership of the
files; leave them owned by the user extracting them.  This is the
default for non-root users, so that users on System V don't
inadvertantly give away files.
.Pp
.It Fl o , Fl -create
Run in copy-out mode.
.Pp
.It Fl O Ar archive
Archive filename to use instead of standard output.  To use a tape
drive on another machine as the archive, use a filename that starts
with `HOSTNAME:'.  The hostname can be preceded by a username and an
`@' to access the remote tape drive as that user, if you have
permission to do so (typically an entry in that user's
.Pa ~/.rhosts
file).
.Pp
.It Fl -only-verify-crc
When reading a CRC format archive in copy-in mode, only verify the
CRC's of each file in the archive, don't actually extract the files.
.Pp
.It Fl p , Fl -pass-through
Run in copy-pass mode.
.Pp
.It Fl -quiet
Do not print the number of blocks copied.
.Pp
.It Fl r , Fl -rename
Interactively rename files.
.Pp
.It Fl R Ar user Ns Oo Ns Bro :. Ns Brc Ns group Ns Oc , Fl -owner Ns = Ns Ar user Ns Oo Ns Bro :. Ns Brc Ns group Ns Oc
In copy-out and copy-pass modes, set the ownership of all files created
to the specified
.Ar user
and/or
.Ar group .
Either the user or the group, or
both, must be present.  If the group is omitted but the \fB:\fR or \fB.\fR
separator is given, use the given user's login group.  Only the
super-user can change files' ownership.
.Pp
.It Fl -rsh-command Ns = Ns Ar COMMAND
Notifies
.Xr mt 1
that it should use
.Ar COMMAND
to communicate with remote devices instead of
.Xr ssh 1 ,
.Xr rsh 1 ,
or the command specified by the environment variable
.Ar MT_RSH .
.Pp
.It Fl -sparse
In copy-in and copy-pass modes, write files with large blocks of zeros
as sparse files.
.Pp
.It Fl s , Fl -swap-bytes
In copy-in mode, swap the bytes of each halfword (pair of bytes) in the
files.
.Pp
.It Fl S , Fl -swap-halfwords
In copy-in mode, swap the halfwords of each word (4 bytes) in the
files.
.Pp
.It Fl t , Fl -list
Print a table of contents of the input.
.Pp
.It Fl u , Fl -unconditional
Replace all files, without asking whether to replace existing newer
files with older files.
.Pp
.It Fl v , Fl -verbose
List the files processed, or with
.Fl t ,
give an
.Dq Ic ls -l
style table of contents listing.  In a verbose table
of contents of a ustar archive, user and group names in the archive
that do not exist on the local system are replaced by the names that
correspond locally to the numeric UID and GID stored in the archive.
.Pp
.It Fl V , Fl -dot
Print a 
.Dq \&.
for each file processed.
.Pp
.It Fl -version
Print the
.Nm
program version number and exit.
.El
.Sh EXAMPLES
The following examples show three uses of
.Nm .
.Ss Using standard input
.D1 example% ls \&| cpio -oc > ../newfile
.Pp
When standard input is directed through a pipe to
.Nm ,
as in the example above, it groups the files so they can be directed 
.Pq >
to a single file
.Pq Pa ../newfile .
The
.Fl c
option insures that the file will be
portable to other machines (as would the
.Fl H
option). Instead of
.Xr ls 1 ,
you could use
.Xr find 1 ,
.Xr echo 1 ,
.Xr cat 1 ,
and so on, to pipe a list of
names to cpio . You could direct the output to a device instead of a file.
.Ss Extracting files into directories
.D1 example% cat newfile \&| cpio -icd "memo/a1" "memo/b*"
.Pp
In this example,
.Nm
.Fl i
uses the output file of
.Nm
.Fl o
.Pq (directed through a pipe with Xr cat 1 , 
extracts those files that match
the patterns
.Pq Pa memo/a1 , memo/b* ,
creates directories below the current
directory as needed
.Pq Fl d option ,
and places the files in the appropriate
directories. The
.Fl c 
option is used if the input file was created with
a portable header. If no patterns were given, all files from
.Pa newfile
would be placed in the directory.
.Ss Copying or linking files to another directory
.D1 example% find \&. -depth -print \&| cpio -pdlmv newdir
.Pp
In this example,
.Nm 
.Fl p
takes the file names piped to it
and copies or links
.Pq Fl l option
those files to another directory,
.Pa newdir .
The
.Fl d
option says to create directories as needed. The
.Fl m
option says to retain the modification time. (It is important to use
the
.Fl depth
option of
.Xr find 1
to generate path names for
.Nm .
This
eliminates problems that cpio could have trying to create files under
read-only directories.) The destination directory,
.Pa newdir ,
must exist.
.Pp
Notice that when you use
.Nm
in conjunction with
.Xr find 1 ,
if you use the
.Fl L option with
.Nm ,
you must use the
.Fl follow
option with
.Xr find 1 and vice versa. Otherwise, there
will be undesirable results.
.Pp
For multi-reel archives, dismount the old volume, mount the new one,
and continue to the next tape by typing the name of the next device
(probably the same as the first reel). To stop, type a
.Sy RETURN
and
.Nm
will end.
.Sh DIAGNOSTICS
.Ex -std
.Sh BUGS
This is the GNU implementation of cpio.