aboutsummaryrefslogtreecommitdiff
path: root/man/ln.1
diff options
context:
space:
mode:
authorSoccera1 <[email protected]>2026-07-28 15:54:54 +1000
committerSoccera1 <[email protected]>2026-07-28 15:54:54 +1000
commit6a2f098e72e71437154ec00506e8e736aa8e1026 (patch)
tree63e9f5596be38558dbeb40bb566735759a3ccabb /man/ln.1
parenta753f669c9bedfccb9f7f400da018bb487dca5d0 (diff)
downloadbnu-6a2f098e72e71437154ec00506e8e736aa8e1026.tar.gz
bnu-6a2f098e72e71437154ec00506e8e736aa8e1026.zip
Add docs
Diffstat (limited to 'man/ln.1')
-rw-r--r--man/ln.1124
1 files changed, 124 insertions, 0 deletions
diff --git a/man/ln.1 b/man/ln.1
new file mode 100644
index 0000000..58841ac
--- /dev/null
+++ b/man/ln.1
@@ -0,0 +1,124 @@
+.\" Adapted for BNU from the GNU Coreutils 9.11 manual page; see doc/README.md.
+.TH LN "1" "2026-07-28" "BNU 9.11" "BNU Commands"
+.SH NAME
+ln \- make links between files
+.SH SYNOPSIS
+.B ln
+[\fI\,OPTION\/\fR]... [\fI\,-T\/\fR] \fI\,TARGET LINK_NAME\/\fR
+.br
+.B ln
+[\fI\,OPTION\/\fR]... \fI\,TARGET\/\fR
+.br
+.B ln
+[\fI\,OPTION\/\fR]... \fI\,TARGET\/\fR... \fI\,DIRECTORY\/\fR
+.br
+.B ln
+[\fI\,OPTION\/\fR]... \fI\,-t DIRECTORY TARGET\/\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
+In the 1st form, create a link to TARGET with the name LINK_NAME.
+In the 2nd form, create a link to TARGET in the current directory.
+In the 3rd and 4th forms, create links to each TARGET in DIRECTORY.
+Create hard links by default, symbolic links with \fB\-\-symbolic\fR.
+By default, each destination (name of new link) should not already exist.
+When creating hard links, each TARGET must exist. Symbolic links
+can hold arbitrary text; if later resolved, a relative link is
+interpreted in relation to its parent 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#ln--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#ln-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#ln-d'\fB\-d, \-F, \-\-directory\fP\X'tty: link'
+allow the superuser to attempt to hard link directories,
+if supported by the system
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ln-f'\fB\-f, \-\-force\fP\X'tty: link'
+remove existing destination files
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ln-i'\fB\-i, \-\-interactive\fP\X'tty: link'
+prompt whether to remove destinations
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ln-L'\fB\-L, \-\-logical\fP\X'tty: link'
+dereference TARGETs that are symbolic links
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ln-n'\fB\-n, \-\-no\-dereference\fP\X'tty: link'
+treat LINK_NAME as a normal file
+if it is a symbolic link to a directory
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ln-P'\fB\-P, \-\-physical\fP\X'tty: link'
+make hard links directly to symbolic links
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ln-r'\fB\-r, \-\-relative\fP\X'tty: link'
+with \fB\-s\fR, create links relative to link location
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ln-s'\fB\-s, \-\-symbolic\fP\X'tty: link'
+make symbolic links instead of hard links
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ln-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#ln-t'\fB\-t, \-\-target\-directory=\,DIRECTORY\fP\X'tty: link'\/\fR
+specify the DIRECTORY in which to create the links
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ln-T'\fB\-T, \-\-no\-target\-directory\fP\X'tty: link'
+treat LINK_NAME as a normal file always
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#ln-v'\fB\-v, \-\-verbose\fP\X'tty: link'
+print name of each linked file
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/ln#ln--help'\fB\-\-help\fP\X'tty: link'
+display this help and exit
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/ln#ln--version'\fB\-\-version\fP\X'tty: link'
+output version information and exit
+.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
+Using \fB\-s\fR ignores \fB\-L\fR and \fB\-P\fR. Otherwise, the last option specified controls
+behavior when a TARGET is a symbolic link, defaulting to \fB\-P\fR.
+.SH AUTHORS
+Upstream GNU Coreutils documentation authors:
+Written by Mike Parker and David MacKenzie.
+.br
+Adapted for BNU; the BNU implementation is independent.
+.SH "REPORTING BUGS"
+Report BNU bugs at <https://github.com/Soccera1/bnu/issues>.
+.br
+For upstream GNU Coreutils, see <https://www.gnu.org/software/coreutils/>.
+.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 <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"
+\fBlink\fP(2), \fBsymlink\fP(2)
+.PP
+.br
+Upstream documentation <https://www.gnu.org/software/coreutils/ln>
+.br
+BNU documentation is available locally via: info \(aq(bnu) ln invocation\(aq