From 6a2f098e72e71437154ec00506e8e736aa8e1026 Mon Sep 17 00:00:00 2001 From: Soccera1 <129828376+Soccera1@users.noreply.github.com> Date: Tue, 28 Jul 2026 15:54:54 +1000 Subject: Add docs --- man/cp.1 | 204 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 204 insertions(+) create mode 100644 man/cp.1 (limited to 'man/cp.1') diff --git a/man/cp.1 b/man/cp.1 new file mode 100644 index 0000000..9ac4176 --- /dev/null +++ b/man/cp.1 @@ -0,0 +1,204 @@ +.\" Adapted for BNU from the GNU Coreutils 9.11 manual page; see doc/README.md. +.TH CP "1" "2026-07-28" "BNU 9.11" "BNU 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 +.\" This page is derived from GNU Coreutils documentation. +This page documents BNU, an independent Bun implementation compatible with +GNU Coreutils 9.11. +.PP +Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY. +.PP +Mandatory arguments to long options are mandatory for short options too. +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-a'\fB\-a, \-\-archive\fP\X'tty: link' +same as \fB\-dR\fR \fB\-\-preserve\fR=\fI\,all\/\fR +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp--attributes-only'\fB\-\-attributes\-only\fP\X'tty: link' +don't copy the file data, just the attributes +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp--backup'\fB\-\-backup[=CONTROL]\fP\X'tty: link' +make a backup of each existing destination file +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-b'\fB\-b\fP\X'tty: link' +like \fB\-\-backup\fR but does not accept an argument +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp--copy-contents'\fB\-\-copy\-contents\fP\X'tty: link' +copy contents of special files when recursive +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-d'\fB\-d\fP\X'tty: link' +same as \fB\-\-no\-dereference\fR \fB\-\-preserve\fR=\fI\,links\/\fR +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp--debug'\fB\-\-debug\fP\X'tty: link' +explain how a file is copied. Implies \fB\-v\fR +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-f'\fB\-f, \-\-force\fP\X'tty: link' +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 +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-i'\fB\-i, \-\-interactive\fP\X'tty: link' +prompt before overwrite (overrides a previous \fB\-n\fR option) +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-H'\fB\-H\fP\X'tty: link' +follow command\-line symbolic links in SOURCE +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-L'\fB\-L, \-\-dereference\fP\X'tty: link' +always follow symbolic links in SOURCE +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-P'\fB\-P, \-\-no\-dereference\fP\X'tty: link' +never follow symbolic links in SOURCE +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp--keep-directory-symlink'\fB\-\-keep\-directory\-symlink\fP\X'tty: link' +follow existing symlinks to directories +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-l'\fB\-l, \-\-link\fP\X'tty: link' +hard link files instead of copying +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-n'\fB\-n, \-\-no\-clobber\fP\X'tty: link' +(deprecated) silently skip existing files. See also \fB\-\-update\fR +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-p'\fB\-p\fP\X'tty: link' +same as \fB\-\-preserve\fR=\fI\,mode,ownership,timestamps\/\fR +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp--preserve'\fB\-\-preserve[=ATTR_LIST]\fP\X'tty: link' +preserve the specified attributes +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp--no-preserve'\fB\-\-no\-preserve=ATTR_LIST\fP\X'tty: link' +don't preserve the specified attributes +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp--parents'\fB\-\-parents\fP\X'tty: link' +use full source file name under DIRECTORY +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-R'\fB\-R, \-r, \-\-recursive\fP\X'tty: link' +copy directories recursively +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp--reflink'\fB\-\-reflink[=WHEN]\fP\X'tty: link' +control clone/CoW copies. See below +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp--remove-destination'\fB\-\-remove\-destination\fP\X'tty: link' +remove each existing destination file before attempting to open it +(contrast with \fB\-\-force\fR) +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp--sparse'\fB\-\-sparse=WHEN\fP\X'tty: link' +control creation of sparse files. See below +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp--strip-trailing-slashes'\fB\-\-strip\-trailing\-slashes\fP\X'tty: link' +remove any trailing slashes from each SOURCE argument +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-s'\fB\-s, \-\-symbolic\-link\fP\X'tty: link' +make symbolic links instead of copying +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-S'\fB\-S, \-\-suffix=\,SUFFIX\fP\X'tty: link'\/\fR +override the usual backup suffix +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-t'\fB\-t, \-\-target\-directory=\,DIRECTORY\fP\X'tty: link'\/\fR +copy all SOURCE arguments into DIRECTORY +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-T'\fB\-T, \-\-no\-target\-directory\fP\X'tty: link' +treat DEST as a normal file +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp--update'\fB\-\-update[=UPDATE]\fP\X'tty: link' +control which existing files are updated; +UPDATE={all,none,none\-fail,older(default)} +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-u'\fB\-u\fP\X'tty: link' +equivalent to \fB\-\-update\fR[=\fI\,older\/\fR]. See below +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-v'\fB\-v, \-\-verbose\fP\X'tty: link' +explain what is being done +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-x'\fB\-x, \-\-one\-file\-system\fP\X'tty: link' +stay on this file system +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp-Z'\fB\-Z\fP\X'tty: link' +set SELinux security context of destination file to default type +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cp--context'\fB\-\-context[=CTX]\fP\X'tty: link' +like \fB\-Z\fR, or if CTX is specified then set the +SELinux or SMACK security context to CTX +.TP +\X'tty: link https://www.gnu.org/software/coreutils/cp#cp--help'\fB\-\-help\fP\X'tty: link' +display this help and exit +.TP +\X'tty: link https://www.gnu.org/software/coreutils/cp#cp--version'\fB\-\-version\fP\X'tty: link' +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 like the \fB\-\-no\-clobber\fR option, in that no files in the +destination are replaced, and skipped files do not induce a failure. +\&'none\-fail' also ensures no files are replaced in the destination, +but any skipped files are diagnosed and 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 +By default or with \fB\-\-reflink\fR=\fI\,auto\/\fR, cp will try a lightweight copy, where the +data blocks are copied only when modified, falling back to a standard copy +if this is not possible. With \fB\-\-reflink\fR[=\fI\,always\/\fR] cp will fail if CoW is not +supported, while \fB\-\-reflink\fR=\fI\,never\/\fR ensures 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 AUTHORS +Upstream GNU Coreutils documentation authors: +Written by Torbjorn Granlund, David MacKenzie, and Jim Meyering. +.br +Adapted for BNU; the BNU implementation is independent. +.SH "REPORTING BUGS" +Report BNU bugs at . +.br +For upstream GNU Coreutils, see . +.SH COPYRIGHT +Copyright \(co 2026 Free Software Foundation, Inc. +.br +This manual page was adapted for BNU in 2026. +License GPLv3+: GNU GPL version 3 or later . +.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 +Upstream documentation +.br +BNU documentation is available locally via: info \(aq(bnu) cp invocation\(aq -- cgit v1.3