original/man2/readlink.2

   1 .\" Copyright (c) 1983, 1991 The Regents of the University of California.
   2 .\" 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  6.8 (Berkeley) 3/10/91
  33 .\"
  34 .\" Modified Sat Jul 24 00:10:21 1993 by Rik Faith (faith@cs.unc.edu)
  35 .\" Modified Tue Jul  9 23:55:17 1996 by aeb
  36 .\" Modified Fri Jan 24 00:26:00 1997 by aeb
  37 .\"
  38 .TH READLINK 2 2010-09-20 "Linux" "Linux Programmer's Manual"
  39 .SH NAME
  40 readlink \- read value of a symbolic link
  41 .SH SYNOPSIS
  42 .B #include <unistd.h>
  43 .sp
  44 .BI "ssize_t readlink(const char *" path ", char *" buf ", size_t " bufsiz );
  45 .sp
  46 .in -4n
  47 Feature Test Macro Requirements for glibc (see
  48 .BR feature_test_macros (7)):
  49 .in
  50 .sp
  51 .ad l
  52 .BR readlink ():
  53 .RS 4
  54 _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  55 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED || _POSIX_C_SOURCE\ >=\ 200112L
  56 .RE
  57 .ad b
  58 .SH DESCRIPTION
  59 .BR readlink ()
  60 places the contents of the symbolic link
  61 .I path
  62 in the buffer
  63 .IR buf ,
  64 which has size
  65 .IR bufsiz .
  66 .BR readlink ()
  67 does not append a null byte to
  68 .IR buf .
  69 It will truncate the contents (to a length of
  70 .I bufsiz
  71 characters), in case the buffer is too small to hold all of the contents.
  72 .SH "RETURN VALUE"
  73 On success,
  74 .BR readlink ()
  75 returns the number of bytes placed in
  76 .IR buf .
  77 On error, \-1 is returned and
  78 .I errno
  79 is set to indicate the error.
  80 .SH ERRORS
  81 .TP
  82 .B EACCES
  83 Search permission is denied for a component of the path prefix.
  84 (See also
  85 .BR path_resolution (7).)
  86 .TP
  87 .B EFAULT
  88 .I buf
  89 extends outside the process's allocated address space.
  90 .TP
  91 .B EINVAL
  92 .I bufsiz
  93 is not positive.
  94 .\" At the glibc level, bufsiz is unsigned, so this error can only occur
  95 .\" if bufsiz==0.  However, the in the kernel syscall, bufsiz is signed,
  96 .\" and this error can also occur if bufsiz < 0.
  97 .\" See: http://thread.gmane.org/gmane.linux.man/380
  98 .\" Subject: [patch 0/3] [RFC] kernel/glibc mismatch of "readlink" syscall?
  99 .TP
 100 .B EINVAL
 101 The named file is not a symbolic link.
 102 .TP
 103 .B EIO
 104 An I/O error occurred while reading from the file system.
 105 .TP
 106 .B ELOOP
 107 Too many symbolic links were encountered in translating the pathname.
 108 .TP
 109 .B ENAMETOOLONG
 110 A pathname, or a component of a pathname, was too long.
 111 .TP
 112 .B ENOENT
 113 The named file does not exist.
 114 .TP
 115 .B ENOMEM
 116 Insufficient kernel memory was available.
 117 .TP
 118 .B ENOTDIR
 119 A component of the path prefix is not a directory.
 120 .SH "CONFORMING TO"
 121 4.4BSD
 122 .RB ( readlink ()
 123 first appeared in 4.2BSD),
 124 POSIX.1-2001.
 125 .SH NOTES
 126 In versions of glibc up to and including glibc 2.4, the return type of
 127 .BR readlink ()
 128 was declared as
 129 .IR int .
 130 Nowadays, the return type is declared as
 131 .IR ssize_t ,
 132 as (newly) required in POSIX.1-2001.
 133 .SH "SEE ALSO"
 134 .BR lstat (2),
 135 .BR readlinkat (2),
 136 .BR stat (2),
 137 .BR symlink (2),
 138 .BR path_resolution (7),
 139 .BR symlink (7)