symlinkat(2)

1SYMLINKAT(2)               Linux Programmer's Manual              SYMLINKAT(2)
2
3
4

NAME

6       symlinkat  -  create  a  symbolic  link  relative  to  a directory file
7       descriptor
8

SYNOPSIS

10       #include <fcntl.h> /* Definition of AT_* constants */
11       #include <unistd.h>
12
13       int symlinkat(const char *oldpath, int newdirfd, const char *newpath);
14
15   Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
16
17       symlinkat():
18           Since glibc 2.10:
19               _XOPEN_SOURCE >= 700 || _POSIX_C_SOURCE >= 200809L
20           Before glibc 2.10:
21               _ATFILE_SOURCE
22

DESCRIPTION

24       The symlinkat() system call operates in exactly the same  way  as  sym‐
25       link(2), except for the differences described in this manual page.
26
27       If  the  pathname  given in newpath is relative, then it is interpreted
28       relative to the directory referred to by the file  descriptor  newdirfd
29       (rather  than  relative to the current working directory of the calling
30       process, as is done by symlink(2) for a relative pathname).
31
32       If newpath is relative and newdirfd is the special value AT_FDCWD, then
33       newpath is interpreted relative to the current working directory of the
34       calling process (like symlink(2)).
35
36       If newpath is absolute, then newdirfd is ignored.
37

RETURN VALUE

39       On success, symlinkat() returns 0.  On error, -1 is returned and  errno
40       is set to indicate the error.
41

ERRORS

43       The  same  errors  that  occur  for  symlink(2) can also occur for sym‐
44       linkat().  The following additional errors can occur for symlinkat():
45
46       EBADF  newdirfd is not a valid file descriptor.
47
48       ENOTDIR
49              newpath is relative and newdirfd is a file descriptor  referring
50              to a file other than a directory.
51

VERSIONS

53       symlinkat()  was  added  to Linux in kernel 2.6.16; library support was
54       added to glibc in version 2.4.
55

CONFORMING TO

57       POSIX.1-2008.
58

NOTES

60       See openat(2) for an explanation of the need for symlinkat().
61

COLOPHON

66       This page is part of release 3.53 of the Linux  man-pages  project.   A
67       description  of  the project, and information about reporting bugs, can
68       be found at http://www.kernel.org/doc/man-pages/.
69
70
71
72Linux                             2012-05-04                      SYMLINKAT(2)