break out special local mail processing (e.g., mapping to the

[unix-history] / usr / src / bin / cp / cp.1

diff --git a/usr/src/bin/cp/cp.1 b/usr/src/bin/cp/cp.1
index 18a1844..3282391 100644 (file)
--- a/usr/src/bin/cp/cp.1
+++ b/usr/src/bin/cp/cp.1
@@ -1,12 +1,12 @@
-.\" Copyright (c) 1989, 1990 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.

 .\"
 .\" This code is derived from software contributed to Berkeley by
 .\" the Institute of Electrical and Electronics Engineers, Inc.
 .\"
 .\" %sccs.include.redist.roff%
 .\"
 .\"
 .\" This code is derived from software contributed to Berkeley by
 .\" the Institute of Electrical and Electronics Engineers, Inc.
 .\"
 .\" %sccs.include.redist.roff%
 .\"

-.\"    @(#)cp.1        6.16 (Berkeley) %G%
+.\"    @(#)cp.1        8.3 (Berkeley) %G%

 .\"
 .Dd 
 .Dt CP 1
 .\"
 .Dd 
 .Dt CP 1


@@ -16,10 +16,18 @@
 .Nd copy files
 .Sh SYNOPSIS
 .Nm cp
 .Nd copy files
 .Sh SYNOPSIS
 .Nm cp

-.Op Fl HRfhip
+.Oo
+.Fl R
+.Op Fl H | Fl L | Fl P
+.Oc
+.Op Fl fip

 .Ar source_file target_file
 .Nm cp
 .Ar source_file target_file
 .Nm cp

-.Op Fl HRfhip
+.Oo
+.Fl R
+.Op Fl H | Fl L | Fl P
+.Oc
+.Op Fl fip

 .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


@@ -41,8 +49,18 @@ detects an attempt to copy a file to itself, the copy will fail.
 The following options are available:
 .Bl -tag -width flag
 .It Fl H
 The following options are available:
 .Bl -tag -width flag
 .It Fl H

-When encountering a symbolic link on the command line, follow it.  All other
-symbolic links encountered in the traversal are not followed.
+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 L
+If the
+.Fl R
+option is specified, all symbolic links are followed.
+.It Fl P
+If the
+.Fl R
+option is specified, no symbolic links are followed.

 .It Fl R
 If
 .Ar source_file
 .It Fl R
 If
 .Ar source_file


@@ -64,24 +82,19 @@ regardless of its permissions.
 option is ignored if the
 .Fl f
 option is specified.)
 option is ignored if the
 .Fl f
 option is specified.)

-.It Fl h
-When encountering a symbolic link anywhere in the traversal, follow it.
-Provided for the
-.Fl R
-option which does not follow symbolic links by default.

 .It Fl i
 Causes
 .Nm cp
 .It Fl i
 Causes
 .Nm cp

-to write a prompt to standard error before copying a file that would
-overwrite an existing file.
+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 ,
 If the response from the standard input begins with the character
 .Sq Li y ,

-the file is copied if permissions allow the copy.
+the file copy is attempted.

 .It Fl p
 Causes
 .Nm cp
 to preserve in the copy as many of the modification time, access time,
 .It Fl p
 Causes
 .Nm cp
 to preserve in the copy as many of the modification time, access time,

-file mode, user ID, and group ID as allowed by permissions.
+file flags, file mode, user ID, and group ID as allowed by permissions.

 .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 user ID and group ID cannot be preserved, no error message
 is displayed and the exit value is not altered.


@@ -92,8 +105,8 @@ 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 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 the set user ID and set group ID bits
-on and either the user ID or group ID cannot be preserved, neither
+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.
 .El
 the set user ID or set group ID bits are preserved in the copy's
 permissions.
 .El


@@ -102,6 +115,14 @@ For each destination file that already exists, its contents are
 overwritten if permissions allow, but its mode, user ID, and group
 ID are unchanged.
 .Pp
 overwritten if permissions allow, but its mode, user ID, and group
 ID are unchanged.
 .Pp

+In the second synopsis form, 
+.Ar target_directory 
+must exist unless there is only one named
+.Ar source_file
+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
 used as modified by the file mode creation mask
 .Pf ( Ic umask ,
 If the destination file does not exist, the mode of the source file is
 used as modified by the file mode creation mask
 .Pf ( Ic umask ,


@@ -118,18 +139,44 @@ conditions must be fulfilled or both bits are removed.
 .Pp
 Appropriate permissions are required for file creation or overwriting.
 .Pp
 .Pp
 Appropriate permissions are required for file creation or overwriting.
 .Pp

-Symbolic links are not followed unless the
+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
 or 
 .Fl H
 or 

-.Fl h
-options are specified, in which case the behavior is as detailed above.
+.Fl L
+flags (in conjunction with the
+.Fl R
+flag) cause symbolic links to be followed as described above.
+The
+.Fl H ,
+.Fl L
+and
+.Fl P
+options are ignored unless the
+.Fl R
+option is specified.
+In addition, these options override each other and the
+command's actions are determined by the last one specified.

 .Pp
 .Nm Cp
 exits 0 on success, >0 if an error occurred.
 .Pp
 .Nm Cp
 exits 0 on success, >0 if an error occurred.

+.Sh COMPATIBILITY
+Historic versions of the
+.Nm cp
+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.

 .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 symlink 7

 .Sh HISTORY
 The
 .Nm cp
 .Sh HISTORY
 The
 .Nm cp