1 .\" $OpenBSD: cpio.1,v 1.28 2008/06/11 07:42:50 jmc Exp $
3 .\" Copyright (c) 1997 SigmaSoft, Th. Lockert
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 .\" $OpenBSD: cpio.1,v 1.28 2008/06/11 07:42:50 jmc Exp $
28 .Dd $Mdocdate: June 11 2008 $
33 .Nd copy file archives in and out
46 .Op Fl 6BbcdfjmrSstuvZz
57 .Ar destination-directory
62 command copies files to and from a
66 The options are as follows:
70 Reads the list of files to store in the
71 archive from standard input, and writes the archive on standard
75 Append to the specified archive.
77 Reset the access times on files that have been copied to the
80 Set block size of output to 5120 bytes.
82 Set the block size of output to
87 header for portability.
89 Use the specified file as the input for the archive.
91 Write the archive in the specified format.
92 Recognized formats are:
94 .Bl -tag -width sv4cpio -compact
113 Compress archive using the bzip2 format.
114 The bzip2 utility must be installed separately.
116 Follow symbolic links.
118 Use the specified file name as the archive to write to.
120 Be verbose about operations.
121 List filenames as they are written to the archive.
123 Compress archive using
127 Compress archive using
132 Restore files from an archive.
133 Reads the archive file from
134 standard input and extracts files matching the
136 that were specified on the command line.
143 Set the block size of the archive being read to 5120 bytes.
145 Do byte and word swapping after reading in data from the
146 archive, for restoring archives created on systems with
147 a different byte order.
149 Read archive written with a block size of
152 Expect the archive headers to be in ASCII format.
154 Create any intermediate directories as needed during
157 Read list of file name patterns to extract or list from
159 .It Fl F Ar archive , Fl I Ar archive
160 Use the specified file as the input for the archive.
162 Restore all files except those matching the
164 given on the command line.
166 Read an archive of the specified format.
167 Recognized formats are:
169 .Bl -tag -width sv4cpio -compact
188 Uncompress archive using the bzip2 format.
189 The bzip2 utility must be installed separately.
191 Restore modification times on files.
193 Rename restored files interactively.
195 Swap words after reading data from the archive.
197 Swap bytes after reading data from the archive.
199 Only list the contents of the archive, no files or
200 directories will be created.
202 Overwrite files even when the file in the archive is
203 older than the one that will be overwritten.
205 Be verbose about operations.
206 List filenames as they are copied in from the archive.
208 Uncompress archive using
212 Uncompress archive using
217 Copy files from one location to another in a single pass.
218 The list of files to copy are read from standard input and
219 written out to a directory relative to the specified
224 Reset the access times on files that have been copied.
226 Create any intermediate directories as needed to write
227 the files at the new location.
229 Follow symbolic links.
231 When possible, link files rather than creating an
234 Restore modification times on files.
236 Overwrite files even when the original file being copied is
237 older than the one that will be overwritten.
239 Be verbose about operations.
240 List filenames as they are copied.
246 Path in which to store temporary files.
250 will exit with one of the following values:
253 All files were processed successfully.
260 cannot create a file or a link when extracting an archive or cannot
261 find a file while writing an archive, or cannot preserve the user
262 ID, group ID, file mode, or access and modification times when the
264 option is specified, a diagnostic message is written to standard
265 error and a non-zero exit value will be returned, but processing
269 cannot create a link to a file,
271 will not create a second copy of the file.
273 If the extraction of a file from an archive is prematurely terminated
274 by a signal or error,
276 may have only partially extracted the file the user wanted.
277 Additionally, the file modes of extracted files and directories may
278 have incorrect file bits, and the modification and access times may
281 If the creation of an archive is prematurely terminated by a signal
284 may have only partially created the archive, which may violate the
285 specific archive format specification.
290 Keith Muller at the University of California, San Diego.
292 Different file formats have different maximum file sizes.
293 It is recommended that a format such as cpio or ustar
294 be used for larger files.
296 .Bl -column "File format" "Maximum file size" -offset indent -compact
297 .It Sy "File format" Ta Sy "Maximum file size"
298 .It bcpio Ta 4 Gigabytes
299 .It sv4cpio Ta 4 Gigabytes
300 .It cpio Ta 8 Gigabytes
301 .It tar Ta 8 Gigabytes
302 .It ustar Ta 8 Gigabytes
309 options are currently not implemented.