Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[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.16.2.6 2002/08/10 13:20:19 johan Exp $
37 .\" $DragonFly: src/bin/cp/cp.1,v 1.2 2003/06/17 04:22:49 dillon Exp $
38 .\"
39 .Dd August 10, 2002
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 This option also causes symbolic links to be copied, rather than
102 indirected through, and for
103 .Nm
104 to create special files rather than copying them as normal files.
105 Created directories have the same mode as the corresponding source
106 directory, unmodified by the process' umask.
107 .Pp
108 Note that
109 .Nm
110 copies hard linked files as separate files.
111 If you need to preserve hard links, consider using
112 .Xr tar 1 ,
113 .Xr cpio 1 ,
114 or
115 .Xr pax 1
116 instead.
117 .It Fl f
118 For each existing destination pathname, remove it and
119 create a new file, without prompting for confirmation
120 regardless of its permissions.
121 (The
122 .Fl f
123 option overrides any previous
124 .Fl i
125 or
126 .Fl n
127 options.)
128 .It Fl i
129 Cause
130 .Nm
131 to write a prompt to the standard error output before copying a file
132 that would overwrite an existing file.
133 If the response from the standard input begins with the character
134 .Sq Li y
135 or
136 .Sq Li Y ,
137 the file copy is attempted.
138 (The
139 .Fl i
140 option overrides any previous
141 .Fl f
142 or
143 .Fl n
144 options.)
145 .It Fl n
146 Do not overwrite an existing file.
147 (The
148 .Fl n
149 option overrides any previous
150 .Fl f
151 or
152 .Fl i
153 options.)
154 .It Fl p
155 Cause
156 .Nm
157 to preserve in the copy as many of the modification time, access time,
158 file flags, file mode, user ID, and group ID as allowed by permissions.
159 .Pp
160 If the user ID and group ID cannot be preserved, no error message
161 is displayed and the exit value is not altered.
162 .Pp
163 If the source file has its set user ID bit on and the user ID cannot
164 be preserved, the set user ID bit is not preserved
165 in the copy's permissions.
166 If the source file has its set group ID bit on and the group ID cannot
167 be preserved, the set group ID bit is not preserved
168 in the copy's permissions.
169 If the source file has both its set user ID and set group ID bits on,
170 and either the user ID or group ID cannot be preserved, neither
171 the set user ID nor set group ID bits are preserved in the copy's
172 permissions.
173 .It Fl v
174 Cause
175 .Nm
176 to be verbose, showing files as they are copied.
177 .El
178 .Pp
179 For each destination file that already exists, its contents are
180 overwritten if permissions allow.  Its mode, user ID, and group
181 ID are unchanged unless the
182 .Fl p
183 option was specified.
184 .Pp
185 In the second synopsis form,
186 .Ar target_directory
187 must exist unless there is only one named
188 .Ar source_file
189 which is a directory and the
190 .Fl R
191 flag is specified.
192 .Pp
193 If the destination file does not exist, the mode of the source file is
194 used as modified by the file mode creation mask
195 .Pf ( Ic umask ,
196 see
197 .Xr csh 1 ) .
198 If the source file has its set user ID bit on, that bit is removed
199 unless both the source file and the destination file are owned by the
200 same user.
201 If the source file has its set group ID bit on, that bit is removed
202 unless both the source file and the destination file are in the same
203 group and the user is a member of that group.
204 If both the set user ID and set group ID bits are set, all of the above
205 conditions must be fulfilled or both bits are removed.
206 .Pp
207 Appropriate permissions are required for file creation or overwriting.
208 .Pp
209 Symbolic links are always followed unless the
210 .Fl R
211 flag is set, in which case symbolic links are not followed, by default.
212 The
213 .Fl H
214 or
215 .Fl L
216 flags (in conjunction with the
217 .Fl R
218 flag) cause symbolic links to be followed as described above.
219 The
220 .Fl H ,
221 .Fl L
222 and
223 .Fl P
224 options are ignored unless the
225 .Fl R
226 option is specified.
227 In addition, these options override each other and the
228 command's actions are determined by the last one specified.
229 .Sh DIAGNOSTICS
230 .Ex -std
231 .Sh COMPATIBILITY
232 Historic versions of the
233 .Nm
234 utility had a
235 .Fl r
236 option.
237 This implementation supports that option, however, its use is strongly
238 discouraged, as it does not correctly copy special files, symbolic links
239 or fifo's.
240 .Pp
241 The
242 .Fl v
243 and
244 .Fl n
245 options are non-standard and their use in scripts is not recommended.
246 .Sh SEE ALSO
247 .Xr mv 1 ,
248 .Xr rcp 1 ,
249 .Xr umask 2 ,
250 .Xr fts 3 ,
251 .Xr symlink 7
252 .Sh STANDARDS
253 The
254 .Nm
255 command is expected to be
256 .St -p1003.2
257 compatible.
258 .Sh HISTORY
259 A
260 .Nm
261 command appeared in
262 .At v1 .