1.\" $OpenBSD: cpio.1,v 1.37 2023/12/09 23:00:11 jca Exp $ 2.\" 3.\" Copyright (c) 1997 SigmaSoft, Th. Lockert 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 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. 14.\" 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. 25.\" 26.Dd $Mdocdate: December 9 2023 $ 27.Dt CPIO 1 28.Os 29.Sh NAME 30.Nm cpio 31.Nd copy file archives in and out 32.Sh SYNOPSIS 33.Nm cpio 34.Fl o 35.Op Fl AaBcjLvZz 36.Op Fl C Ar bytes 37.Op Fl F Ar archive 38.Op Fl H Ar format 39.Op Fl O Ar archive 40.No \*(Lt Ar name-list 41.Op \*(Gt Ar archive 42.Nm cpio 43.Fl i 44.Op Fl 6BbcdfjmrSstuvZz 45.Op Fl C Ar bytes 46.Op Fl E Ar file 47.Op Fl F Ar archive 48.Op Fl H Ar format 49.Op Fl I Ar archive 50.Op Ar pattern ... 51.Op \*(Lt Ar archive 52.Nm cpio 53.Fl p 54.Op Fl adLlmuv 55.Ar destination-directory 56.No \*(Lt Ar name-list 57.Sh DESCRIPTION 58The 59.Nm 60command copies files to and from a 61.Nm 62archive. 63.Pp 64The options are as follows: 65.Bl -tag -width Ds 66.It Fl o 67Create an archive. 68Reads the list of files to store in the 69archive from standard input, and writes the archive on standard 70output. 71.Bl -tag -width Ds 72.It Fl A 73Append to the specified archive. 74.It Fl a 75Reset the access times on files that have been copied to the 76archive. 77.It Fl B 78Set block size of output to 5120 bytes. 79.It Fl C Ar bytes 80Set the block size of output to 81.Ar bytes . 82.It Fl c 83Use ASCII format for 84.Nm 85header for portability. 86.It Fl F Ar archive 87Use the specified file as the input for the archive. 88.It Fl H Ar format 89Write the archive in the specified format. 90Recognized formats are: 91.Pp 92.Bl -tag -width sv4cpio -compact 93.It Ar bcpio 94Old binary 95.Nm 96format. 97.It Ar cpio 98Old octal character 99.Nm 100format. 101.It Ar pax 102POSIX pax format. 103.It Ar sv4cpio 104SVR4 hex 105.Nm 106format. 107.It Ar tar 108Old tar format. 109.It Ar ustar 110POSIX ustar format. 111.El 112.It Fl j 113Compress archive using the bzip2 format. 114The bzip2 utility must be installed separately. 115.It Fl L 116Follow symbolic links. 117.It Fl O Ar archive 118Use the specified file name as the archive to write to. 119.It Fl v 120Be verbose about operations. 121List filenames as they are written to the archive. 122.It Fl Z 123Compress archive using 124.Xr compress 1 125format. 126.It Fl z 127Compress archive using 128.Xr gzip 1 129format. 130.El 131.It Fl i 132Restore files from an archive. 133Reads the archive file from 134standard input and extracts files matching the 135.Ar patterns 136that were specified on the command line. 137.Bl -tag -width Ds 138.It Fl 6 139Process old-style 140.Nm 141format archives. 142.It Fl B 143Set the block size of the archive being read to 5120 bytes. 144.It Fl b 145Do byte and word swapping after reading in data from the 146archive, for restoring archives created on systems with 147a different byte order. 148.It Fl C Ar bytes 149Read archive written with a block size of 150.Ar bytes . 151.It Fl c 152Expect the archive headers to be in ASCII format. 153.It Fl d 154Create any intermediate directories as needed during 155restore. 156.It Fl E Ar file 157Read list of file name patterns to extract or list from 158.Ar file . 159.It Fl F Ar archive , Fl I Ar archive 160Use the specified file as the input for the archive. 161.It Fl f 162Restore all files except those matching the 163.Ar patterns 164given on the command line. 165.It Fl H Ar format 166Read an archive of the specified format. 167Recognized formats are: 168.Pp 169.Bl -tag -width sv4cpio -compact 170.It Ar bcpio 171Old binary 172.Nm 173format. 174.It Ar cpio 175Old octal character 176.Nm 177format. 178.It Ar pax 179POSIX pax format. 180.It Ar sv4cpio 181SVR4 hex 182.Nm 183format. 184.It Ar tar 185Old tar format. 186.It Ar ustar 187POSIX ustar format. 188.El 189.It Fl j 190Uncompress archive using the bzip2 format. 191The bzip2 utility must be installed separately. 192.It Fl m 193Restore modification times on files. 194.It Fl r 195Rename restored files interactively. 196.It Fl S 197Swap words after reading data from the archive. 198.It Fl s 199Swap bytes after reading data from the archive. 200.It Fl t 201Only list the contents of the archive, no files or 202directories will be created. 203.It Fl u 204Overwrite files even when the file in the archive is 205older than the one that will be overwritten. 206.It Fl v 207Be verbose about operations. 208List filenames as they are copied in from the archive. 209.It Fl Z 210Uncompress archive using 211.Xr compress 1 212format. 213.It Fl z 214Uncompress archive using 215.Xr gzip 1 216format. 217.El 218.It Fl p 219Copy files from one location to another in a single pass. 220The list of files to copy are read from standard input and 221written out to a directory relative to the specified 222.Ar directory 223argument. 224.Bl -tag -width Ds 225.It Fl a 226Reset the access times on files that have been copied. 227.It Fl d 228Create any intermediate directories as needed to write 229the files at the new location. 230.It Fl L 231Follow symbolic links. 232.It Fl l 233When possible, link files rather than creating an 234extra copy. 235.It Fl m 236Restore modification times on files. 237.It Fl u 238Overwrite files even when the original file being copied is 239older than the one that will be overwritten. 240.It Fl v 241Be verbose about operations. 242List filenames as they are copied. 243.El 244.El 245.Sh ENVIRONMENT 246.Bl -tag -width Ds 247.It Ev TMPDIR 248Path in which to store temporary files. 249.El 250.Sh EXIT STATUS 251The 252.Nm 253utility exits with one of the following values: 254.Pp 255.Bl -tag -width Ds -offset indent -compact 256.It 0 257All files were processed successfully. 258.It 1 259An error occurred. 260.El 261.Sh DIAGNOSTICS 262Whenever 263.Nm 264cannot create a file or a link when extracting an archive or cannot 265find a file while writing an archive, or cannot preserve the user 266ID, group ID, file mode, or access and modification times when the 267.Fl p 268option is specified, a diagnostic message is written to standard 269error and a non-zero exit value will be returned, but processing 270will continue. 271In the case where 272.Nm 273cannot create a link to a file, 274.Nm 275will not create a second copy of the file. 276.Pp 277If the extraction of a file from an archive is prematurely terminated 278by a signal or error, 279.Nm 280may have only partially extracted the file the user wanted. 281Additionally, the file modes of extracted files and directories may 282have incorrect file bits, and the modification and access times may 283be wrong. 284.Pp 285If the creation of an archive is prematurely terminated by a signal 286or error, 287.Nm 288may have only partially created the archive, which may violate the 289specific archive format specification. 290.Sh SEE ALSO 291.Xr pax 1 , 292.Xr tar 1 293.Sh AUTHORS 294.An Keith Muller 295at the University of California, San Diego. 296.Sh CAVEATS 297Different file formats have different maximum file sizes. 298It is recommended that a format such as cpio or ustar 299be used for larger files. 300.Bl -column "File format" "Maximum file size" -offset indent 301.It Sy "File format" Ta Sy "Maximum file size" 302.It bcpio Ta "4 Gigabytes" 303.It sv4cpio Ta "4 Gigabytes" 304.It cpio Ta "8 Gigabytes" 305.\" XXX should be "unlimited" 306.It pax Ta "8 Gigabytes" 307.It tar Ta "8 Gigabytes" 308.It ustar Ta "8 Gigabytes" 309.El 310.Sh BUGS 311The 312.Fl s 313and 314.Fl S 315options are currently not implemented. 316