1.\" Copyright (c) 1983, 1991 The Regents of the University of California. 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 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.\" 3. All advertising materials mentioning features or use of this software 13.\" must display the following acknowledgement: 14.\" This product includes software developed by the University of 15.\" California, Berkeley and its contributors. 16.\" 4. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)symlink.2 6.6 (Berkeley) 3/10/91 33.\" 34.Dd March 10, 1991 35.Dt SYMLINK 2 36.Os BSD 4.2 37.Sh NAME 38.Nm symlink 39.Nd make symbolic link to a file 40.Sh SYNOPSIS 41.Fd #include <unistd.h> 42.Ft int 43.Fn symlink "const char *name1" "const char *name2" 44.Sh DESCRIPTION 45A symbolic link 46.Fa name2 47is created to 48.Fa name1 49.Pf ( Fa name2 50is the name of the 51file created, 52.Fa name1 53is the string 54used in creating the symbolic link). 55Either name may be an arbitrary path name; the files need not 56be on the same file system. 57.Sh RETURN VALUES 58Upon successful completion, a zero value is returned. 59If an error occurs, the error code is stored in 60.Va errno 61and a -1 value is returned. 62.Sh ERRORS 63The symbolic link succeeds unless: 64.Bl -tag -width ENAMETOO 65.It Bq Er ENOTDIR 66A component of the 67.Fa name2 68prefix is not a directory. 69.It Bq Er EINVAL 70Either 71.Fa name1 72or 73.Fa name2 74contains a character with the high-order bit set. 75.It Bq Er ENAMETOOLONG 76A component of either pathname exceeded 255 characters, 77or the entire length of either path name exceeded 1023 characters. 78.It Bq Er ENOENT 79The named file does not exist. 80.It Bq Er EACCES 81A component of the 82.Fa name2 83path prefix denies search permission. 84.It Bq Er ELOOP 85Too many symbolic links were encountered in translating the pathname. 86.It Bq Er EEXIST 87.Fa Name2 88already exists. 89.It Bq Er EIO 90An I/O error occurred while making the directory entry for 91.Fa name2 , 92or allocating the inode for 93.Fa name2 , 94or writing out the link contents of 95.Fa name2 . 96.It Bq Er EROFS 97The file 98.Fa name2 99would reside on a read-only file system. 100.It Bq Er ENOSPC 101The directory in which the entry for the new symbolic link is being placed 102cannot be extended because there is no space left on the file 103system containing the directory. 104.It Bq Er ENOSPC 105The new symbolic link cannot be created because there 106there is no space left on the file 107system that will contain the symbolic link. 108.It Bq Er ENOSPC 109There are no free inodes on the file system on which the 110symbolic link is being created. 111.It Bq Er EDQUOT 112The directory in which the entry for the new symbolic link 113is being placed cannot be extended because the 114user's quota of disk blocks on the file system 115containing the directory has been exhausted. 116.It Bq Er EDQUOT 117The new symbolic link cannot be created because the user's 118quota of disk blocks on the file system that will 119contain the symbolic link has been exhausted. 120.It Bq Er EDQUOT 121The user's quota of inodes on the file system on 122which the symbolic link is being created has been exhausted. 123.It Bq Er EIO 124An I/O error occurred while making the directory entry or allocating the inode. 125.It Bq Er EFAULT 126.Fa Name1 127or 128.Fa name2 129points outside the process's allocated address space. 130.El 131.Sh SEE ALSO 132.Xr link 2 , 133.Xr ln 1 , 134.Xr unlink 2 135.Sh HISTORY 136The 137.Nm 138function call appeared in 139.Bx 4.2 . 140