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
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 overriden) 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 overriden) 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.
108
Create directories as necessary.
111
Read list of file name patterns from
115
Read archive from or write archive to
119
Ignore files that match
121
.It 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
152
Print usage information.
158
See above for description.
161
Disable security checks during extraction or copying.
162
This allows extraction via symbolic links and path names containing
167
Compress the file with xz-compatible compression before writing it.
168
In input mode, this option is ignored; xz compression is recognized
169
automatically on input.
175
All symbolic links will be followed.
176
Normally, symbolic links are archived and copied as symbolic links.
177
With this option, the target of the link will be archived or copied instead.
180
Create links from the target directory to the original files,
184
Compress the file with lzma-compatible compression before writing it.
185
In input mode, this option is ignored; lzma compression is recognized
186
automatically on input.
189
Set file modification time on created files to match
194
Display numeric uid and gid.
197
displays the user and group names when they are provided in the
198
archive, or looks up the user and group names in the system
200
.It Fl no-preserve-owner
202
Do not attempt to restore file ownership.
203
This is the default when run by non-root users.
209
See above for description.
212
See above for description.
213
.It Fl preserve-owner
215
Restore file ownership.
216
This is the default when run by the root user.
218
Suppress unnecessary messages.
219
.It Fl R Oo user Oc Ns Oo : Oc Ns Oo group Oc
220
Set the owner and/or group on files in the output.
221
If group is specified with no user
224
then the group will be set but not the user.
225
If the user is specified with a trailing colon and no group
228
then the group will be set to the user's default group.
229
If the user is specified with no trailing colon, then
230
the user will be set but not the group.
235
modes, this option can only be used by the super-user.
236
(For compatibility, a period can be used in place of the colon.)
239
Rename files interactively.
240
For each file, a prompt is written to
242
containing the name of the file and a line is read from
244
If the line read is blank, the file is skipped.
245
If the line contains a single period, the file is processed normally.
246
Otherwise, the line is taken to be the new name of the file.
249
List the contents of the archive to stdout;
250
do not restore the contents to disk.
253
Unconditionally overwrite existing files.
254
Ordinarily, an older file will not overwrite a newer file on disk.
256
Print the name of each file to stderr as it is processed.
259
provide a detailed listing of each file.
261
Print the program version information and exit.
264
Compress the archive with bzip2-compatible compression before writing it.
265
In input mode, this option is ignored;
266
bzip2 compression is recognized automatically on input.
269
Compress the archive with compress-compatible compression before writing it.
270
In input mode, this option is ignored;
271
compression is recognized automatically on input.
274
Compress the archive with gzip-compatible compression before writing it.
275
In input mode, this option is ignored;
276
gzip compression is recognized automatically on input.
279
The following environment variables affect the execution of
281
.Bl -tag -width ".Ev BLOCKSIZE"
286
for more information.
288
The timezone to use when displaying dates.
291
for more information.
298
command is traditionally used to copy file heirarchies in conjunction
302
The first example here simply copies all files from
306
.Dl Nm find Pa src | Nm Fl pmud Pa dest
308
By carefully selecting options to the
310
command and combining it with other standard utilities,
311
it is possible to exercise very fine control over which files are copied.
312
This next example copies files from
316
that are more than 2 days old and whose names match a particular pattern:
317
.Dl Nm find Pa src Fl mtime Ar +2 | Nm grep foo[bar] | Nm Fl pdmu Pa dest
319
This example copies files from
323
that are more than 2 days old and which contain the word
325
.Dl Nm find Pa src Fl mtime Ar +2 | Nm xargs Nm grep -l foobar | Nm Fl pdmu Pa dest
327
The mode options i, o, and p and the options
328
a, B, c, d, f, l, m, r, t, u, and v comply with SUSv2.
330
The old POSIX.1 standard specified that only
335
were interpreted as command-line options.
336
Each took a single argument of a list of modifier
338
For example, the standard syntax allows
348
are only modifiers to
350
they are not command-line options in their own right.
351
The syntax supported by this implementation is backwards-compatible
353
For best compatibility, scripts should limit themselves to the
363
.Xr libarchive-formats 5 ,
366
There is no current POSIX standard for the cpio command; it appeared
372
The cpio, ustar, and pax interchange file formats are defined by
380
utilities were written by Dick Haight
381
while working in AT&T's Unix Support Group.
382
They first appeared in 1977 in PWB/UNIX 1.0, the
383
.Dq Programmer's Work Bench
384
system developed for use within AT&T.
385
They were first released outside of AT&T as part of System III Unix in 1981.
390
even though it was not well-known outside of AT&T until some time later.
392
This is a complete re-implementation based on the
396
The cpio archive format has several basic limitations:
397
It does not store user and group names, only numbers.
398
As a result, it cannot be reliably used to transfer
399
files between systems with dissimilar user and group numbering.
400
Older cpio formats limit the user and group numbers to
401
16 or 18 bits, which is insufficient for modern systems.
402
The cpio archive formats cannot support files over 4 gigabytes,
405
variant, which can support files up to 8 gigabytes.