original/man2/readlinkat.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" This manpage is Copyright (C) 2006, Michael Kerrisk
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\"
  26 .TH READLINKAT 2 2009-12-13 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 readlinkat \- read value of a symbolic link relative to
  29 a directory file descriptor
  30 .SH SYNOPSIS
  31 .nf
  32 .B #include <fcntl.h>           /* Definition of AT_* constants */
  33 .B #include <unistd.h>
  34 .sp
  35 .BI "int readlinkat(int " dirfd ", const char *" pathname ,
  36 .BI "               char *" buf ", size_t " bufsiz );
  37 .fi
  38 .sp
  39 .in -4n
  40 Feature Test Macro Requirements for glibc (see
  41 .BR feature_test_macros (7)):
  42 .in
  43 .sp
  44 .BR readlinkat ():
  45 .br
  46 Since glibc 2.10: _XOPEN_SOURCE >= 700 || _POSIX_C_SOURCE >= 200809L
  47 .br
  48 Before glibc 2.10:
  49 _ATFILE_SOURCE
  50 .SH DESCRIPTION
  51 The
  52 .BR readlinkat ()
  53 system call operates in exactly the same way as
  54 .BR readlink (2),
  55 except for the differences described in this manual page.
  56
  57 If the pathname given in
  58 .I pathname
  59 is relative, then it is interpreted relative to the directory
  60 referred to by the file descriptor
  61 .I dirfd
  62 (rather than relative to the current working directory of
  63 the calling process, as is done by
  64 .BR readlink (2)
  65 for a relative pathname).
  66
  67 If
  68 .I pathname
  69 is relative and
  70 .I dirfd
  71 is the special value
  72 .BR AT_FDCWD ,
  73 then
  74 .I pathname
  75 is interpreted relative to the current working
  76 directory of the calling process (like
  77 .BR readlink (2)).
  78
  79 If
  80 .I pathname
  81 is absolute, then
  82 .I dirfd
  83 is ignored.
  84 .SH "RETURN VALUE"
  85 On success,
  86 .BR readlinkat ()
  87 returns the number of bytes placed in
  88 .IR buf .
  89 On error, \-1 is returned and
  90 .I errno
  91 is set to indicate the error.
  92 .SH ERRORS
  93 The same errors that occur for
  94 .BR readlink (2)
  95 can also occur for
  96 .BR readlinkat ().
  97 The following additional errors can occur for
  98 .BR readlinkat ():
  99 .TP
 100 .B EBADF
 101 .I dirfd
 102 is not a valid file descriptor.
 103 .TP
 104 .B ENOTDIR
 105 .I pathname
 106 is relative and
 107 .I dirfd
 108 is a file descriptor referring to a file other than a directory.
 109 .SH VERSIONS
 110 .BR readlinkat ()
 111 was added to Linux in kernel 2.6.16.
 112 .SH "CONFORMING TO"
 113 POSIX.1-2008.
 114 .SH NOTES
 115 See
 116 .BR openat (2)
 117 for an explanation of the need for
 118 .BR readlinkat ().
 119 .SH "SEE ALSO"
 120 .BR openat (2),
 121 .BR readlink (2),
 122 .BR path_resolution (7)