Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

symlink(2) [centos man page]

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

NAME
symlink - make a new name for a file SYNOPSIS
#include <unistd.h> int symlink(const char *oldpath, const char *newpath); Feature Test Macro Requirements for glibc (see feature_test_macros(7)): symlink(): _BSD_SOURCE || _XOPEN_SOURCE >= 500 || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED || _POSIX_C_SOURCE >= 200112L DESCRIPTION
symlink() creates a symbolic link named newpath which contains the string oldpath. 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 link. 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 newpath exists it will not be overwritten. RETURN VALUE
On success, zero is returned. On error, -1 is returned, and errno is set appropriately. ERRORS
EACCES Write access to the directory containing newpath is denied, or one of the directories in the path prefix of newpath did not allow search permission. (See also path_resolution(7).) EDQUOT The user's quota of resources on the file system has been exhausted. The resources could be inodes or disk blocks, depending on the file system implementation. EEXIST newpath already exists. EFAULT oldpath or newpath points outside your accessible address space. EIO An I/O error occurred. ELOOP Too many symbolic links were encountered in resolving newpath. ENAMETOOLONG oldpath or newpath was too long. ENOENT A directory component in newpath does not exist or is a dangling symbolic link, or oldpath is the empty string. ENOMEM Insufficient kernel memory was available. ENOSPC The device containing the file has no room for the new directory entry. ENOTDIR A component used as a directory in newpath is not, in fact, a directory. EPERM The file system containing newpath does not support the creation of symbolic links. EROFS newpath is on a read-only file system. CONFORMING TO
SVr4, 4.3BSD, POSIX.1-2001. NOTES
No checking of oldpath is done. Deleting the name referred to by a symlink will actually delete the file (unless it also has other hard links). If this behavior is not desired, use link(2). SEE ALSO
ln(1), lchown(2), link(2), lstat(2), open(2), readlink(2), rename(2), symlinkat(2), unlink(2), path_resolution(7), symlink(7) COLOPHON
This page is part of release 3.53 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 2013-01-27 SYMLINK(2)

Check Out this Related Man Page

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

NAME
link - make a new name for a file SYNOPSIS
#include <unistd.h> int link(const char *oldpath, const char *newpath); DESCRIPTION
link() creates a new link (also known as a hard link) to an existing file. If newpath exists it will not be overwritten. This new name may be used exactly as the old one for any operation; both names refer to the same file (and so have the same permissions and ownership) and it is impossible to tell which name was the "original". RETURN VALUE
On success, zero is returned. On error, -1 is returned, and errno is set appropriately. ERRORS
EACCES Write access to the directory containing newpath is denied, or search permission is denied for one of the directories in the path prefix of oldpath or newpath. (See also path_resolution(7).) EEXIST newpath already exists. EFAULT oldpath or newpath points outside your accessible address space. EIO An I/O error occurred. ELOOP Too many symbolic links were encountered in resolving oldpath or newpath. EMLINK The file referred to by oldpath already has the maximum number of links to it. ENAMETOOLONG oldpath or newpath was too long. ENOENT A directory component in oldpath or newpath does not exist or is a dangling symbolic link. ENOMEM Insufficient kernel memory was available. ENOSPC The device containing the file has no room for the new directory entry. ENOTDIR A component used as a directory in oldpath or newpath is not, in fact, a directory. EPERM oldpath is a directory. EPERM The file system containing oldpath and newpath does not support the creation of hard links. EROFS The file is on a read-only file system. EXDEV oldpath and newpath are not on the same mounted file system. (Linux permits a file system to be mounted at multiple points, but link() does not work across different mount points, even if the same file system is mounted on both.) CONFORMING TO
SVr4, 4.3BSD, POSIX.1-2001 (but see NOTES). NOTES
Hard links, as created by link(), cannot span file systems. Use symlink(2) if this is required. POSIX.1-2001 says that link() should dereference oldpath if it is a symbolic link. However, since kernel 2.0, Linux does not do so: if oldpath is a symbolic link, then newpath is created as a (hard) link to the same symbolic link file (i.e., newpath becomes a symbolic link to the same file that oldpath refers to). Some other implementations behave in the same manner as Linux. POSIX.1-2008 changes the speci- fication of link(), making it implementation-dependent whether or not oldpath is dereferenced if it is a symbolic link. For precise con- trol over the treatment of symbolic links when creating a link, see linkat(2). BUGS
On NFS file systems, the return code may be wrong in case the NFS server performs the link creation and dies before it can say so. Use stat(2) to find out if the link got created. SEE ALSO
ln(1), linkat(2), open(2), rename(2), stat(2), symlink(2), unlink(2), path_resolution(7), symlink(7) COLOPHON
This page is part of release 3.27 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 2008-08-21 LINK(2)
Man Page

Featured Tech Videos