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 September 16, 2014 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.Fl i 36.Op Ar options 37.Op Ar pattern ... 38.Op Ar < archive 39.Nm 40.Fl o 41.Op Ar options 42.Ar < name-list 43.Op Ar > archive 44.Nm 45.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, absolute paths, 160and path names containing 161.Sq .. 162in the name. 163.It Fl J , Fl Fl xz 164(o mode only) 165Compress the file with xz-compatible compression before writing it. 166In input mode, this option is ignored; xz compression is recognized 167automatically on input. 168.It Fl j 169Synonym for 170.Fl y . 171.It Fl L 172(o and p modes) 173All symbolic links will be followed. 174Normally, symbolic links are archived and copied as symbolic links. 175With this option, the target of the link will be archived or copied instead. 176.It Fl l , Fl Fl link 177(p mode only) 178Create links from the target directory to the original files, 179instead of copying. 180.It Fl Fl lrzip 181(o mode only) 182Compress the resulting archive with 183.Xr lrzip 1 . 184In input mode, this option is ignored. 185.It Fl Fl lz4 186(o mode only) 187Compress the archive with lz4-compatible compression before writing it. 188In input mode, this option is ignored; lz4 compression is recognized 189automatically on input. 190.It Fl Fl lzma 191(o mode only) 192Compress the file with lzma-compatible compression before writing it. 193In input mode, this option is ignored; lzma compression is recognized 194automatically on input. 195.It Fl Fl lzop 196(o mode only) 197Compress the resulting archive with 198.Xr lzop 1 . 199In input mode, this option is ignored. 200.It Fl Fl passphrase Ar passphrase 201The 202.Pa passphrase 203is used to extract or create an encrypted archive. 204Currently, zip is only a format that 205.Nm 206can handle encrypted archives. 207You shouldn't use this option unless you realize how insecure 208use of this option is. 209.It Fl m , Fl Fl preserve-modification-time 210(i and p modes) 211Set file modification time on created files to match 212those in the source. 213.It Fl n , Fl Fl numeric-uid-gid 214(i mode, only with 215.Fl t ) 216Display numeric uid and gid. 217By default, 218.Nm 219displays the user and group names when they are provided in the 220archive, or looks up the user and group names in the system 221password database. 222.It Fl Fl no-preserve-owner 223(i mode only) 224Do not attempt to restore file ownership. 225This is the default when run by non-root users. 226.It Fl O Ar file 227Write archive to 228.Ar file . 229.It Fl o , Fl Fl create 230Output mode. 231See above for description. 232.It Fl p , Fl Fl pass-through 233Pass-through mode. 234See above for description. 235.It Fl Fl preserve-owner 236(i mode only) 237Restore file ownership. 238This is the default when run by the root user. 239.It Fl Fl quiet 240Suppress unnecessary messages. 241.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 242Set the owner and/or group on files in the output. 243If group is specified with no user 244(for example, 245.Fl R Ar :wheel ) 246then the group will be set but not the user. 247If the user is specified with a trailing colon and no group 248(for example, 249.Fl R Ar root: ) 250then the group will be set to the user's default group. 251If the user is specified with no trailing colon, then 252the user will be set but not the group. 253In 254.Fl i 255and 256.Fl p 257modes, this option can only be used by the super-user. 258(For compatibility, a period can be used in place of the colon.) 259.It Fl r 260(All modes.) 261Rename files interactively. 262For each file, a prompt is written to 263.Pa /dev/tty 264containing the name of the file and a line is read from 265.Pa /dev/tty . 266If the line read is blank, the file is skipped. 267If the line contains a single period, the file is processed normally. 268Otherwise, the line is taken to be the new name of the file. 269.It Fl t , Fl Fl list 270(i mode only) 271List the contents of the archive to stdout; 272do not restore the contents to disk. 273.It Fl u , Fl Fl unconditional 274(i and p modes) 275Unconditionally overwrite existing files. 276Ordinarily, an older file will not overwrite a newer file on disk. 277.It Fl V , Fl Fl dot 278Print a dot to stderr for each file as it is processed. 279Superseded by 280.Fl v . 281.It Fl v , Fl Fl verbose 282Print the name of each file to stderr as it is processed. 283With 284.Fl t , 285provide a detailed listing of each file. 286.It Fl Fl version 287Print the program version information and exit. 288.It Fl y 289(o mode only) 290Compress the archive with bzip2-compatible compression before writing it. 291In input mode, this option is ignored; 292bzip2 compression is recognized automatically on input. 293.It Fl Z 294(o mode only) 295Compress the archive with compress-compatible compression before writing it. 296In input mode, this option is ignored; 297compression is recognized automatically on input. 298.It Fl z 299(o mode only) 300Compress the archive with gzip-compatible compression before writing it. 301In input mode, this option is ignored; 302gzip compression is recognized automatically on input. 303.El 304.Sh EXIT STATUS 305.Ex -std 306.Sh ENVIRONMENT 307The following environment variables affect the execution of 308.Nm : 309.Bl -tag -width ".Ev BLOCKSIZE" 310.It Ev LANG 311The locale to use. 312See 313.Xr environ 7 314for more information. 315.It Ev TZ 316The timezone to use when displaying dates. 317See 318.Xr environ 7 319for more information. 320.El 321.Sh EXAMPLES 322The 323.Nm 324command is traditionally used to copy file hierarchies in conjunction 325with the 326.Xr find 1 327command. 328The first example here simply copies all files from 329.Pa src 330to 331.Pa dest : 332.Dl Nm find Pa src | Nm Fl pmud Pa dest 333.Pp 334By carefully selecting options to the 335.Xr find 1 336command and combining it with other standard utilities, 337it is possible to exercise very fine control over which files are copied. 338This next example copies files from 339.Pa src 340to 341.Pa dest 342that are more than 2 days old and whose names match a particular pattern: 343.Dl Nm find Pa src Fl mtime Ar +2 | Nm grep foo[bar] | Nm Fl pdmu Pa dest 344.Pp 345This example copies files from 346.Pa src 347to 348.Pa dest 349that are more than 2 days old and which contain the word 350.Do foobar Dc : 351.Dl Nm find Pa src Fl mtime Ar +2 | Nm xargs Nm grep -l foobar | Nm Fl pdmu Pa dest 352.Sh COMPATIBILITY 353The mode options i, o, and p and the options 354a, B, c, d, f, l, m, r, t, u, and v comply with SUSv2. 355.Pp 356The old POSIX.1 standard specified that only 357.Fl i , 358.Fl o , 359and 360.Fl p 361were interpreted as command-line options. 362Each took a single argument of a list of modifier 363characters. 364For example, the standard syntax allows 365.Fl imu 366but does not support 367.Fl miu 368or 369.Fl i Fl m Fl u , 370since 371.Ar m 372and 373.Ar u 374are only modifiers to 375.Fl i , 376they are not command-line options in their own right. 377The syntax supported by this implementation is backwards-compatible 378with the standard. 379For best compatibility, scripts should limit themselves to the 380standard syntax. 381.Sh SEE ALSO 382.Xr bzip2 1 , 383.Xr tar 1 , 384.Xr gzip 1 , 385.Xr mt 1 , 386.Xr pax 1 , 387.Xr libarchive 3 , 388.Xr cpio 5 , 389.Xr libarchive-formats 5 , 390.Xr tar 5 391.Sh STANDARDS 392There is no current POSIX standard for the cpio command; it appeared 393in 394.St -p1003.1-96 395but was dropped from 396.St -p1003.1-2001 . 397.Pp 398The cpio, ustar, and pax interchange file formats are defined by 399.St -p1003.1-2001 400for the pax command. 401.Sh HISTORY 402The original 403.Nm cpio 404and 405.Nm find 406utilities were written by Dick Haight 407while working in AT&T's Unix Support Group. 408They first appeared in 1977 in PWB/UNIX 1.0, the 409.Dq Programmer's Work Bench 410system developed for use within AT&T. 411They were first released outside of AT&T as part of System III Unix in 1981. 412As a result, 413.Nm cpio 414actually predates 415.Nm tar , 416even though it was not well-known outside of AT&T until some time later. 417.Pp 418This is a complete re-implementation based on the 419.Xr libarchive 3 420library. 421.Sh BUGS 422The cpio archive format has several basic limitations: 423It does not store user and group names, only numbers. 424As a result, it cannot be reliably used to transfer 425files between systems with dissimilar user and group numbering. 426Older cpio formats limit the user and group numbers to 42716 or 18 bits, which is insufficient for modern systems. 428The cpio archive formats cannot support files over 4 gigabytes, 429except for the 430.Dq odc 431variant, which can support files up to 8 gigabytes. 432