path: root/man/cp.1

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.5.
.TH CP "1" "August 2023" "GNU coreutils 9.4" "User Commands"
.SH NAME
cp \- copy files and directories
.SH SYNOPSIS
.B cp
[\fI\,OPTION\/\fR]... [\fI\,-T\/\fR] \fI\,SOURCE DEST\/\fR
.br
.B cp
[\fI\,OPTION\/\fR]... \fI\,SOURCE\/\fR... \fI\,DIRECTORY\/\fR
.br
.B cp
[\fI\,OPTION\/\fR]... \fI\,-t DIRECTORY SOURCE\/\fR...
.SH DESCRIPTION
.\" Add any additional description here
.PP
Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.
.PP
Mandatory arguments to long options are mandatory for short options too.
.TP
\fB\-a\fR, \fB\-\-archive\fR
same as \fB\-dR\fR \fB\-\-preserve\fR=\fI\,all\/\fR
.TP
\fB\-\-attributes\-only\fR
don't copy the file data, just the attributes
.TP
\fB\-\-backup\fR[=\fI\,CONTROL\/\fR]
make a backup of each existing destination file
.TP
\fB\-b\fR
like \fB\-\-backup\fR but does not accept an argument
.TP
\fB\-\-copy\-contents\fR
copy contents of special files when recursive
.TP
\fB\-d\fR
same as \fB\-\-no\-dereference\fR \fB\-\-preserve\fR=\fI\,links\/\fR
.TP
\fB\-\-debug\fR
explain how a file is copied.  Implies \fB\-v\fR
.TP
\fB\-f\fR, \fB\-\-force\fR
if an existing destination file cannot be
opened, remove it and try again (this option
is ignored when the \fB\-n\fR option is also used)
.TP
\fB\-i\fR, \fB\-\-interactive\fR
prompt before overwrite (overrides a previous \fB\-n\fR
option)
.TP
\fB\-H\fR
follow command\-line symbolic links in SOURCE
.TP
\fB\-l\fR, \fB\-\-link\fR
hard link files instead of copying
.TP
\fB\-L\fR, \fB\-\-dereference\fR
always follow symbolic links in SOURCE
.TP
\fB\-n\fR, \fB\-\-no\-clobber\fR
do not overwrite an existing file (overrides a
\fB\-u\fR or previous \fB\-i\fR option). See also \fB\-\-update\fR
.TP
\fB\-P\fR, \fB\-\-no\-dereference\fR
never follow symbolic links in SOURCE
.TP
\fB\-p\fR
same as \fB\-\-preserve\fR=\fI\,mode\/\fR,ownership,timestamps
.TP
\fB\-\-preserve\fR[=\fI\,ATTR_LIST\/\fR]
preserve the specified attributes
.TP
\fB\-\-no\-preserve\fR=\fI\,ATTR_LIST\/\fR
don't preserve the specified attributes
.TP
\fB\-\-parents\fR
use full source file name under DIRECTORY
.TP
\fB\-R\fR, \fB\-r\fR, \fB\-\-recursive\fR
copy directories recursively
.TP
\fB\-\-reflink\fR[=\fI\,WHEN\/\fR]
control clone/CoW copies. See below
.TP
\fB\-\-remove\-destination\fR
remove each existing destination file before
attempting to open it (contrast with \fB\-\-force\fR)
.TP
\fB\-\-sparse\fR=\fI\,WHEN\/\fR
control creation of sparse files. See below
.TP
\fB\-\-strip\-trailing\-slashes\fR
remove any trailing slashes from each SOURCE
argument
.TP
\fB\-s\fR, \fB\-\-symbolic\-link\fR
make symbolic links instead of copying
.TP
\fB\-S\fR, \fB\-\-suffix\fR=\fI\,SUFFIX\/\fR
override the usual backup suffix
.TP
\fB\-t\fR, \fB\-\-target\-directory\fR=\fI\,DIRECTORY\/\fR
copy all SOURCE arguments into DIRECTORY
.TP
\fB\-T\fR, \fB\-\-no\-target\-directory\fR
treat DEST as a normal file
.TP
\fB\-\-update\fR[=\fI\,UPDATE\/\fR]
control which existing files are updated;
UPDATE={all,none,older(default)}.  See below
.TP
\fB\-u\fR
equivalent to \fB\-\-update\fR[=\fI\,older\/\fR]
.TP
\fB\-v\fR, \fB\-\-verbose\fR
explain what is being done
.TP
\fB\-x\fR, \fB\-\-one\-file\-system\fR
stay on this file system
.TP
\fB\-Z\fR
set SELinux security context of destination
file to default type
.TP
\fB\-\-context\fR[=\fI\,CTX\/\fR]
like \fB\-Z\fR, or if CTX is specified then set the
SELinux or SMACK security context to CTX
.TP
\fB\-\-help\fR
display this help and exit
.TP
\fB\-\-version\fR
output version information and exit
.PP
ATTR_LIST is a comma\-separated list of attributes. Attributes are 'mode' for
permissions (including any ACL and xattr permissions), 'ownership' for user
and group, 'timestamps' for file timestamps, 'links' for hard links, 'context'
for security context, 'xattr' for extended attributes, and 'all' for all
attributes.
.PP
By default, sparse SOURCE files are detected by a crude heuristic and the
corresponding DEST file is made sparse as well.  That is the behavior
selected by \fB\-\-sparse\fR=\fI\,auto\/\fR.  Specify \fB\-\-sparse\fR=\fI\,always\/\fR to create a sparse DEST
file whenever the SOURCE file contains a long enough sequence of zero bytes.
Use \fB\-\-sparse\fR=\fI\,never\/\fR to inhibit creation of sparse files.
.PP
UPDATE controls which existing files in the destination are replaced.
\&'all' is the default operation when an \fB\-\-update\fR option is not specified,
and results in all existing files in the destination being replaced.
\&'none' is similar to the \fB\-\-no\-clobber\fR option, in that no files in the
destination are replaced, but also skipped files do not induce a failure.
\&'older' is the default operation when \fB\-\-update\fR is specified, and results
in files being replaced if they're older than the corresponding source file.
.PP
When \fB\-\-reflink\fR[=\fI\,always\/\fR] is specified, perform a lightweight copy, where the
data blocks are copied only when modified.  If this is not possible the copy
fails, or if \fB\-\-reflink\fR=\fI\,auto\/\fR is specified, fall back to a standard copy.
Use \fB\-\-reflink\fR=\fI\,never\/\fR to ensure a standard copy is performed.
.PP
The backup suffix is '~', unless set with \fB\-\-suffix\fR or SIMPLE_BACKUP_SUFFIX.
The version control method may be selected via the \fB\-\-backup\fR option or through
the VERSION_CONTROL environment variable.  Here are the values:
.TP
none, off
never make backups (even if \fB\-\-backup\fR is given)
.TP
numbered, t
make numbered backups
.TP
existing, nil
numbered if numbered backups exist, simple otherwise
.TP
simple, never
always make simple backups
.PP
As a special case, cp makes a backup of SOURCE when the force and backup
options are given and SOURCE and DEST are the same name for an existing,
regular file.
.SH AUTHOR
Written by Torbjorn Granlund, David MacKenzie, and Jim Meyering.
.SH "REPORTING BUGS"
GNU coreutils online help: <https://www.gnu.org/software/coreutils/>
.br
Report any translation bugs to <https://translationproject.org/team/>
.SH COPYRIGHT
Copyright \(co 2023 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"
\fBinstall\fP(1)
.PP
.br
Full documentation <https://www.gnu.org/software/coreutils/cp>
.br
or available locally via: info \(aq(coreutils) cp invocation\(aq