Name

symlinkat — create a symbolic link relative to a directory file descriptor

Synopsis

#include <fcntl.h> /* Definition of AT_* constants */
#include <stdio.h>
int symlinkat( const char *oldpath,
  int newdirfd,
  const char *newpath);
 
[Note] Note
Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
symlinkat():
Since glibc 2.10:
_XOPEN_SOURCE >= 700 || _POSIX_C_SOURCE >= 200809L
Before glibc 2.10:
_ATFILE_SOURCE

DESCRIPTION

The symlinkat() system call operates in exactly the same way as symlink(2), except for the differences described in this manual page.

If the pathname given in newpath is relative, then it is interpreted relative to the directory referred to by the file descriptor newdirfd (rather than relative to the current working directory of the calling process, as is done by symlink(2) for a relative pathname).

If newpath is relative and newdirfd is the special value AT_FDCWD, then newpath is interpreted relative to the current working directory of the calling process (like symlink(2)).

If newpath is absolute, then newdirfd is ignored.

RETURN VALUE

On success, symlinkat() returns 0. On error, −1 is returned and errno is set to indicate the error.

ERRORS

The same errors that occur for symlink(2) can also occur for symlinkat(). The following additional errors can occur for symlinkat():

EBADF

newdirfd is not a valid file descriptor.

ENOTDIR

newpath is relative and newdirfd is a file descriptor referring to a file other than a directory.

VERSIONS

symlinkat() was added to Linux in kernel 2.6.16.

CONFORMING TO

POSIX.1-2008.

NOTES

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

SEE ALSO

openat(2), symlink(2), path_resolution(7), symlink(7)

COLOPHON

This page is part of release 3.24 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/.


This manpage is Copyright (C) 2006, Michael Kerrisk

Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.

Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.

Since the Linux kernel and libraries are constantly changing, this
manual page may be incorrect or out-of-date.  The author(s) assume no
responsibility for errors or omissions, or for damages resulting from
the use of the information contained herein.  The author(s) may not
have taken the same level of care in the production of this manual,
which is licensed free of charge, as they might when working
professionally.

Formatted or processed versions of this manual, if unaccompanied by
the source, must acknowledge the copyright and authors of this work.