1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)readlink.2 8.1 (Berkeley) 6/4/93
29 .\" $FreeBSD: src/lib/libc/sys/readlink.2,v 1.17 2008/04/16 13:03:12 kib Exp $
37 .Nd read value of a symbolic link
43 .Fn readlink "const char * restrict path" "char * restrict buf" "size_t bufsiz"
45 .Fn readlinkat "int fd" "const char * restrict path" "char * restrict buf" "size_t bufsize"
50 places the contents of the symbolic link
58 system call does not append a
65 system call is equivalent to
67 except in the case where
69 specifies a relative path.
70 In this case the symbolic link whose content is read relative to the
71 directory associated with the file descriptor
73 instead of the current working directory.
76 is passed the special value
80 parameter, the current working directory is used and the behavior is
81 identical to a call to
84 The calls return the count of characters placed in the buffer
85 if it succeeds, or a \-1 if an error occurs, placing the error
86 code in the global variable
95 A component of the path prefix is not a directory.
96 .It Bq Er ENAMETOOLONG
97 A component of a pathname exceeded 255 characters,
98 or an entire path name exceeded 1023 characters.
100 The named file does not exist.
102 Search permission is denied for a component of the path prefix.
104 Too many symbolic links were encountered in translating the pathname.
106 The named file is not a symbolic link.
108 An I/O error occurred while reading from the file system.
113 extends outside the process's allocated address space.
116 In addition to the errors returned by the
125 argument does not specify an absolute path and the
129 nor a valid file descriptor open for searching.
133 argument is not an absolute path and
137 nor a file descriptor associated with a directory.
147 system call follows The Open Group Extended API Set 2 specification.
151 system call appeared in
155 system call appeared in