1 .\" Copyright (c) 2003-2007 Tim Kientzle
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
27 .Dd September 16, 2014
32 .Nd copy files to and from archives
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,
58 is a mode indicator from the following list:
59 .Bl -tag -compact -width indent
62 Read an archive from standard input (unless overridden) and extract the
63 contents to disk or (if the
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.
71 Read a list of filenames from standard input and produce a new archive
72 on standard output (unless overridden) containing the specified items.
75 Read a list of filenames from standard input and copy the files to the
80 Unless specifically stated otherwise, options are applicable in
82 .Bl -tag -width indent
84 Read filenames separated by NUL characters instead of newlines.
85 This is necessary if any of the filenames being read might contain newlines.
88 Append to the specified archive.
89 (Not yet implemented.)
92 Reset access times on files after they are read.
95 Block output to records of 5120 bytes.
98 Block output to records of
103 Use the old POSIX portable character format.
105 .Fl Fl format Ar odc .
106 .It Fl d , Fl Fl make-directories
108 Create directories as necessary.
111 Read list of file name patterns from
114 .It Fl F Ar file , Fl Fl file Ar file
115 Read archive from or write archive to
119 Ignore files that match
121 .It Fl H Ar format , Fl Fl format Ar format
123 Produce the output archive in the specified format.
124 Supported formats include:
126 .Bl -tag -width "iso9660" -compact
131 The SVR4 portable cpio format.
133 The old POSIX.1 portable octet-oriented cpio format.
135 The POSIX.1 pax format, an extension of the ustar format.
137 The POSIX.1 tar format.
140 The default format is
143 .Xr libarchive-formats 5
144 for more complete information about the
145 formats currently supported by the underlying
148 .It Fl h , Fl Fl help
149 Print usage information.
153 .It Fl i , Fl Fl extract
155 See above for description.
158 Disable security checks during extraction or copying.
159 This allows extraction via symbolic links, absolute paths,
160 and path names containing
165 Compress the file with xz-compatible compression before writing it.
166 In input mode, this option is ignored; xz compression is recognized
167 automatically on input.
173 All symbolic links will be followed.
174 Normally, symbolic links are archived and copied as symbolic links.
175 With this option, the target of the link will be archived or copied instead.
176 .It Fl l , Fl Fl link
178 Create links from the target directory to the original files,
182 Compress the resulting archive with
184 In input mode, this option is ignored.
187 Compress the archive with lz4-compatible compression before writing it.
188 In input mode, this option is ignored; lz4 compression is recognized
189 automatically on input.
192 Compress the archive with zstd-compatible compression before writing it.
193 In input mode, this option is ignored; zstd compression is recognized
194 automatically on input.
197 Compress the file with lzma-compatible compression before writing it.
198 In input mode, this option is ignored; lzma compression is recognized
199 automatically on input.
202 Compress the resulting archive with
204 In input mode, this option is ignored.
205 .It Fl Fl passphrase Ar passphrase
208 is used to extract or create an encrypted archive.
209 Currently, zip is only a format that
211 can handle encrypted archives.
212 You shouldn't use this option unless you realize how insecure
213 use of this option is.
214 .It Fl m , Fl Fl preserve-modification-time
216 Set file modification time on created files to match
218 .It Fl n , Fl Fl numeric-uid-gid
221 Display numeric uid and gid.
224 displays the user and group names when they are provided in the
225 archive, or looks up the user and group names in the system
227 .It Fl Fl no-preserve-owner
229 Do not attempt to restore file ownership.
230 This is the default when run by non-root users.
234 .It Fl o , Fl Fl create
236 See above for description.
237 .It Fl p , Fl Fl pass-through
239 See above for description.
240 .It Fl Fl preserve-owner
242 Restore file ownership.
243 This is the default when run by the root user.
245 Suppress unnecessary messages.
246 .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
247 Set the owner and/or group on files in the output.
248 If group is specified with no user
251 then the group will be set but not the user.
252 If the user is specified with a trailing colon and no group
255 then the group will be set to the user's default group.
256 If the user is specified with no trailing colon, then
257 the user will be set but not the group.
262 modes, this option can only be used by the super-user.
263 (For compatibility, a period can be used in place of the colon.)
266 Rename files interactively.
267 For each file, a prompt is written to
269 containing the name of the file and a line is read from
271 If the line read is blank, the file is skipped.
272 If the line contains a single period, the file is processed normally.
273 Otherwise, the line is taken to be the new name of the file.
274 .It Fl t , Fl Fl list
276 List the contents of the archive to stdout;
277 do not restore the contents to disk.
278 .It Fl u , Fl Fl unconditional
280 Unconditionally overwrite existing files.
281 Ordinarily, an older file will not overwrite a newer file on disk.
283 Print a dot to stderr for each file as it is processed.
286 .It Fl v , Fl Fl verbose
287 Print the name of each file to stderr as it is processed.
290 provide a detailed listing of each file.
292 Print the program version information and exit.
295 Compress the archive with bzip2-compatible compression before writing it.
296 In input mode, this option is ignored;
297 bzip2 compression is recognized automatically on input.
300 Compress the archive with compress-compatible compression before writing it.
301 In input mode, this option is ignored;
302 compression is recognized automatically on input.
305 Compress the archive with gzip-compatible compression before writing it.
306 In input mode, this option is ignored;
307 gzip compression is recognized automatically on input.
312 The following environment variables affect the execution of
314 .Bl -tag -width ".Ev BLOCKSIZE"
319 for more information.
321 The timezone to use when displaying dates.
324 for more information.
329 command is traditionally used to copy file hierarchies in conjunction
333 The first example here simply copies all files from
337 .Dl Nm find Pa src | Nm Fl pmud Pa dest
339 By carefully selecting options to the
341 command and combining it with other standard utilities,
342 it is possible to exercise very fine control over which files are copied.
343 This next example copies files from
347 that are more than 2 days old and whose names match a particular pattern:
348 .Dl Nm find Pa src Fl mtime Ar +2 | Nm grep foo[bar] | Nm Fl pdmu Pa dest
350 This example copies files from
354 that are more than 2 days old and which contain the word
356 .Dl Nm find Pa src Fl mtime Ar +2 | Nm xargs Nm grep -l foobar | Nm Fl pdmu Pa dest
358 The mode options i, o, and p and the options
359 a, B, c, d, f, l, m, r, t, u, and v comply with SUSv2.
361 The old POSIX.1 standard specified that only
366 were interpreted as command-line options.
367 Each took a single argument of a list of modifier
369 For example, the standard syntax allows
379 are only modifiers to
381 they are not command-line options in their own right.
382 The syntax supported by this implementation is backwards-compatible
384 For best compatibility, scripts should limit themselves to the
394 .Xr libarchive-formats 5 ,
397 There is no current POSIX standard for the cpio command; it appeared
403 The cpio, ustar, and pax interchange file formats are defined by
411 utilities were written by Dick Haight
412 while working in AT&T's Unix Support Group.
413 They first appeared in 1977 in PWB/UNIX 1.0, the
414 .Dq Programmer's Work Bench
415 system developed for use within AT&T.
416 They were first released outside of AT&T as part of System III Unix in 1981.
421 even though it was not well-known outside of AT&T until some time later.
423 This is a complete re-implementation based on the
427 The cpio archive format has several basic limitations:
428 It does not store user and group names, only numbers.
429 As a result, it cannot be reliably used to transfer
430 files between systems with dissimilar user and group numbering.
431 Older cpio formats limit the user and group numbers to
432 16 or 18 bits, which is insufficient for modern systems.
433 The cpio archive formats cannot support files over 4 gigabytes,
436 variant, which can support files up to 8 gigabytes.