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 45.Fn symlink "const char *name1" "const char *name2" 46.Sh DESCRIPTION 47A symbolic link 48.Fa name2 49is created to 50.Fa name1 51.Pf ( Fa name2 52is the name of the 53file created, 54.Fa name1 55is the string 56used in creating the symbolic link). 57Either name may be an arbitrary path name; the files need not 58be on the same file system. 59.Sh RETURN VALUES 60Upon successful completion, a zero value is returned. 61If an error occurs, the error code is stored in 62.Va errno 63and a -1 value is returned. 64.Sh ERRORS 65The symbolic link succeeds unless: 66.Bl -tag -width Er 67.It Bq Er ENOTDIR 68A component of the 69.Fa name2 70prefix is not a directory. 71.It Bq Er ENAMETOOLONG 72A component of a pathname exceeded 73.Dv {NAME_MAX} 74characters, or an entire path name exceeded 75.Dv {PATH_MAX} 76characters. 77.It Bq Er ENOENT 78The named file does not exist. 79.It Bq Er EACCES 80A component of the 81.Fa name2 82path prefix denies search permission. 83.It Bq Er ELOOP 84Too many symbolic links were encountered in translating the pathname. 85.It Bq Er EEXIST 86.Fa Name2 87already exists. 88.It Bq Er EIO 89An I/O error occurred while making the directory entry for 90.Fa name2 , 91or allocating the inode for 92.Fa name2 , 93or writing out the link contents of 94.Fa name2 . 95.It Bq Er EROFS 96The file 97.Fa name2 98would reside on a read-only file system. 99.It Bq Er ENOSPC 100The directory in which the entry for the new symbolic link is being placed 101cannot be extended because there is no space left on the file 102system containing the directory. 103.It Bq Er ENOSPC 104The new symbolic link cannot be created because there 105there is no space left on the file 106system that will contain the symbolic link. 107.It Bq Er ENOSPC 108There are no free inodes on the file system on which the 109symbolic link is being created. 110.It Bq Er EDQUOT 111The directory in which the entry for the new symbolic link 112is being placed cannot be extended because the 113user's quota of disk blocks on the file system 114containing the directory has been exhausted. 115.It Bq Er EDQUOT 116The new symbolic link cannot be created because the user's 117quota of disk blocks on the file system that will 118contain the symbolic link has been exhausted. 119.It Bq Er EDQUOT 120The user's quota of inodes on the file system on 121which the symbolic link is being created has been exhausted. 122.It Bq Er EIO 123An I/O error occurred while making the directory entry or allocating the inode. 124.It Bq Er EFAULT 125.Fa Name1 126or 127.Fa name2 128points outside the process's allocated address space. 129.El 130.Sh SEE ALSO 131.Xr link 2 , 132.Xr ln 1 , 133.Xr unlink 2 134.Sh HISTORY 135The 136.Fn symlink 137function call appeared in 138.Bx 4.2 . 139