1.\" $NetBSD: cp.1,v 1.19 2002/02/08 01:21:55 ross 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 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 63In the first synopsis form, the 64.Nm 65utility copies the contents of the 66.Ar source_file 67to the 68.Ar target_file . 69In the second synopsis form, 70the contents of each named 71.Ar source_file 72is copied to the destination 73.Ar target_directory . 74The names of the files themselves are not changed. 75If 76.Nm 77detects an attempt to copy a file to itself, the copy will fail. 78.Pp 79The following options are available: 80.Bl -tag -width flag 81.It Fl H 82If the 83.Fl R 84option 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 87If the 88.Fl R 89option is specified, all symbolic links are followed. 90.It Fl P 91If the 92.Fl R 93option is specified, no symbolic links are followed. 94.It Fl R 95If 96.Ar source_file 97designates a directory, 98.Nm 99copies the directory and the entire subtree connected at that point. 100This option also causes symbolic links to be copied, rather than 101indirected through, and for 102.Nm 103to create special files rather than copying them as normal files. 104Created directories have the same mode as the corresponding source 105directory, unmodified by the process' umask. 106.It Fl f 107Foreach existing destination pathname, attempt to overwrite it. If permissions 108do not allow copy to succeed, remove it and create a new file, without 109prompting for confirmation. 110(The 111.Fl i 112option is ignored if the 113.Fl f 114option is specified.) 115.It Fl i 116Causes 117.Nm 118to write a prompt to the standard error output before copying a file 119that would overwrite an existing file. 120If the response from the standard input begins with the character 121.Sq Li y , 122the file copy is attempted. 123.It Fl p 124Causes 125.Nm 126to preserve in the copy as many of the modification time, access time, 127file flags, file mode, user ID, and group ID as allowed by permissions. 128.Pp 129If the user ID and group ID cannot be preserved, no error message 130is displayed and the exit value is not altered. 131.Pp 132If the source file has its set user ID bit on and the user ID cannot 133be preserved, the set user ID bit is not preserved 134in the copy's permissions. 135If the source file has its set group ID bit on and the group ID cannot 136be preserved, the set group ID bit is not preserved 137in the copy's permissions. 138If the source file has both its set user ID and set group ID bits on, 139and either the user ID or group ID cannot be preserved, neither 140the set user ID or set group ID bits are preserved in the copy's 141permissions. 142.El 143.Pp 144For each destination file that already exists, its contents are 145overwritten if permissions allow, but its mode, user ID, and group 146ID are unchanged. 147.Pp 148In the second synopsis form, 149.Ar target_directory 150must exist unless there is only one named 151.Ar source_file 152which is a directory and the 153.Fl R 154flag is specified. 155.Pp 156If the destination file does not exist, the mode of the source file is 157used as modified by the file mode creation mask 158.Pf ( Ic umask , 159see 160.Xr csh 1 ) . 161If the source file has its set user ID bit on, that bit is removed 162unless both the source file and the destination file are owned by the 163same user. 164If the source file has its set group ID bit on, that bit is removed 165unless both the source file and the destination file are in the same 166group and the user is a member of that group. 167If both the set user ID and set group ID bits are set, all of the above 168conditions must be fulfilled or both bits are removed. 169.Pp 170Appropriate permissions are required for file creation or overwriting. 171.Pp 172Symbolic links are always followed unless the 173.Fl R 174flag is set, in which case symbolic links are not followed, by default. 175The 176.Fl H 177or 178.Fl L 179flags (in conjunction with the 180.Fl R 181flag) cause symbolic links to be followed as described above. 182The 183.Fl H , 184.Fl L 185and 186.Fl P 187options are ignored unless the 188.Fl R 189option is specified. 190In addition, these options override each other and the 191command's actions are determined by the last one specified. 192.Sh EXIT STATUS 193.Nm 194exits 0 on success, and \*[Gt]0 if an error occurred. 195.Sh COMPATIBILITY 196Historic versions of the 197.Nm 198utility had a 199.Fl r 200option. 201This implementation supports that option, however, its use is strongly 202discouraged, as it does not correctly copy special files, symbolic links 203or 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 211The 212.Nm 213utility is expected to be 214.St -p1003.2 215compatible. 216