contrib/libarchive/cpio/bsdcpio.1

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