cp/cp.1

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