unixdev.net


Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (Debian-5.0)
Page:
Section:
Apropos / Subsearch:
optional field

SYMLINKAT(2)               Linux Programmer's Manual              SYMLINKAT(2)



NAME
       symlinkat  -  create  a  symbolic  link  relative  to  a directory file
       descriptor

SYNOPSIS
       #define _ATFILE_SOURCE
       #include <&lt;fcntl.h>&gt; /* Definition of AT_* constants */
       #include <&lt;stdio.h>&gt;

       int symlinkat(const char *oldpath, int newdirfd, const char *newpath);

DESCRIPTION
       The symlinkat() system call operates in exactly the same  way  as  sym-
       link(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 sym-
       linkat().  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
       This  system  call  is  non-standard but is proposed for inclusion in a
       future revision of POSIX.1.

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.05 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/.



Linux                             2006-04-10                      SYMLINKAT(2)