2004-11-03 13:51:07 +00:00
|
|
|
.\" Hey Emacs! This file is -*- nroff -*- source.
|
|
|
|
.\"
|
|
|
|
.\" This manpage is Copyright (C) 1992 Drew Eckhardt;
|
|
|
|
.\" 1993 Michael Haardt, Ian Jackson.
|
|
|
|
.\"
|
|
|
|
.\" 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.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" 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.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
|
|
|
.\" Modified 1993-07-24 by Rik Faith
|
|
|
|
.\" Modified 1996-04-26 by Nick Duffek <nsd@bbc.com>
|
|
|
|
.\" Modified 1996-11-06 by Eric S. Raymond <esr@thyrsus.com>
|
|
|
|
.\" Modified 1997-01-31 by Eric S. Raymond <esr@thyrsus.com>
|
2007-09-20 06:52:22 +00:00
|
|
|
.\" Modified 2004-06-23 by Michael Kerrisk <mtk.manpages@gmail.com>
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
fallocate.2, kcmp.2, link.2, listxattr.2, mkdir.2, mknod.2, open.2, ptrace.2, query_module.2, rename.2, symlink.2, write.2, mkfifo.3, core.5: tstamp
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-01-27 20:27:57 +00:00
|
|
|
.TH SYMLINK 2 2013-01-27 "Linux" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
symlink \- make a new name for a file
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.B #include <unistd.h>
|
|
|
|
.sp
|
|
|
|
.BI "int symlink(const char *" oldpath ", const char *" newpath );
|
2007-07-08 12:11:40 +00:00
|
|
|
.sp
|
|
|
|
.in -4n
|
|
|
|
Feature Test Macro Requirements for glibc (see
|
|
|
|
.BR feature_test_macros (7)):
|
|
|
|
.in
|
|
|
|
.sp
|
|
|
|
.ad l
|
|
|
|
.BR symlink ():
|
2010-09-18 09:02:19 +00:00
|
|
|
.RS 4
|
|
|
|
_BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
|
|
|
|
_XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED || _POSIX_C_SOURCE\ >=\ 200112L
|
|
|
|
.RE
|
2007-07-08 12:11:40 +00:00
|
|
|
.ad b
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH DESCRIPTION
|
2005-10-19 06:54:38 +00:00
|
|
|
.BR symlink ()
|
2004-11-03 13:51:07 +00:00
|
|
|
creates a symbolic link named
|
|
|
|
.I newpath
|
|
|
|
which contains the string
|
|
|
|
.IR oldpath .
|
|
|
|
|
2008-03-19 08:46:32 +00:00
|
|
|
Symbolic links are interpreted at run time as if the contents of the
|
2004-11-03 13:51:07 +00:00
|
|
|
link had been substituted into the path being followed to find a file or
|
|
|
|
directory.
|
|
|
|
|
|
|
|
Symbolic links may contain
|
2005-11-02 11:55:24 +00:00
|
|
|
.I ..
|
2004-11-03 13:51:07 +00:00
|
|
|
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
|
|
|
|
renaming of the link is requested and the link is in a directory with
|
|
|
|
the sticky bit
|
|
|
|
.RB ( S_ISVTX )
|
|
|
|
set.
|
|
|
|
|
|
|
|
If
|
|
|
|
.I newpath
|
|
|
|
exists it will
|
|
|
|
.I not
|
|
|
|
be overwritten.
|
|
|
|
.SH "RETURN VALUE"
|
2007-04-12 22:42:49 +00:00
|
|
|
On success, zero is returned.
|
|
|
|
On error, \-1 is returned, and
|
2004-11-03 13:51:07 +00:00
|
|
|
.I errno
|
|
|
|
is set appropriately.
|
|
|
|
.SH ERRORS
|
|
|
|
.TP
|
|
|
|
.B EACCES
|
|
|
|
Write access to the directory containing
|
|
|
|
.I newpath
|
|
|
|
is denied, or one of the directories in the path prefix of
|
2007-09-20 16:26:31 +00:00
|
|
|
.I newpath
|
2004-11-03 13:51:07 +00:00
|
|
|
did not allow search permission.
|
|
|
|
(See also
|
2007-05-26 12:41:39 +00:00
|
|
|
.BR path_resolution (7).)
|
2004-11-03 13:51:07 +00:00
|
|
|
.TP
|
link.2, mkdir.2, mknod.2, open.2, rename.2, symlink.2, write.2, mkfifo.3: Document EDQUOT error
The return error EDQUOT is not documented in open(2), write(2),
symlink(2) etc..
Whether inodes or disk blocks are required for each function
is something I based on received wisdom and BSD documentation,
rather than tracing the code to the kernel. For symlink(2)
this certainly depends on the file system type.
This patch was previously sent to the linux-man mailing list
as an RFC in September 2010.
Signed-off-by: Mark Hills <mark@pogo.org.uk>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2012-12-22 17:56:59 +00:00
|
|
|
.B EDQUOT
|
|
|
|
The user's quota of resources on the file system has been exhausted.
|
2012-12-22 17:59:11 +00:00
|
|
|
The resources could be inodes or disk blocks, depending on the file
|
link.2, mkdir.2, mknod.2, open.2, rename.2, symlink.2, write.2, mkfifo.3: Document EDQUOT error
The return error EDQUOT is not documented in open(2), write(2),
symlink(2) etc..
Whether inodes or disk blocks are required for each function
is something I based on received wisdom and BSD documentation,
rather than tracing the code to the kernel. For symlink(2)
this certainly depends on the file system type.
This patch was previously sent to the linux-man mailing list
as an RFC in September 2010.
Signed-off-by: Mark Hills <mark@pogo.org.uk>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2012-12-22 17:56:59 +00:00
|
|
|
system implementation.
|
|
|
|
.TP
|
2004-11-03 13:51:07 +00:00
|
|
|
.B EEXIST
|
|
|
|
.I newpath
|
|
|
|
already exists.
|
|
|
|
.TP
|
|
|
|
.B EFAULT
|
|
|
|
.IR oldpath " or " newpath " points outside your accessible address space."
|
|
|
|
.TP
|
|
|
|
.B EIO
|
|
|
|
An I/O error occurred.
|
|
|
|
.TP
|
|
|
|
.B ELOOP
|
|
|
|
Too many symbolic links were encountered in resolving
|
|
|
|
.IR newpath .
|
|
|
|
.TP
|
|
|
|
.B ENAMETOOLONG
|
|
|
|
.IR oldpath " or " newpath " was too long."
|
|
|
|
.TP
|
|
|
|
.B ENOENT
|
|
|
|
A directory component in
|
|
|
|
.I newpath
|
|
|
|
does not exist or is a dangling symbolic link, or
|
|
|
|
.I oldpath
|
|
|
|
is the empty string.
|
|
|
|
.TP
|
|
|
|
.B ENOMEM
|
|
|
|
Insufficient kernel memory was available.
|
|
|
|
.TP
|
|
|
|
.B ENOSPC
|
|
|
|
The device containing the file has no room for the new directory
|
|
|
|
entry.
|
|
|
|
.TP
|
|
|
|
.B ENOTDIR
|
|
|
|
A component used as a directory in
|
2007-09-20 16:26:31 +00:00
|
|
|
.I newpath
|
2004-11-03 13:51:07 +00:00
|
|
|
is not, in fact, a directory.
|
|
|
|
.TP
|
|
|
|
.B EPERM
|
2008-03-19 07:26:08 +00:00
|
|
|
The file system containing
|
2007-09-20 16:26:31 +00:00
|
|
|
.I newpath
|
2004-11-03 13:51:07 +00:00
|
|
|
does not support the creation of symbolic links.
|
|
|
|
.TP
|
|
|
|
.B EROFS
|
|
|
|
.I newpath
|
2008-03-19 07:26:08 +00:00
|
|
|
is on a read-only file system.
|
2007-05-18 16:30:46 +00:00
|
|
|
.SH "CONFORMING TO"
|
|
|
|
SVr4, 4.3BSD, POSIX.1-2001.
|
|
|
|
.\" SVr4 documents additional error codes EDQUOT and ENOSYS.
|
|
|
|
.\" See
|
|
|
|
.\" .BR open (2)
|
|
|
|
.\" re multiple files with the same name, and NFS.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NOTES
|
|
|
|
No checking of
|
|
|
|
.I oldpath
|
|
|
|
is done.
|
|
|
|
|
|
|
|
Deleting the name referred to by a symlink will actually delete the
|
2007-05-12 12:58:31 +00:00
|
|
|
file (unless it also has other hard links).
|
2007-06-08 09:56:56 +00:00
|
|
|
If this behavior is not desired, use
|
2007-05-11 23:07:02 +00:00
|
|
|
.BR link (2).
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR ln (1),
|
2008-05-13 11:29:39 +00:00
|
|
|
.BR lchown (2),
|
2004-11-03 13:51:07 +00:00
|
|
|
.BR link (2),
|
|
|
|
.BR lstat (2),
|
|
|
|
.BR open (2),
|
|
|
|
.BR readlink (2),
|
|
|
|
.BR rename (2),
|
2006-04-06 08:48:43 +00:00
|
|
|
.BR symlinkat (2),
|
2007-12-17 11:24:18 +00:00
|
|
|
.BR unlink (2),
|
2008-06-11 21:50:53 +00:00
|
|
|
.BR path_resolution (7),
|
2008-06-11 22:19:03 +00:00
|
|
|
.BR symlink (7)
|