file_cmds-242.tar.gz

[apple/file_cmds.git] / cp / cp.1

diff --git a/cp/cp.1 b/cp/cp.1
index f0333604ba05f274225ceb4ad1f1e844b6fe56ce..6f5507d17044e2059d4f9ac09cb7a4072ce33547 100644 (file)
--- a/cp/cp.1
+++ b/cp/cp.1
@@ -1,5 +1,4 @@
-.\"    $NetBSD: cp.1,v 1.12 1997/10/11 02:14:42 enami Exp $
-.\"
+.\"-

 .\" Copyright (c) 1989, 1990, 1993, 1994
 .\"    The Regents of the University of California.  All rights reserved.
 .\"
 .\" Copyright (c) 1989, 1990, 1993, 1994
 .\"    The Regents of the University of California.  All rights reserved.
 .\"


@@ -14,10 +13,6 @@
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.

-.\" 3. All advertising materials mentioning features or use of this software
-.\"    must display the following acknowledgement:
-.\"    This product includes software developed by the University of
-.\"    California, Berkeley and its contributors.

 .\" 4. Neither the name of the University nor the names of its contributors
 .\"    may be used to endorse or promote products derived from this software
 .\"    without specific prior written permission.
 .\" 4. Neither the name of the University nor the names of its contributors
 .\"    may be used to endorse or promote products derived from this software
 .\"    without specific prior written permission.


@@ -35,33 +30,34 @@
 .\" SUCH DAMAGE.
 .\"
 .\"    @(#)cp.1        8.3 (Berkeley) 4/18/94
 .\" SUCH DAMAGE.
 .\"
 .\"    @(#)cp.1        8.3 (Berkeley) 4/18/94

+.\" $FreeBSD: src/bin/cp/cp.1,v 1.33 2005/02/25 00:40:46 trhodes Exp $

 .\"
 .\"

-.Dd April 18, 1994
+.Dd February 23, 2005

 .Dt CP 1
 .Dt CP 1

-.Os BSD 4
+.Os

 .Sh NAME
 .Nm cp
 .Nd copy files
 .Sh SYNOPSIS
 .Sh NAME
 .Nm cp
 .Nd copy files
 .Sh SYNOPSIS

-.Nm
+.Nm cp

 .Oo
 .Fl R
 .Op Fl H | Fl L | Fl P
 .Oc
 .Oo
 .Fl R
 .Op Fl H | Fl L | Fl P
 .Oc

-.Op Fl f | i
-.Op Fl p
+.Op Fl fi | n
+.Op Fl apvX

 .Ar source_file target_file
 .Nm cp
 .Oo
 .Fl R
 .Op Fl H | Fl L | Fl P
 .Oc
 .Ar source_file target_file
 .Nm cp
 .Oo
 .Fl R
 .Op Fl H | Fl L | Fl P
 .Oc

-.Op Fl f | i
-.Op Fl p
+.Op Fl fi | n
+.Op Fl apvX

 .Ar source_file ... target_directory
 .Sh DESCRIPTION
 In the first synopsis form, the
 .Ar source_file ... target_directory
 .Sh DESCRIPTION
 In the first synopsis form, the

-.Nm
+.Nm cp

 utility copies the contents of the
 .Ar source_file
 to the
 utility copies the contents of the
 .Ar source_file
 to the


@@ -73,84 +69,144 @@ is copied to the destination
 .Ar target_directory .
 The names of the files themselves are not changed.
 If
 .Ar target_directory .
 The names of the files themselves are not changed.
 If

-.Nm
+.Nm cp

 detects an attempt to copy a file to itself, the copy will fail.
 .Pp
 The following options are available:
 .Bl -tag -width flag
 detects an attempt to copy a file to itself, the copy will fail.
 .Pp
 The following options are available:
 .Bl -tag -width flag

+.It Fl a
+Same as 
+.Fl pPR
+options. Preserves structure and attributes of files
+but not directory structure.
+.It Fl f
+.\"For each existing destination pathname, remove it and
+If the destination file cannot be opened, remove it and
+create a new file, without prompting for confirmation
+regardless of its permissions.
+(The
+.Fl f
+option overrides any previous
+.Fl n
+option.)
+.Pp
+The target file is not unlinked before the copy.
+Thus, any existing access rights will be retained.

 .It Fl H
 If the
 .Fl R
 option is specified, symbolic links on the command line are followed.
 (Symbolic links encountered in the tree traversal are not followed.)
 .It Fl H
 If the
 .Fl R
 option is specified, symbolic links on the command line are followed.
 (Symbolic links encountered in the tree traversal are not followed.)

+.It Fl i
+Cause
+.Nm cp
+to write a prompt to the standard error output before copying a file
+that would overwrite an existing file.
+If the response from the standard input begins with the character
+.Sq Li y
+or
+.Sq Li Y ,
+the file copy is attempted.
+(The
+.Fl i
+option overrides any previous
+.Fl n
+option.)

 .It Fl L
 If the
 .Fl R
 option is specified, all symbolic links are followed.
 .It Fl L
 If the
 .Fl R
 option is specified, all symbolic links are followed.

+.It Fl n
+Do not overwrite an existing file.
+(The
+.Fl n
+option overrides any previous
+.Fl f
+or
+.Fl i
+options.)

 .It Fl P
 If the
 .Fl R
 option is specified, no symbolic links are followed.
 .It Fl P
 If the
 .Fl R
 option is specified, no symbolic links are followed.

+This is the default.
+.It Fl p
+Cause
+.Nm cp
+to preserve the following attributes of each source
+file in the copy: modification time, access time,
+file flags, file mode, user ID, and group ID, as allowed by permissions.
+Access Control Lists (ACLs) and Extended Attributes (EAs),
+including resource forks, will also be preserved.
+.Pp
+If the user ID and group ID cannot be preserved, no error message
+is displayed and the exit value is not altered.
+.Pp
+If the source file has its set-user-ID bit on and the user ID cannot
+be preserved, the set-user-ID bit is not preserved
+in the copy's permissions.
+If the source file has its set-group-ID bit on and the group ID cannot
+be preserved, the set-group-ID bit is not preserved
+in the copy's permissions.
+If the source file has both its set-user-ID and set-group-ID bits on,
+and either the user ID or group ID cannot be preserved, neither
+the set-user-ID nor set-group-ID bits are preserved in the copy's
+permissions.

 .It Fl R
 If
 .Ar source_file
 designates a directory,
 .It Fl R
 If
 .Ar source_file
 designates a directory,

-.Nm
+.Nm cp

 copies the directory and the entire subtree connected at that point.
 copies the directory and the entire subtree connected at that point.

+If the
+.Ar source_file
+ends in a
+.Pa / ,
+the contents of the directory are copied rather than the
+directory itself.

 This option also causes symbolic links to be copied, rather than
 indirected through, and for
 This option also causes symbolic links to be copied, rather than
 indirected through, and for

-.Nm
+.Nm cp

 to create special files rather than copying them as normal files.
 Created directories have the same mode as the corresponding source
 directory, unmodified by the process' umask.
 to create special files rather than copying them as normal files.
 Created directories have the same mode as the corresponding source
 directory, unmodified by the process' umask.

-.It Fl f
-For each existing destination pathname, attempt to overwrite it. If permissions
-do not allow copy to succeed, remove it and create a new file, without
-prompting for confirmation.
-(The
-.Fl i
-option is ignored if the
-.Fl f
-option is specified.)
-.It Fl i
-Causes
-.Nm
-to write a prompt to the standard error output before copying a file
-that would overwrite an existing file.
-If the response from the standard input begins with the character
-.Sq Li y ,
-the file copy is attempted.
-.It Fl p
-Causes
-.Nm
-to preserve in the copy as many of the modification time, access time,
-file flags, file mode, user ID, and group ID as allowed by permissions.

 .Pp
 .Pp

-If the user ID and group ID cannot be preserved, no error message
-is displayed and the exit value is not altered.
+In
+.Fl R
+mode,
+.Nm cp
+will continue copying even if errors are detected. 

 .Pp
 .Pp

-If the source file has its set user ID bit on and the user ID cannot
-be preserved, the set user ID bit is not preserved
-in the copy's permissions.
-If the source file has its set group ID bit on and the group ID cannot
-be preserved, the set group ID bit is not preserved
-in the copy's permissions.
-If the source file has both its set user ID and set group ID bits on,
-and either the user ID or group ID cannot be preserved, neither
-the set user ID or set group ID bits are preserved in the copy's
-permissions.
+Note that
+.Nm cp
+copies hard-linked files as separate files.
+If you need to preserve hard links, consider using
+.Xr tar 1 ,
+.Xr cpio 1 ,
+or
+.Xr pax 1
+instead.
+.It Fl v
+Cause
+.Nm cp
+to be verbose, showing files as they are copied.
+.It Fl X
+Do not copy Extended Attributes (EAs) or resource forks.

 .El
 .Pp
 For each destination file that already exists, its contents are
 .El
 .Pp
 For each destination file that already exists, its contents are

-overwritten if permissions allow, but its mode, user ID, and group
-ID are unchanged.
+overwritten if permissions allow.
+Its mode, user ID, and group
+ID are unchanged unless the
+.Fl p
+option was specified.

 .Pp
 .Pp

-In the second synopsis form, 
-.Ar target_directory 
+In the second synopsis form,
+.Ar target_directory

 must exist unless there is only one named
 .Ar source_file
 must exist unless there is only one named
 .Ar source_file

-which is a directory and the 
-.Fl R 
+which is a directory and the
+.Fl R

 flag is specified.
 .Pp
 If the destination file does not exist, the mode of the source file is
 flag is specified.
 .Pp
 If the destination file does not exist, the mode of the source file is


@@ -158,23 +214,23 @@ used as modified by the file mode creation mask
 .Pf ( Ic umask ,
 see
 .Xr csh 1 ) .
 .Pf ( Ic umask ,
 see
 .Xr csh 1 ) .

-If the source file has its set user ID bit on, that bit is removed
+If the source file has its set-user-ID bit on, that bit is removed

 unless both the source file and the destination file are owned by the
 same user.
 unless both the source file and the destination file are owned by the
 same user.

-If the source file has its set group ID bit on, that bit is removed
+If the source file has its set-group-ID bit on, that bit is removed

 unless both the source file and the destination file are in the same
 group and the user is a member of that group.
 unless both the source file and the destination file are in the same
 group and the user is a member of that group.

-If both the set user ID and set group ID bits are set, all of the above
+If both the set-user-ID and set-group-ID bits are set, all of the above

 conditions must be fulfilled or both bits are removed.
 .Pp
 Appropriate permissions are required for file creation or overwriting.
 .Pp
 conditions must be fulfilled or both bits are removed.
 .Pp
 Appropriate permissions are required for file creation or overwriting.
 .Pp

-Symbolic links are always followed unless the 
-.Fl R 
+Symbolic links are always followed unless the
+.Fl R

 flag is set, in which case symbolic links are not followed, by default.
 The
 .Fl H
 flag is set, in which case symbolic links are not followed, by default.
 The
 .Fl H

-or 
+or

 .Fl L
 flags (in conjunction with the
 .Fl R
 .Fl L
 flags (in conjunction with the
 .Fl R


@@ -190,26 +246,64 @@ option is specified.
 In addition, these options override each other and the
 command's actions are determined by the last one specified.
 .Pp
 In addition, these options override each other and the
 command's actions are determined by the last one specified.
 .Pp

-.Nm
-exits 0 on success, >0 if an error occurred.
+If
+.Nm cp
+receives a
+.Dv SIGINFO
+(see the
+.Cm status
+argument for
+.Xr stty 1 )
+signal, the current input and output file and the percentage complete
+will be written to the standard output.
+.Sh EXIT STATUS
+.Ex -std

 .Sh COMPATIBILITY
 Historic versions of the
 .Sh COMPATIBILITY
 Historic versions of the

-.Nm
+.Nm cp

 utility had a
 .Fl r
 option.
 utility had a
 .Fl r
 option.

-This implementation supports that option, however, its use is strongly
-discouraged, as it does not correctly copy special files, symbolic links
-or fifo's.
+This implementation supports that option;
+however, its use is strongly discouraged,
+as it does not correctly copy special files, symbolic links, or fifo's.
+.Pp
+The
+.Fl v
+and
+.Fl n
+options are non-standard and their use in scripts is not recommended.
+.Sh LEGACY DESCRIPTION
+In legacy mode,
+.Fl f
+will override
+.Fl i .
+Also, under the
+.Fl f
+option, the target file is always unlinked before the copy.
+Thus, new access rights will always be set.
+.Pp
+In
+.Fl R
+mode, copying will terminate if an error is encountered.
+.Pp
+For more information about legacy mode, see
+.Xr compat 5 .

 .Sh SEE ALSO
 .Xr mv 1 ,
 .Xr rcp 1 ,
 .Sh SEE ALSO
 .Xr mv 1 ,
 .Xr rcp 1 ,

-.Xr umask 2 , 
+.Xr umask 2 ,

 .Xr fts 3 ,
 .Xr fts 3 ,

+.Xr compat 5 ,

 .Xr symlink 7
 .Sh STANDARDS
 The
 .Xr symlink 7
 .Sh STANDARDS
 The

-.Nm
-utility is expected to be
+.Nm cp
+command is expected to be

 .St -p1003.2
 compatible.
 .St -p1003.2
 compatible.

+.Sh HISTORY
+A
+.Nm cp
+command appeared in
+.At v1 .