Section: Linux Programmer's Manual (2)
Return to Main Contents
symlink - make a new name for a file
int symlink(const char *oldpath, const char *newpath);
Feature Test Macro Requirements for glibc (see
_BSD_SOURCE || _XOPEN_SOURCE >= 500 ||
_XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED || _POSIX_C_SOURCE >= 200112L
creates a symbolic link named
which contains the string
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
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
renaming of the link is requested and the link is in a directory with
the sticky bit
exists it will
On success, zero is returned.
On error, -1 is returned, and
is set appropriately.
Write access to the directory containing
is denied, or one of the directories in the path prefix of
did not allow search permission.
The user's quota of resources on the filesystem has been exhausted.
The resources could be inodes or disk blocks, depending on the filesystem
oldpath or newpath points outside your accessible address space.
An I/O error occurred.
Too many symbolic links were encountered in resolving
oldpath or newpath was too long.
A directory component in
does not exist or is a dangling symbolic link, or
is the empty string.
Insufficient kernel memory was available.
The device containing the file has no room for the new directory
A component used as a directory in
is not, in fact, a directory.
The filesystem containing
does not support the creation of symbolic links.
is on a read-only filesystem.
SVr4, 4.3BSD, POSIX.1-2001.
No checking of
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
This page is part of release 3.54 of the Linux
A description of the project,
and information about reporting bugs,
can be found at
- RETURN VALUE
- CONFORMING TO
- SEE ALSO
This document was created by
using the manual pages.
Time: 21:37:21 GMT, January 23, 2018