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