document

1 files changed, 70 insertions, 0 deletions

diff --git a/usr.bin/readlink/readlink.1 b/usr.bin/readlink/readlink.1
new file mode 100644
index 00000000000..f45e30d4217
--- /dev/null
+++ b/usr.bin/readlink/readlink.1
@@ -0,0 +1,70 @@
+.\"	$OpenBSD: readlink.1,v 1.1 1997/08/18 20:30:02 kstailey Exp $
+.\"
+.\" Copyright (c) 1990, 1993
+.\"	The Regents of the University of California.  All rights reserved.
+.\"
+.\" This code is derived from software contributed to Berkeley by
+.\" the Institute of Electrical and Electronics Engineers, Inc.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"	This product includes software developed by the University of
+.\"	California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.Dd August 18, 1997
+.Dt READLINK 1
+.Os
+.Sh NAME
+.Nm readlink
+.Nd display target of symbolic link on standard output
+.Sh SYNOPSIS
+.Nm readlink
+.Op Fl n
+.Ar file
+.Sh DESCRIPTION
+The
+.Nm 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 readlink is invoked with an argument other
+than the pathname of a symbolic link it exits with a non-zero exit
+code and without printing anything.
+.Pp
+The following option is available:
+.Bl -tag -width flag
+.It Fl n
+Do not print a trailing newline character.
+.El
+.Pp
+The
+.Nm readlink
+utility exits 0 on success, and >0 if an error occurs.
+.Sh SEE ALSO
+.Xr readlink 2
+.Sh HISTORY
+The
+.Nm readlink
+utility first appeared in OpenBSD 2.1