Annotation of src/usr.bin/readlink/readlink.1, Revision 1.1
1.1 ! kstailey 1: .\" $OpenBSD$
! 2: .\"
! 3: .\" Copyright (c) 1990, 1993
! 4: .\" The Regents of the University of California. All rights reserved.
! 5: .\"
! 6: .\" This code is derived from software contributed to Berkeley by
! 7: .\" the Institute of Electrical and Electronics Engineers, Inc.
! 8: .\"
! 9: .\" Redistribution and use in source and binary forms, with or without
! 10: .\" modification, are permitted provided that the following conditions
! 11: .\" are met:
! 12: .\" 1. Redistributions of source code must retain the above copyright
! 13: .\" notice, this list of conditions and the following disclaimer.
! 14: .\" 2. Redistributions in binary form must reproduce the above copyright
! 15: .\" notice, this list of conditions and the following disclaimer in the
! 16: .\" documentation and/or other materials provided with the distribution.
! 17: .\" 3. All advertising materials mentioning features or use of this software
! 18: .\" must display the following acknowledgement:
! 19: .\" This product includes software developed by the University of
! 20: .\" California, Berkeley and its contributors.
! 21: .\" 4. Neither the name of the University nor the names of its contributors
! 22: .\" may be used to endorse or promote products derived from this software
! 23: .\" without specific prior written permission.
! 24: .\"
! 25: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
! 26: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
! 27: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
! 28: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
! 29: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
! 30: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
! 31: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
! 32: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
! 33: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
! 34: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
! 35: .\" SUCH DAMAGE.
! 36: .\"
! 37: .Dd August 18, 1997
! 38: .Dt READLINK 1
! 39: .Os
! 40: .Sh NAME
! 41: .Nm readlink
! 42: .Nd display target of symbolic link on standard output
! 43: .Sh SYNOPSIS
! 44: .Nm readlink
! 45: .Op Fl n
! 46: .Ar file
! 47: .Sh DESCRIPTION
! 48: The
! 49: .Nm readlink
! 50: utility when invoked with the pathname of a symbolic link as its
! 51: argument dereferences the symbolic link and prints the name of target
! 52: on standard output. If readlink is invoked with an argument other
! 53: than the pathname of a symbolic link it exits with a non-zero exit
! 54: code and without printing anything.
! 55: .Pp
! 56: The following option is available:
! 57: .Bl -tag -width flag
! 58: .It Fl n
! 59: Do not print a trailing newline character.
! 60: .El
! 61: .Pp
! 62: The
! 63: .Nm readlink
! 64: utility exits 0 on success, and >0 if an error occurs.
! 65: .Sh SEE ALSO
! 66: .Xr readlink 2
! 67: .Sh HISTORY
! 68: The
! 69: .Nm readlink
! 70: utility first appeared in OpenBSD 2.1