1.\" Copyright (c) 2003-2007 Tim Kientzle 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.Dd December 21, 2007 28.Dt BSDCPIO 1 29.Os 30.Sh NAME 31.Nm cpio 32.Nd copy files to and from archives 33.Sh SYNOPSIS 34.Nm 35.Brq Fl i 36.Op Ar options 37.Op Ar pattern ... 38.Op Ar < archive 39.Nm 40.Brq Fl o 41.Op Ar options 42.Ar < name-list 43.Op Ar > archive 44.Nm 45.Brq Fl p 46.Op Ar options 47.Ar dest-dir 48.Ar < name-list 49.Sh DESCRIPTION 50.Nm 51copies files between archives and directories. 52This implementation can extract from tar, pax, cpio, zip, jar, ar, 53and ISO 9660 cdrom images and can create tar, pax, cpio, ar, 54and shar archives. 55.Pp 56The first option to 57.Nm 58is a mode indicator from the following list: 59.Bl -tag -compact -width indent 60.It Fl i 61Input. 62Read an archive from standard input (unless overriden) and extract the 63contents to disk or (if the 64.Fl t 65option is specified) 66list the contents to standard output. 67If one or more file patterns are specified, only files matching 68one of the patterns will be extracted. 69.It Fl o 70Output. 71Read a list of filenames from standard input and produce a new archive 72on standard output (unless overriden) containing the specified items. 73.It Fl p 74Pass-through. 75Read a list of filenames from standard input and copy the files to the 76specified directory. 77.El 78.Pp 79.Sh OPTIONS 80Unless specifically stated otherwise, options are applicable in 81all operating modes. 82.Bl -tag -width indent 83.It Fl A 84(o mode only) 85Append to the specified archive. 86(Not yet implemented.) 87.It Fl a 88(o and p modes) 89Reset access times on files after they are read. 90.It Fl B 91(o mode only) 92Block output to records of 5120 bytes. 93.It Fl C Ar size 94(o mode only) 95Block output to records of 96.Ar size 97bytes. 98.It Fl c 99(o mode only) 100Use the old POSIX portable character format. 101Equivalent to 102.Fl -format Ar odc . 103.It Fl d 104(i and p modes) 105Create directories as necessary. 106.It Fl E Ar file 107(i mode only) 108Read list of file name patterns from 109.Ar file 110to list and extract. 111.It Fl F Ar file 112Read archive from or write archive to 113.Ar file . 114.It Fl f Ar pattern 115(i mode only) 116Ignore files that match 117.Ar pattern . 118.It Fl -format Ar format 119(o mode only) 120Produce the output archive in the specified format. 121Supported formats include: 122.Pp 123.Bl -tag -width "iso9660" -compact 124.It Ar cpio 125Synonym for 126.Ar odc . 127.It Ar newc 128The SVR4 portable cpio format. 129.It Ar odc 130The old POSIX.1 portable octet-oriented cpio format. 131.It Ar pax 132The POSIX.1 pax format, an extension of the ustar format. 133.It Ar ustar 134The POSIX.1 tar format. 135.El 136.Pp 137The default format is 138.Ar odc . 139See 140.Xr libarchive_formats 5 141for more complete information about the 142formats currently supported by the underlying 143.Xr libarchive 3 144library. 145.It Fl I Ar file 146Read archive from 147.Ar file . 148.It Fl i 149Input mode. 150See above for description. 151.It Fl -insecure 152(i and p mode only) 153Disable security checks during extraction or copying. 154This allows extraction via symbolic links and path names containing 155.Sq .. 156in the name. 157.It Fl L 158(o and p modes) 159All symbolic links will be followed. 160Normally, symbolic links are archived and copied as symbolic links. 161With this option, the target of the link will be archived or copied instead. 162.It Fl l 163(p mode only) 164Create links from the target directory to the original files, 165instead of copying. 166.It Fl m 167(i and p modes) 168Set file modification time on created files to match 169those in the source. 170.It Fl O Ar file 171Write archive to 172.Ar file . 173.It Fl o 174Output mode. 175See above for description. 176.It Fl p 177Pass-through mode. 178See above for description. 179.It Fl -quiet 180Suppress unnecessary messages. 181.It Fl R Oo user Oc Ns Oo : Oc Ns Oo group Oc 182Set the owner and/or group on files in the output. 183If group is specified with no user 184(for example, 185.Fl R Ar :wheel ) 186then the group will be set but not the user. 187If the user is specified with a trailing colon and no group 188(for example, 189.Fl R Ar root: ) 190then the group will be set to the user's default group. 191If the user is specified with no trailing colon, then 192the user will be set but not the group. 193In 194.Fl i 195and 196.Fl p 197modes, this option can only be used by the super-user. 198(For compatibility, a period can be used in place of the colon.) 199.It Fl r 200(All modes.) 201Rename files interactively. 202For each file, a prompt is written to 203.Pa /dev/tty 204containing the name of the file and a line is read from 205.Pa /dev/tty . 206If the line read is blank, the file is skipped. 207If the line contains a single period, the file is processed normally. 208Otherwise, the line is taken to be the new name of the file. 209.It Fl t 210(i mode only) 211List the contents of the archive to stdout; 212do not restore the contents to disk. 213.It Fl u 214(i and p modes) 215Unconditionally overwrite existing files. 216Ordinarily, an older file will not overwrite a newer file on disk. 217.It Fl v 218Print the name of each file to stderr as it is processed. 219With 220.Fl t , 221provide a detailed listing of each file. 222.It Fl -version 223Print the program version information and exit. 224.It Fl y 225(o mode only) 226Compress the archive with bzip2-compatible compression before writing it. 227In input mode, this option is ignored; 228bzip2 compression is recognized automatically on input. 229.It Fl Z 230(o mode only) 231Compress the archive with compress-compatible compression before writing it. 232In input mode, this option is ignored; 233compression is recognized automatically on input. 234.It Fl z 235(o mode only) 236Compress the archive with gzip-compatible compression before writing it. 237In input mode, this option is ignored; 238gzip compression is recognized automatically on input. 239.El 240.Sh ENVIRONMENT 241The following environment variables affect the execution of 242.Nm : 243.Bl -tag -width ".Ev BLOCKSIZE" 244.It Ev LANG 245The locale to use. 246See 247.Xr environ 7 248for more information. 249.It Ev TZ 250The timezone to use when displaying dates. 251See 252.Xr environ 7 253for more information. 254.El 255.Sh EXIT STATUS 256.Ex -std 257.Sh EXAMPLES 258The 259.Nm 260command is traditionally used to copy file heirarchies in conjunction 261with the 262.Xr find 1 263command. 264The first example here simply copies all files from 265.Pa src 266to 267.Pa dest : 268.Dl Nm find Pa src | Nm Fl pmud Pa dest 269.Pp 270By carefully selecting options to the 271.Xr find 1 272command and combining it with other standard utilities, 273it is possible to exercise very fine control over which files are copied. 274This next example copies files from 275.Pa src 276to 277.Pa dest 278that are more than 2 days old and whose names match a particular pattern: 279.Dl Nm find Pa src Fl mtime Ar +2 | Nm grep foo[bar] | Nm Fl pdmu Pa dest 280.Pp 281This example copies files from 282.Pa src 283to 284.Pa dest 285that are more than 2 days old and which contain the word 286.Do foobar Dc : 287.Dl Nm find Pa src Fl mtime Ar +2 | Nm xargs Nm grep -l foobar | Nm Fl pdmu Pa dest 288.Sh COMPATIBILITY 289The mode options i, o, and p and the options 290a, B, c, d, f, l, m, r, t, u, and v comply with SUSv2. 291.Pp 292The old POSIX.1 standard specified that only 293.Fl i , 294.Fl o , 295and 296.Fl p 297were interpreted as command-line options. 298Each took a single argument of a list of modifier 299characters. 300For example, the standard syntax allows 301.Fl imu 302but does not support 303.Fl miu 304or 305.Fl i Fl m Fl u , 306since 307.Ar m 308and 309.Ar u 310are only modifiers to 311.Fl i , 312they are not command-line options in their own right. 313The syntax supported by this implementation is backwards-compatible 314with the standard. 315For best compatibility, scripts should limit themselves to the 316standard syntax. 317.Sh SEE ALSO 318.Xr bzip2 1 , 319.Xr tar 1 , 320.Xr gzip 1 , 321.Xr mt 1 , 322.Xr pax 1 , 323.Xr libarchive 3 , 324.Xr cpio 5 , 325.Xr libarchive-formats 5 , 326.Xr tar 5 327.Sh STANDARDS 328There is no current POSIX standard for the cpio command; it appeared 329in 330.St -p1003.1-96 331but was dropped from 332.St -p1003.1-2001 . 333.Pp 334The cpio, ustar, and pax interchange file formats are defined by 335.St -p1003.1-2001 336for the pax command. 337.Sh HISTORY 338The original 339.Nm cpio 340and 341.Nm find 342utilities were written by Dick Haight 343while working in AT&T's Unix Support Group. 344They first appeared in 1977 in PWB/UNIX 1.0, the 345.Dq Programmer's Work Bench 346system developed for use within AT&T. 347They were first released outside of AT&T as part of System III Unix in 1981. 348As a result, 349.Nm cpio 350actually predates 351.Nm tar , 352even though it was not well-known outside of AT&T until some time later. 353.Pp 354This is a complete re-implementation based on the 355.Xr libarchive 3 356library. 357.Sh BUGS 358The cpio archive format has several basic limitations: 359It does not store user and group names, only numbers. 360As a result, it cannot be reliably used to transfer 361files between systems with dissimilar user and group numbering. 362Older cpio formats limit the user and group numbers to 36316 or 18 bits, which is insufficient for modern systems. 364The cpio archive formats cannot support files over 4 gigabytes, 365except for the 366.Dq odc 367variant, which can support files up to 8 gigabytes. 368