bsd/man/man2/symlink.2

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