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 .\" 4. 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.
  15 .\"
  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
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)readlink.2  8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd June 4, 1993
  32 .Dt READLINK 2
  33 .Os
  34 .Sh NAME
  35 .Nm readlink
  36 .Nd read value of a symbolic link
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In unistd.h
  41 .Ft int
  42 .Fn readlink "const char *path" "char *buf" "int bufsiz"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn readlink
  46 system call
  47 places the contents of the symbolic link
  48 .Fa path
  49 in the buffer
  50 .Fa buf ,
  51 which has size
  52 .Fa bufsiz .
  53 The
  54 .Fn readlink
  55 system call does not append a
  56 .Dv NUL
  57 character to
  58 .Fa buf .
  59 .Sh RETURN VALUES
  60 The call returns the count of characters placed in the buffer
  61 if it succeeds, or a -1 if an error occurs, placing the error
  62 code in the global variable
  63 .Va errno .
  64 .Sh ERRORS
  65 The
  66 .Fn readlink
  67 system call
  68 will fail if:
  69 .Bl -tag -width Er
  70 .It Bq Er ENOTDIR
  71 A component of the path prefix is not a directory.
  72 .It Bq Er ENAMETOOLONG
  73 A component of a pathname exceeded 255 characters,
  74 or an entire path name exceeded 1023 characters.
  75 .It Bq Er ENOENT
  76 The named file does not exist.
  77 .It Bq Er EACCES
  78 Search permission is denied for a component of the path prefix.
  79 .It Bq Er ELOOP
  80 Too many symbolic links were encountered in translating the pathname.
  81 .It Bq Er EINVAL
  82 The named file is not a symbolic link.
  83 .It Bq Er EIO
  84 An I/O error occurred while reading from the file system.
  85 .It Bq Er EFAULT
  86 The
  87 .Fa buf
  88 argument
  89 extends outside the process's allocated address space.
  90 .El
  91 .Sh SEE ALSO
  92 .Xr lstat 2 ,
  93 .Xr stat 2 ,
  94 .Xr symlink 2 ,
  95 .Xr symlink 7
  96 .Sh HISTORY
  97 The
  98 .Fn readlink
  99 system call appeared in
 100 .Bx 4.2 .