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 October 7, 2012 28.Dt CPIO 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 overridden) 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 overridden) 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 0 , Fl Fl null 84Read filenames separated by NUL characters instead of newlines. 85This is necessary if any of the filenames being read might contain newlines. 86.It Fl A 87(o mode only) 88Append to the specified archive. 89(Not yet implemented.) 90.It Fl a 91(o and p modes) 92Reset access times on files after they are read. 93.It Fl B 94(o mode only) 95Block output to records of 5120 bytes. 96.It Fl C Ar size 97(o mode only) 98Block output to records of 99.Ar size 100bytes. 101.It Fl c 102(o mode only) 103Use the old POSIX portable character format. 104Equivalent to 105.Fl Fl format Ar odc . 106.It Fl d , Fl Fl make-directories 107(i and p modes) 108Create directories as necessary. 109.It Fl E Ar file 110(i mode only) 111Read list of file name patterns from 112.Ar file 113to list and extract. 114.It Fl F Ar file , Fl Fl file Ar file 115Read archive from or write archive to 116.Ar file . 117.It Fl f Ar pattern 118(i mode only) 119Ignore files that match 120.Ar pattern . 121.It Fl H Ar format , Fl Fl format Ar format 122(o mode only) 123Produce the output archive in the specified format. 124Supported formats include: 125.Pp 126.Bl -tag -width "iso9660" -compact 127.It Ar cpio 128Synonym for 129.Ar odc . 130.It Ar newc 131The SVR4 portable cpio format. 132.It Ar odc 133The old POSIX.1 portable octet-oriented cpio format. 134.It Ar pax 135The POSIX.1 pax format, an extension of the ustar format. 136.It Ar ustar 137The POSIX.1 tar format. 138.El 139.Pp 140The default format is 141.Ar odc . 142See 143.Xr libarchive-formats 5 144for more complete information about the 145formats currently supported by the underlying 146.Xr libarchive 3 147library. 148.It Fl h , Fl Fl help 149Print usage information. 150.It Fl I Ar file 151Read archive from 152.Ar file . 153.It Fl i , Fl Fl extract 154Input mode. 155See above for description. 156.It Fl Fl insecure 157(i and p mode only) 158Disable security checks during extraction or copying. 159This allows extraction via symbolic links and path names containing 160.Sq .. 161in the name. 162.It Fl J , Fl Fl xz 163(o mode only) 164Compress the file with xz-compatible compression before writing it. 165In input mode, this option is ignored; xz compression is recognized 166automatically on input. 167.It Fl j 168Synonym for 169.Fl y . 170.It Fl L 171(o and p modes) 172All symbolic links will be followed. 173Normally, symbolic links are archived and copied as symbolic links. 174With this option, the target of the link will be archived or copied instead. 175.It Fl l , Fl Fl link 176(p mode only) 177Create links from the target directory to the original files, 178instead of copying. 179.It Fl Fl lrzip 180(o mode only) 181Compress the resulting archive with 182.Xr lrzip 1 . 183In input mode, this option is ignored. 184.It Fl Fl lzma 185(o mode only) 186Compress the file with lzma-compatible compression before writing it. 187In input mode, this option is ignored; lzma compression is recognized 188automatically on input. 189.It Fl Fl lzop 190(o mode only) 191Compress the resulting archive with 192.Xr lzop 1 . 193In input mode, this option is ignored. 194.It Fl m , Fl Fl preserve-modification-time 195(i and p modes) 196Set file modification time on created files to match 197those in the source. 198.It Fl n , Fl Fl numeric-uid-gid 199(i mode, only with 200.Fl t ) 201Display numeric uid and gid. 202By default, 203.Nm 204displays the user and group names when they are provided in the 205archive, or looks up the user and group names in the system 206password database. 207.It Fl Fl no-preserve-owner 208(i mode only) 209Do not attempt to restore file ownership. 210This is the default when run by non-root users. 211.It Fl O Ar file 212Write archive to 213.Ar file . 214.It Fl o , Fl Fl create 215Output mode. 216See above for description. 217.It Fl p , Fl Fl pass-through 218Pass-through mode. 219See above for description. 220.It Fl Fl preserve-owner 221(i mode only) 222Restore file ownership. 223This is the default when run by the root user. 224.It Fl Fl quiet 225Suppress unnecessary messages. 226.It Fl R Oo user Oc Ns Oo : Oc Ns Oo group Oc , Fl Fl owner Oo user Oc Ns Oo : Oc Ns Oo group Oc 227Set the owner and/or group on files in the output. 228If group is specified with no user 229(for example, 230.Fl R Ar :wheel ) 231then the group will be set but not the user. 232If the user is specified with a trailing colon and no group 233(for example, 234.Fl R Ar root: ) 235then the group will be set to the user's default group. 236If the user is specified with no trailing colon, then 237the user will be set but not the group. 238In 239.Fl i 240and 241.Fl p 242modes, this option can only be used by the super-user. 243(For compatibility, a period can be used in place of the colon.) 244.It Fl r 245(All modes.) 246Rename files interactively. 247For each file, a prompt is written to 248.Pa /dev/tty 249containing the name of the file and a line is read from 250.Pa /dev/tty . 251If the line read is blank, the file is skipped. 252If the line contains a single period, the file is processed normally. 253Otherwise, the line is taken to be the new name of the file. 254.It Fl t , Fl Fl list 255(i mode only) 256List the contents of the archive to stdout; 257do not restore the contents to disk. 258.It Fl u , Fl Fl unconditional 259(i and p modes) 260Unconditionally overwrite existing files. 261Ordinarily, an older file will not overwrite a newer file on disk. 262.It Fl V , Fl Fl dot 263Print a dot to stderr for each file as it is processed. 264Superseded by 265.Fl v . 266.It Fl v , Fl Fl verbose 267Print the name of each file to stderr as it is processed. 268With 269.Fl t , 270provide a detailed listing of each file. 271.It Fl Fl version 272Print the program version information and exit. 273.It Fl y 274(o mode only) 275Compress the archive with bzip2-compatible compression before writing it. 276In input mode, this option is ignored; 277bzip2 compression is recognized automatically on input. 278.It Fl Z 279(o mode only) 280Compress the archive with compress-compatible compression before writing it. 281In input mode, this option is ignored; 282compression is recognized automatically on input. 283.It Fl z 284(o mode only) 285Compress the archive with gzip-compatible compression before writing it. 286In input mode, this option is ignored; 287gzip compression is recognized automatically on input. 288.El 289.Sh EXIT STATUS 290.Ex -std 291.Sh ENVIRONMENT 292The following environment variables affect the execution of 293.Nm : 294.Bl -tag -width ".Ev BLOCKSIZE" 295.It Ev LANG 296The locale to use. 297See 298.Xr environ 7 299for more information. 300.It Ev TZ 301The timezone to use when displaying dates. 302See 303.Xr environ 7 304for more information. 305.El 306.Sh EXAMPLES 307The 308.Nm 309command is traditionally used to copy file hierarchies in conjunction 310with the 311.Xr find 1 312command. 313The first example here simply copies all files from 314.Pa src 315to 316.Pa dest : 317.Dl Nm find Pa src | Nm Fl pmud Pa dest 318.Pp 319By carefully selecting options to the 320.Xr find 1 321command and combining it with other standard utilities, 322it is possible to exercise very fine control over which files are copied. 323This next example copies files from 324.Pa src 325to 326.Pa dest 327that are more than 2 days old and whose names match a particular pattern: 328.Dl Nm find Pa src Fl mtime Ar +2 | Nm grep foo[bar] | Nm Fl pdmu Pa dest 329.Pp 330This example copies files from 331.Pa src 332to 333.Pa dest 334that are more than 2 days old and which contain the word 335.Do foobar Dc : 336.Dl Nm find Pa src Fl mtime Ar +2 | Nm xargs Nm grep -l foobar | Nm Fl pdmu Pa dest 337.Sh COMPATIBILITY 338The mode options i, o, and p and the options 339a, B, c, d, f, l, m, r, t, u, and v comply with SUSv2. 340.Pp 341The old POSIX.1 standard specified that only 342.Fl i , 343.Fl o , 344and 345.Fl p 346were interpreted as command-line options. 347Each took a single argument of a list of modifier 348characters. 349For example, the standard syntax allows 350.Fl imu 351but does not support 352.Fl miu 353or 354.Fl i Fl m Fl u , 355since 356.Ar m 357and 358.Ar u 359are only modifiers to 360.Fl i , 361they are not command-line options in their own right. 362The syntax supported by this implementation is backwards-compatible 363with the standard. 364For best compatibility, scripts should limit themselves to the 365standard syntax. 366.Sh SEE ALSO 367.Xr bzip2 1 , 368.Xr tar 1 , 369.Xr gzip 1 , 370.Xr mt 1 , 371.Xr pax 1 , 372.Xr libarchive 3 , 373.Xr cpio 5 , 374.Xr libarchive-formats 5 , 375.Xr tar 5 376.Sh STANDARDS 377There is no current POSIX standard for the cpio command; it appeared 378in 379.St -p1003.1-96 380but was dropped from 381.St -p1003.1-2001 . 382.Pp 383The cpio, ustar, and pax interchange file formats are defined by 384.St -p1003.1-2001 385for the pax command. 386.Sh HISTORY 387The original 388.Nm cpio 389and 390.Nm find 391utilities were written by Dick Haight 392while working in AT&T's Unix Support Group. 393They first appeared in 1977 in PWB/UNIX 1.0, the 394.Dq Programmer's Work Bench 395system developed for use within AT&T. 396They were first released outside of AT&T as part of System III Unix in 1981. 397As a result, 398.Nm cpio 399actually predates 400.Nm tar , 401even though it was not well-known outside of AT&T until some time later. 402.Pp 403This is a complete re-implementation based on the 404.Xr libarchive 3 405library. 406.Sh BUGS 407The cpio archive format has several basic limitations: 408It does not store user and group names, only numbers. 409As a result, it cannot be reliably used to transfer 410files between systems with dissimilar user and group numbering. 411Older cpio formats limit the user and group numbers to 41216 or 18 bits, which is insufficient for modern systems. 413The cpio archive formats cannot support files over 4 gigabytes, 414except for the 415.Dq odc 416variant, which can support files up to 8 gigabytes. 417