cp/cp.1

   1 .\"     $NetBSD: cp.1,v 1.12 1997/10/11 02:14:42 enami Exp $
   2 .\"
   3 .\" Copyright (c) 1989, 1990, 1993, 1994
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to Berkeley by
   7 .\" the Institute of Electrical and Electronics Engineers, Inc.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. All advertising materials mentioning features or use of this software
  18 .\"    must display the following acknowledgement:
  19 .\"     This product includes software developed by the University of
  20 .\"     California, Berkeley and its contributors.
  21 .\" 4. Neither the name of the University nor the names of its contributors
  22 .\"    may be used to endorse or promote products derived from this software
  23 .\"    without specific prior written permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  26 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  29 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35 .\" SUCH DAMAGE.
  36 .\"
  37 .\"     @(#)cp.1        8.3 (Berkeley) 4/18/94
  38 .\"
  39 .Dd April 18, 1994
  40 .Dt CP 1
  41 .Os BSD 4
  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
  52 .Op Fl p
  53 .Ar source_file target_file
  54 .Nm cp
  55 .Oo
  56 .Fl R
  57 .Op Fl H | Fl L | Fl P
  58 .Oc
  59 .Op Fl f | i
  60 .Op Fl p
  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 .It Fl R
  95 If
  96 .Ar source_file
  97 designates a directory,
  98 .Nm
  99 copies the directory and the entire subtree connected at that point.
 100 This option also causes symbolic links to be copied, rather than
 101 indirected through, and for
 102 .Nm
 103 to create special files rather than copying them as normal files.
 104 Created directories have the same mode as the corresponding source
 105 directory, unmodified by the process' umask.
 106 .It Fl f
 107 Foreach existing destination pathname, attempt to overwrite it. If permissions
 108 do not allow copy to succeed, remove it and create a new file, without
 109 prompting for confirmation.
 110 (The
 111 .Fl i
 112 option is ignored if the
 113 .Fl f
 114 option is specified.)
 115 .It Fl i
 116 Causes
 117 .Nm
 118 to write a prompt to the standard error output before copying a file
 119 that would overwrite an existing file.
 120 If the response from the standard input begins with the character
 121 .Sq Li y ,
 122 the file copy is attempted.
 123 .It Fl p
 124 Causes
 125 .Nm
 126 to preserve in the copy as many of the modification time, access time,
 127 file flags, file mode, user ID, and group ID as allowed by permissions.
 128 .Pp
 129 If the user ID and group ID cannot be preserved, no error message
 130 is displayed and the exit value is not altered.
 131 .Pp
 132 If the source file has its set user ID bit on and the user ID cannot
 133 be preserved, the set user ID bit is not preserved
 134 in the copy's permissions.
 135 If the source file has its set group ID bit on and the group ID cannot
 136 be preserved, the set group ID bit is not preserved
 137 in the copy's permissions.
 138 If the source file has both its set user ID and set group ID bits on,
 139 and either the user ID or group ID cannot be preserved, neither
 140 the set user ID or set group ID bits are preserved in the copy's
 141 permissions.
 142 .El
 143 .Pp
 144 For each destination file that already exists, its contents are
 145 overwritten if permissions allow, but its mode, user ID, and group
 146 ID are unchanged.
 147 .Pp
 148 In the second synopsis form,
 149 .Ar target_directory
 150 must exist unless there is only one named
 151 .Ar source_file
 152 which is a directory and the
 153 .Fl R
 154 flag is specified.
 155 .Pp
 156 If the destination file does not exist, the mode of the source file is
 157 used as modified by the file mode creation mask
 158 .Pf ( Ic umask ,
 159 see
 160 .Xr csh 1 ) .
 161 If the source file has its set user ID bit on, that bit is removed
 162 unless both the source file and the destination file are owned by the
 163 same user.
 164 If the source file has its set group ID bit on, that bit is removed
 165 unless both the source file and the destination file are in the same
 166 group and the user is a member of that group.
 167 If both the set user ID and set group ID bits are set, all of the above
 168 conditions must be fulfilled or both bits are removed.
 169 .Pp
 170 Appropriate permissions are required for file creation or overwriting.
 171 .Pp
 172 Symbolic links are always followed unless the
 173 .Fl R
 174 flag is set, in which case symbolic links are not followed, by default.
 175 The
 176 .Fl H
 177 or
 178 .Fl L
 179 flags (in conjunction with the
 180 .Fl R
 181 flag) cause symbolic links to be followed as described above.
 182 The
 183 .Fl H ,
 184 .Fl L
 185 and
 186 .Fl P
 187 options are ignored unless the
 188 .Fl R
 189 option is specified.
 190 In addition, these options override each other and the
 191 command's actions are determined by the last one specified.
 192 .Pp
 193 .Nm
 194 exits 0 on success, >0 if an error occurred.
 195 .Sh COMPATIBILITY
 196 Historic versions of the
 197 .Nm
 198 utility had a
 199 .Fl r
 200 option.
 201 This implementation supports that option, however, its use is strongly
 202 discouraged, as it does not correctly copy special files, symbolic links
 203 or fifo's.
 204 .Sh SEE ALSO
 205 .Xr mv 1 ,
 206 .Xr rcp 1 ,
 207 .Xr umask 2 ,
 208 .Xr fts 3 ,
 209 .Xr symlink 7
 210 .Sh STANDARDS
 211 The
 212 .Nm
 213 utility is expected to be
 214 .St -p1003.2
 215 compatible.