symlinkat man page on Archlinux

Man page or keyword search:  
man Server   11224 pages
apropos Keyword Search (all sections)
Output format
Archlinux logo
[printable version]

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

       symlink, symlinkat - make a new name for a file

       #include <unistd.h>

       int symlink(const char *target, const char *linkpath);

       #include <fcntl.h>	    /* Definition of AT_* constants */
       #include <unistd.h>

       int symlinkat(const char *target, int newdirfd, const char *linkpath);

   Feature Test Macro Requirements for glibc (see feature_test_macros(7)):

	   _BSD_SOURCE || _XOPEN_SOURCE >= 500 ||
	   _POSIX_C_SOURCE >= 200112L

	   Since glibc 2.10:
	       _XOPEN_SOURCE >= 700 || _POSIX_C_SOURCE >= 200809L
	   Before glibc 2.10:

       symlink()  creates  a  symbolic	link named linkpath which contains the
       string target.

       Symbolic links are interpreted at run time as if the  contents  of  the
       link  had  been substituted into the path being followed to find a file
       or directory.

       Symbolic links may contain ..  path components, which (if used  at  the
       start of the link) refer to the parent directories of that in which the
       link resides.

       A symbolic link (also known as a soft link) may point  to  an  existing
       file  or	 to  a nonexistent one; the latter case is known as a dangling

       The permissions of a symbolic link are  irrelevant;  the	 ownership  is
       ignored	when following the link, but is checked when removal or renam‐
       ing of the link is requested and the link is in a  directory  with  the
       sticky bit (S_ISVTX) set.

       If linkpath exists, it will not be overwritten.

       The  symlinkat()	 system	 call operates in exactly the same way as sym‐
       link(), except for the differences described here.

       If the pathname given in linkpath 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() for a relative pathname).

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

       If linkpath is absolute, then newdirfd is ignored.

       On  success,  zero is returned.	On error, -1 is returned, and errno is
       set appropriately.

       EACCES Write access to the directory containing linkpath is denied,  or
	      one  of  the  directories in the path prefix of linkpath did not
	      allow search permission.	(See also path_resolution(7).)

       EDQUOT The user's  quota	 of  resources	on  the	 filesystem  has  been
	      exhausted.   The	resources  could  be  inodes  or  disk blocks,
	      depending on the filesystem implementation.

       EEXIST linkpath already exists.

       EFAULT target or linkpath points outside your accessible address space.

       EIO    An I/O error occurred.

       ELOOP  Too many symbolic links were encountered in resolving linkpath.

	      target or linkpath was too long.

       ENOENT A directory component in linkpath does not exist or  is  a  dan‐
	      gling symbolic link, or target is the empty string.

       ENOMEM Insufficient kernel memory was available.

       ENOSPC The device containing the file has no room for the new directory

	      A component used as a directory in linkpath is not, in  fact,  a

       EPERM  The filesystem containing linkpath does not support the creation
	      of symbolic links.

       EROFS  linkpath is on a read-only filesystem.

       The following additional errors can occur for symlinkat():

       EBADF  newdirfd is not a valid file descriptor.

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

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

       symlink(): SVr4, 4.3BSD, POSIX.1-2001, POSIX.1-2008.

       symlinkat(): POSIX.1-2008.

       No checking of target is done.

       Deleting the name referred to by a symbolic link will  actually	delete
       the  file  (unless  it also has other hard links).  If this behavior is
       not desired, use link(2).

       ln(1), lchown(2), link(2), lstat(2), open(2),  readlink(2),  rename(2),
       unlink(2), path_resolution(7), symlink(7)

       This  page  is  part of release 3.65 of the Linux man-pages project.  A
       description of the project, and information about reporting  bugs,  can
       be found at

Linux				  2014-02-21			    SYMLINK(2)

List of man pages available for Archlinux

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
Vote for polarhome
Free Shell Accounts :: the biggest list on the net