The new bridge(4) manual page somehow never found its way into the Makefile.
[dragonfly.git] / bin / cp / cp.1
1 .\" Copyright (c) 1989, 1990, 1993, 1994
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" the Institute of Electrical and Electronics Engineers, Inc.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. All advertising materials mentioning features or use of this software
16 .\"    must display the following acknowledgement:
17 .\"     This product includes software developed by the University of
18 .\"     California, Berkeley and its contributors.
19 .\" 4. Neither the name of the University nor the names of its contributors
20 .\"    may be used to endorse or promote products derived from this software
21 .\"    without specific prior written permission.
22 .\"
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .\" SUCH DAMAGE.
34 .\"
35 .\"     @(#)cp.1        8.3 (Berkeley) 4/18/94
36 .\" $FreeBSD: src/bin/cp/cp.1,v 1.33 2005/02/25 00:40:46 trhodes Exp $
37 .\" $DragonFly: src/bin/cp/cp.1,v 1.6 2005/08/01 01:49:16 swildner Exp $
38 .\"
39 .Dd February 23, 2005
40 .Dt CP 1
41 .Os
42 .Sh NAME
43 .Nm cp
44 .Nd copy files
45 .Sh SYNOPSIS
46 .Nm
47 .Oo
48 .Fl R
49 .Op Fl H | Fl L | Fl P
50 .Oc
51 .Op Fl f | i | n
52 .Op Fl pv
53 .Ar source_file target_file
54 .Nm
55 .Oo
56 .Fl R
57 .Op Fl H | Fl L | Fl P
58 .Oc
59 .Op Fl f | i | n
60 .Op Fl pv
61 .Ar source_file ... target_directory
62 .Sh DESCRIPTION
63 In the first synopsis form, the
64 .Nm
65 utility copies the contents of the
66 .Ar source_file
67 to the
68 .Ar target_file .
69 In the second synopsis form,
70 the contents of each named
71 .Ar source_file
72 is copied to the destination
73 .Ar target_directory .
74 The names of the files themselves are not changed.
75 If
76 .Nm
77 detects an attempt to copy a file to itself, the copy will fail.
78 .Pp
79 The following options are available:
80 .Bl -tag -width flag
81 .It Fl H
82 If the
83 .Fl R
84 option is specified, symbolic links on the command line are followed.
85 (Symbolic links encountered in the tree traversal are not followed.)
86 .It Fl L
87 If the
88 .Fl R
89 option is specified, all symbolic links are followed.
90 .It Fl P
91 If the
92 .Fl R
93 option is specified, no symbolic links are followed.
94 This is the default.
95 .It Fl R
96 If
97 .Ar source_file
98 designates a directory,
99 .Nm
100 copies the directory and the entire subtree connected at that point.
101 If the
102 .Ar source_file
103 ends in a
104 .Pa / ,
105 the contents of the directory are copied rather than the
106 directory itself.
107 This option also causes symbolic links to be copied, rather than
108 indirected through, and for
109 .Nm
110 to create special files rather than copying them as normal files.
111 Created directories have the same mode as the corresponding source
112 directory, unmodified by the process' umask.
113 .Pp
114 Note that
115 .Nm
116 copies hard linked files as separate files.
117 If you need to preserve hard links, consider using
118 .Xr tar 1 ,
119 .Xr cpio 1 ,
120 or
121 .Xr pax 1
122 instead.
123 .It Fl f
124 For each existing destination pathname, remove it and
125 create a new file, without prompting for confirmation
126 regardless of its permissions.
127 (The
128 .Fl f
129 option overrides any previous
130 .Fl i
131 or
132 .Fl n
133 options.)
134 .It Fl i
135 Cause
136 .Nm
137 to write a prompt to the standard error output before copying a file
138 that would overwrite an existing file.
139 If the response from the standard input begins with the character
140 .Sq Li y
141 or
142 .Sq Li Y ,
143 the file copy is attempted.
144 (The
145 .Fl i
146 option overrides any previous
147 .Fl f
148 or
149 .Fl n
150 options.)
151 .It Fl n
152 Do not overwrite an existing file.
153 (The
154 .Fl n
155 option overrides any previous
156 .Fl f
157 or
158 .Fl i
159 options.)
160 .It Fl p
161 Cause
162 .Nm
163 to preserve the following attributes of each source
164 file in the copy: modification time, access time,
165 file flags, file mode, user ID, and group ID, as allowed by permissions.
166 .Pp
167 If the user ID and group ID cannot be preserved, no error message
168 is displayed and the exit value is not altered.
169 .Pp
170 If the source file has its set-user-ID bit on and the user ID cannot
171 be preserved, the set-user-ID bit is not preserved
172 in the copy's permissions.
173 If the source file has its set-group-ID bit on and the group ID cannot
174 be preserved, the set-group-ID bit is not preserved
175 in the copy's permissions.
176 If the source file has both its set-user-ID and set-group-ID bits on,
177 and either the user ID or group ID cannot be preserved, neither
178 the set-user-ID nor set-group-ID bits are preserved in the copy's
179 permissions.
180 .It Fl v
181 Cause
182 .Nm
183 to be verbose, showing files as they are copied.
184 .El
185 .Pp
186 For each destination file that already exists, its contents are
187 overwritten if permissions allow.
188 Its mode, user ID, and group
189 ID are unchanged unless the
190 .Fl p
191 option was specified.
192 .Pp
193 In the second synopsis form,
194 .Ar target_directory
195 must exist unless there is only one named
196 .Ar source_file
197 which is a directory and the
198 .Fl R
199 flag is specified.
200 .Pp
201 If the destination file does not exist, the mode of the source file is
202 used as modified by the file mode creation mask
203 .Pf ( Ic umask ,
204 see
205 .Xr csh 1 ) .
206 If the source file has its set-user-ID bit on, that bit is removed
207 unless both the source file and the destination file are owned by the
208 same user.
209 If the source file has its set-group-ID bit on, that bit is removed
210 unless both the source file and the destination file are in the same
211 group and the user is a member of that group.
212 If both the set-user-ID and set-group-ID bits are set, all of the above
213 conditions must be fulfilled or both bits are removed.
214 .Pp
215 Appropriate permissions are required for file creation or overwriting.
216 .Pp
217 Symbolic links are always followed unless the
218 .Fl R
219 flag is set, in which case symbolic links are not followed, by default.
220 The
221 .Fl H
222 or
223 .Fl L
224 flags (in conjunction with the
225 .Fl R
226 flag) cause symbolic links to be followed as described above.
227 The
228 .Fl H ,
229 .Fl L
230 and
231 .Fl P
232 options are ignored unless the
233 .Fl R
234 option is specified.
235 In addition, these options override each other and the
236 command's actions are determined by the last one specified.
237 .Pp
238 If
239 .Nm
240 receives a
241 .Dv SIGINFO
242 (see the
243 .Cm status
244 argument for
245 .Xr stty 1 )
246 signal, the current input and output file and the percentage complete
247 will be written to standard error.
248 .Sh DIAGNOSTICS
249 .Ex -std
250 .Sh COMPATIBILITY
251 Historic versions of the
252 .Nm
253 utility had a
254 .Fl r
255 option.
256 This implementation supports that option, however, its use is strongly
257 discouraged, as it does not correctly copy special files, symbolic links
258 or fifo's.
259 .Pp
260 The
261 .Fl v
262 and
263 .Fl n
264 options are non-standard and their use in scripts is not recommended.
265 .Sh SEE ALSO
266 .Xr mv 1 ,
267 .Xr rcp 1 ,
268 .Xr umask 2 ,
269 .Xr fts 3 ,
270 .Xr symlink 7
271 .Sh STANDARDS
272 The
273 .Nm
274 command is expected to be
275 .St -p1003.2
276 compatible.
277 .Sh HISTORY
278 A
279 .Nm
280 command appeared in
281 .At v1 .