original/man2/symlinkat.2

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