]> git.saurik.com Git - apple/xnu.git/blame - bsd/man/man2/symlink.2
xnu-2422.115.4.tar.gz
[apple/xnu.git] / bsd / man / man2 / symlink.2
CommitLineData
9bccf70c
A
1.\" $NetBSD: symlink.2,v 1.7 1995/02/27 12:38:34 cgd Exp $
2.\"
3.\" Copyright (c) 1983, 1991, 1993
4.\" The Regents of the University of California. All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\" notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\" notice, this list of conditions and the following disclaimer in the
13.\" documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\" must display the following acknowledgement:
16.\" This product includes software developed by the University of
17.\" California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\" may be used to endorse or promote products derived from this software
20.\" without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\" @(#)symlink.2 8.1 (Berkeley) 6/4/93
35.\"
36.Dd June 4, 1993
37.Dt SYMLINK 2
38.Os BSD 4.2
39.Sh NAME
40.Nm symlink
41.Nd make symbolic link to a file
42.Sh SYNOPSIS
43.Fd #include <unistd.h>
44.Ft int
2d21ac55
A
45.Fo symlink
46.Fa "const char *path1"
47.Fa "const char *path2"
48.Fc
9bccf70c
A
49.Sh DESCRIPTION
50A symbolic link
2d21ac55 51.Fa path2
9bccf70c 52is created to
2d21ac55
A
53.Fa path1
54.Pf ( Fa path2
9bccf70c
A
55is the name of the
56file created,
2d21ac55 57.Fa path1
9bccf70c
A
58is the string
59used in creating the symbolic link).
60Either name may be an arbitrary path name; the files need not
61be on the same file system.
62.Sh RETURN VALUES
63Upon successful completion, a zero value is returned.
64If an error occurs, the error code is stored in
65.Va errno
66and a -1 value is returned.
67.Sh ERRORS
68The symbolic link succeeds unless:
69.Bl -tag -width Er
2d21ac55
A
70.\" ===========
71.It Bq Er EACCES
72Write permission is denied in the directory
73where the symbolic link is being created.
74.\" ===========
9bccf70c
A
75.It Bq Er EACCES
76A component of the
2d21ac55 77.Fa path2
9bccf70c 78path prefix denies search permission.
2d21ac55
A
79.\" ===========
80.It Bq Er EDQUOT
81The directory in which the entry for the new symbolic link
82is being placed cannot be extended because the
83user's quota of disk blocks on the file system
84containing the directory has been exhausted.
85.\" ===========
86.It Bq Er EDQUOT
87The new symbolic link cannot be created because the user's
88quota of disk blocks on the file system that will
89contain the symbolic link has been exhausted.
90.\" ===========
91.It Bq Er EDQUOT
92The user's quota of inodes on the file system on
93which the symbolic link is being created has been exhausted.
94.\" ===========
9bccf70c 95.It Bq Er EEXIST
2d21ac55 96.Fa Path2
9bccf70c 97already exists.
2d21ac55
A
98.\" ===========
99.It Bq Er EFAULT
100.Fa Path1
101or
102.Fa path2
103points outside the process's allocated address space.
104.\" ===========
105.It Bq Er EIO
106An I/O error occurs while making the directory entry
107or allocating the inode.
108.\" ===========
9bccf70c 109.It Bq Er EIO
2d21ac55
A
110An I/O error occurs while making the directory entry for
111.Fa path2 ,
9bccf70c 112or allocating the inode for
2d21ac55 113.Fa path2 ,
9bccf70c 114or writing out the link contents of
2d21ac55
A
115.Fa path2 .
116.\" ===========
117.It Bq Er ELOOP
118Too many symbolic links are encountered in translating the pathname.
119This is taken to be indicative of a looping symbolic link.
120.\" ===========
121.It Bq Er ENAMETOOLONG
122A component of a pathname exceeds
123.Dv {NAME_MAX}
124characters, or an entire path name exceeds
125.Dv {PATH_MAX}
126characters.
127.\" ===========
128.It Bq Er ENOENT
129A component of
130.Fa path2
131does not name an existing file or
132.Fa path2
133is an empty string.
134.\" ===========
9bccf70c
A
135.It Bq Er ENOSPC
136The directory in which the entry for the new symbolic link is being placed
137cannot be extended because there is no space left on the file
138system containing the directory.
2d21ac55 139.\" ===========
9bccf70c
A
140.It Bq Er ENOSPC
141The new symbolic link cannot be created because there
142there is no space left on the file
143system that will contain the symbolic link.
2d21ac55 144.\" ===========
9bccf70c
A
145.It Bq Er ENOSPC
146There are no free inodes on the file system on which the
147symbolic link is being created.
2d21ac55
A
148.\" ===========
149.It Bq Er ENOTDIR
150A component of the
151.Fa path2
152prefix is not a directory.
153.\" ===========
154.It Bq Er EROFS
155The file
156.Fa path2
157would reside on a read-only file system.
9bccf70c
A
158.El
159.Sh SEE ALSO
160.Xr ln 1 ,
161.Xr link 2 ,
2d21ac55
A
162.Xr unlink 2 ,
163.Xr symlink 7
9bccf70c
A
164.Sh HISTORY
165The
166.Fn symlink
167function call appeared in
168.Bx 4.2 .