readlink.1: convert to mandoc

This commit is contained in:
Hiltjo Posthuma 2015-01-30 23:34:36 +01:00
parent 08904c0308
commit f2eb5d3b2d
1 changed files with 28 additions and 19 deletions

View File

@ -1,25 +1,34 @@
.TH READLINK 1 sbase\-VERSION
.SH NAME
readlink \- print value of a symbolic link or canonical file name
.SH SYNOPSIS
.B readlink
.RB [ \-fn ]
.IR file
.SH DESCRIPTION
The readlink utility when invoked with the pathname of a symbolic link as
its argument dereferences the symbolic link and prints the name of target
on standard output. If the -f option is not specified and readlink is
.Dd January 30, 2015
.Dt READLINK 1 sbase\-VERSION
.Os
.Sh NAME
.Nm readlink
.Nd print value of a symbolic link or canonical file name
.Sh SYNOPSIS
.Nm
.Op Fl fn
.Ar file
.Sh DESCRIPTION
The
.Nm
utility when invoked with the pathname of a symbolic link as
its argument dereferences the symbolic link and prints the name of the target
on standard output. If the
.Fl f
option is not specified and
.Nm
is
invoked with an argument other than the pathname of a symbolic link, it
exits with a nonzero exit code without printing anything.
.SH OPTIONS
.TP
.B \-f
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl f
Canonicalize by following every symlink in every component of the
given path recursively. The argument does not need to be a symbolic
link.
.TP
.B \-n
.It Fl n
Do not output the trailing newline.
.SH SEE ALSO
.IR readlink (2),
.IR realpath (3)
.El
.Sh SEE ALSO
.Xr readlink 2 ,
.Xr realpath 3