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/readlink.1 | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 man/readlink.1 (limited to 'man/readlink.1') diff --git a/man/readlink.1 b/man/readlink.1 new file mode 100644 index 0000000..4fd5c53 --- /dev/null +++ b/man/readlink.1 @@ -0,0 +1,76 @@ +.\" Adapted for BNU from the GNU Coreutils 9.11 manual page; see doc/README.md. +.TH READLINK "1" "2026-07-28" "BNU 9.11" "BNU Commands" +.SH NAME +readlink \- print resolved symbolic links or canonical file names +.SH SYNOPSIS +.B readlink +[\fI\,OPTION\/\fR]... \fI\,FILE\/\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. +\fBrealpath\fP(1) is a better command +for canonicalization functionality. +.PP +Print value of a symbolic link or canonical file name +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#readlink-f'\fB\-f, \-\-canonicalize\fP\X'tty: link' +canonicalize by following every symlink +in every component of the given name recursively; +all but the last component must exist +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#readlink-e'\fB\-e, \-\-canonicalize\-existing\fP\X'tty: link' +canonicalize by following every symlink +in every component of the given name recursively; +all components must exist +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#readlink-m'\fB\-m, \-\-canonicalize\-missing\fP\X'tty: link' +canonicalize by following every symlink +in every component of the given name recursively, +without requirements on components existence +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#readlink-n'\fB\-n, \-\-no\-newline\fP\X'tty: link' +do not output the trailing delimiter +.HP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#readlink-q'\fB\-q, \-\-quiet\fP\X'tty: link' +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#readlink-s'\fB\-s, \-\-silent\fP\X'tty: link' +suppress most error messages +(on by default if POSIXLY_CORRECT is not set) +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#readlink-v'\fB\-v, \-\-verbose\fP\X'tty: link' +report error messages +(on by default if POSIXLY_CORRECT is set) +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#readlink-z'\fB\-z, \-\-zero\fP\X'tty: link' +end each output line with NUL, not newline +.TP +\X'tty: link https://www.gnu.org/software/coreutils/readlink#readlink--help'\fB\-\-help\fP\X'tty: link' +display this help and exit +.TP +\X'tty: link https://www.gnu.org/software/coreutils/readlink#readlink--version'\fB\-\-version\fP\X'tty: link' +output version information and exit +.SH AUTHORS +Upstream GNU Coreutils documentation authors: +Written by Dmitry V. Levin. +.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" +\fBreadlink\fP(2), \fBrealpath\fP(1), \fBrealpath\fP(3) +.PP +.br +Upstream documentation +.br +BNU documentation is available locally via: info \(aq(bnu) readlink invocation\(aq -- cgit v1.3