te
Copyright (c) 1992, X/Open Company Limited All Rights Reserved
Copyright 1989 AT&T
Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.
The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
This notice shall appear on any product containing this material.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
cp - copy files

/usr/bin/cp [-fip@/] source_file target_file

/usr/bin/cp [-fip@/] source_file... target

/usr/bin/cp -r | -R [-H | -L | -P] [-fip@/] source_dir... target

/usr/bin/cp -R | -R [-H | -L | -P] [-fip@/] source_dir... target

/usr/xpg4/bin/cp [-fip@/] source_file target_file

/usr/xpg4/bin/cp [-fip@/] source_file... target

/usr/xpg4/bin/cp -r | -R [-H | -L | -P] [-fip@/] source_dir... target

/usr/xpg4/bin/cp -R | -R [-H | -L | -P] [-fip@/] source_dir... target

In the first synopsis form, neither source_file nor target_file are directory files, nor can they have the same name. The cp utility copies the contents of source_file to the destination path named by target_file. If target_file exists, cp overwrites its contents, but the mode (and ACL if applicable), owner, and group associated with it are not changed. The last modification time of target_file and the last access time of source_file are set to the time the copy was made. If target_file does not exist, cp creates a new file named target_file that has the same mode as source_file except that the sticky bit is not set unless the user is super-user. In this case, the owner and group of target_file are those of the user, unless the setgid bit is set on the directory containing the newly created file. If the directory's setgid bit is set, the newly created file has the group of the containing directory rather than of the creating user. If target_file is a link to another file, cp overwrites the link destination with the contents of source_file; the link(s) from target_file remains.

In the second synopsis form, one or more source_files are copied to the directory specified by target. It is an error if any source_file is a file of type directory, if target either does not exist or is not a directory.

In the third or fourth synopsis forms, one or more directories specified by source_dir are copied to the directory specified by target. Either the -r or -R must be specified. For each source_dir, cp copies all files and subdirectories.

The following options are supported for both /usr/bin/cp and /usr/xpg4/bin/cp: -f

-H -i -L -p -P -r -R -@ -/

Specifying more than one of the mutually-exclusive options -H, -L, and -P is not considered an error. The last option specified determines the behavior of the utility.

If the -p option is specified with either the -@ option or the -/ option, /usr/bin/cp behaves as follows

If the -p option is specified with either the -@ option or the -/ option, /usr/xpg4/bin/cp behaves as follows:

The following operands are supported: source_file

source_dir target_file target

See largefile(5) for the description of the behavior of cp when encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).

Example 1 Copying a File

The following example copies a file:

example% cp goodies goodies.old

example% ls goodies*
goodies goodies.old

Example 2 Copying a List of Files

The following example copies a list of files to a destination directory:

example% cp ~/src/* /tmp

Example 3 Copying a Directory

The following example copies a directory, first to a new, and then to an existing destination directory

example% ls ~/bkup
/usr/example/fred/bkup not found

example% cp -r ~/src ~/bkup

example% ls -R ~/bkup
x.c y.c z.sh

example% cp -r ~/src ~/bkup

example% ls -R ~/bkup
src x.c y.c z.sh
src:
x.c y.c z.s

Example 4 Copying Extended File System Attributes

The following example copies extended file system attributes:

$ ls -/ c file1
-rw-r--r-- 1 foo staff 0 Oct 29 20:04 file1
 {AH-----m--}

$ cp -/ file1 file2
$ ls -/c file2
-rw-r--r-- 1 foo staff 0 Oct 29 20:17 file2
 {AH-----m--}

Example 5 Failing to Copy Extended System Attributes

The following example fails to copy extended system attributes:

$ ls -/c file1
-rw-r--r-- 1 foo staff 0 Oct 29 20:04 file1
 {AH-----m--}

$ cp -/ file1 /tmp
cp: Failed to copy extended system attributes from file1 to /tmp/file1


$ ls -/c /tmp/file1
-rw-r--r-- 1 foo staff 0 Oct 29 20:09 /tmp/file1
 {}

See environ(5) for descriptions of the following environment variables that affect the execution of cp: LANG, LC_ALL, LC_COLLATE, LC_CTYPE, LC_MESSAGES, and NLSPATH.

Affirmative responses are processed using the extended regular expression defined for the yesexpr keyword in the LC_MESSAGES category of the user's locale. The locale specified in the LC_COLLATE category defines the behavior of ranges, equivalence classes, and multi-character collating elements used in the expression defined for yesexpr. The locale specified in LC_CTYPE determines the locale for interpretation of sequences of bytes of text data a characters, the behavior of character classes used in the expression defined for the yesexpr. See locale(5).

The following exit values are returned: 0

>0

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE

CSI Enabled

Interface Stability Committed

ATTRIBUTE TYPE ATTRIBUTE VALUE

CSI Enabled

Interface Stability Committed

chmod(1), chown(1), setfacl(1), utime(2), fgetattr(3C), attributes(5), environ(5), fsattr(5), largefile(5), locale(5), standards(5)

The permission modes of the source file are preserved in the copy.

A -- permits the user to mark the end of any command line options explicitly, thus allowing cp to recognize filename arguments that begin with a -.