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