Return to readlink.1 CVS log

Up to [local] / src / usr.bin / readlink

Annotation of src/usr.bin/readlink/readlink.1, Revision 1.7

1.7     ! aaron       1: .\"    $OpenBSD: readlink.1,v 1.6 2000/03/10 20:17:50 aaron Exp $
1.1       kstailey    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
1.3       niklas     45: .Op Fl fn
1.1       kstailey   46: .Ar file
                     47: .Sh DESCRIPTION
                     48: The
1.6       aaron      49: .Nm
1.1       kstailey   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
1.6       aaron      52: on standard output.
                     53: If readlink is invoked with an argument other
                     54: than the pathname of a symbolic link, it exits with a nonzero exit
1.4       aaron      55: code without printing anything.
1.1       kstailey   56: .Pp
1.5       aaron      57: The options are as follows:
1.7     ! aaron      58: .Bl -tag -width Ds
1.3       niklas     59: .It Fl f
                     60: Canonicalize by following every symlink in every component of the given
                     61: path recursively.
1.1       kstailey   62: .It Fl n
                     63: Do not print a trailing newline character.
                     64: .El
                     65: .Pp
                     66: The
1.6       aaron      67: .Nm
1.4       aaron      68: utility exits 0 on success or >0 if an error occurred.
1.1       kstailey   69: .Sh SEE ALSO
                     70: .Xr readlink 2
                     71: .Sh HISTORY
                     72: The
1.6       aaron      73: .Nm
1.2       kstailey   74: utility first appeared in
1.4       aaron      75: .Ox 2.1 .