1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 4. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)symlink.2 8.1 (Berkeley) 6/4/93
29 .\" $FreeBSD: src/lib/libc/sys/symlink.2,v 1.23 2008/04/16 13:03:12 kib Exp $
37 .Nd make symbolic link to a file
43 .Fn symlink "const char *name1" "const char *name2"
45 .Fn symlinkat "const char *name1" "int fd" "const char *name2"
56 used in creating the symbolic link).
57 Either name may be an arbitrary path name; the files need not
58 be on the same file system.
62 system call is equivalent to
64 except in the case where
66 specifies a relative path.
67 In this case the symbolic link is created relative to the directory
68 associated with the file descriptor
70 instead of the current working directory.
73 is passed the special value
77 parameter, the current working directory is used and the behavior is
78 identical to a call to
83 The symbolic link succeeds unless:
88 path prefix is not a directory.
89 .It Bq Er ENAMETOOLONG
92 pathname exceeded 255 characters,
93 or the entire length of either path name exceeded 1023 characters.
97 path prefix does not exist.
101 path prefix denies search permission, or write permission is denied on the
102 parent directory of the file to be created.
104 Too many symbolic links were encountered in translating the
108 The path name pointed at by the
113 The parent directory of the file named by
115 has its immutable flag set, see the
117 manual page for more information.
119 An I/O error occurred while making the directory entry for
121 or allocating the inode for
123 or writing out the link contents of
128 would reside on a read-only file system.
130 The directory in which the entry for the new symbolic link is being placed
131 cannot be extended because there is no space left on the file
132 system containing the directory.
134 The new symbolic link cannot be created because
135 there is no space left on the file
136 system that will contain the symbolic link.
138 There are no free inodes on the file system on which the
139 symbolic link is being created.
141 The directory in which the entry for the new symbolic link
142 is being placed cannot be extended because the
143 user's quota of disk blocks on the file system
144 containing the directory has been exhausted.
146 The new symbolic link cannot be created because the user's
147 quota of disk blocks on the file system that will
148 contain the symbolic link has been exhausted.
150 The user's quota of inodes on the file system on
151 which the symbolic link is being created has been exhausted.
153 An I/O error occurred while making the directory entry or allocating the inode.
160 points outside the process's allocated address space.
163 In addition to the errors returned by the
172 argument does not specify an absolute path and the
176 nor a valid file descriptor open for searching.
180 argument is not an absolute path and
184 nor a file descriptor associated with a directory.
197 system call follows The Open Group Extended API Set 2 specification.
201 system call appeared in
205 system call appeared in