lib/libc/sys/readlink.2

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)readlink.2  8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt READLINK 2
  37 .Os
  38 .Sh NAME
  39 .Nm readlink
  40 .Nd read value of a symbolic link
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In unistd.h
  45 .Ft int
  46 .Fn readlink "const char *path" "char *buf" "int bufsiz"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn readlink
  50 system call
  51 places the contents of the symbolic link
  52 .Fa path
  53 in the buffer
  54 .Fa buf ,
  55 which has size
  56 .Fa bufsiz .
  57 The
  58 .Fn readlink
  59 system call does not append a
  60 .Dv NUL
  61 character to
  62 .Fa buf .
  63 .Sh RETURN VALUES
  64 The call returns the count of characters placed in the buffer
  65 if it succeeds, or a -1 if an error occurs, placing the error
  66 code in the global variable
  67 .Va errno .
  68 .Sh ERRORS
  69 The
  70 .Fn readlink
  71 system call
  72 will fail if:
  73 .Bl -tag -width Er
  74 .It Bq Er ENOTDIR
  75 A component of the path prefix is not a directory.
  76 .It Bq Er ENAMETOOLONG
  77 A component of a pathname exceeded 255 characters,
  78 or an entire path name exceeded 1023 characters.
  79 .It Bq Er ENOENT
  80 The named file does not exist.
  81 .It Bq Er EACCES
  82 Search permission is denied for a component of the path prefix.
  83 .It Bq Er ELOOP
  84 Too many symbolic links were encountered in translating the pathname.
  85 .It Bq Er EINVAL
  86 The named file is not a symbolic link.
  87 .It Bq Er EIO
  88 An I/O error occurred while reading from the file system.
  89 .It Bq Er EFAULT
  90 The
  91 .Fa buf
  92 argument
  93 extends outside the process's allocated address space.
  94 .El
  95 .Sh SEE ALSO
  96 .Xr lstat 2 ,
  97 .Xr stat 2 ,
  98 .Xr symlink 2 ,
  99 .Xr symlink 7
 100 .Sh HISTORY
 101 The
 102 .Fn readlink
 103 system call appeared in
 104 .Bx 4.2 .