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