lib/libc/sys/symlink.2

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  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   8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/sys/symlink.2,v 1.8.2.4 2001/12/14 18:34:01 ru Exp $
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt SYMLINK 2
  37 .Os
  38 .Sh NAME
  39 .Nm symlink
  40 .Nd make symbolic link to a file
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In unistd.h
  45 .Ft int
  46 .Fn symlink "const char *name1" "const char *name2"
  47 .Sh DESCRIPTION
  48 A symbolic link
  49 .Fa name2
  50 is created to
  51 .Fa name1
  52 .Pf ( Fa name2
  53 is the name of the
  54 file created,
  55 .Fa name1
  56 is the string
  57 used in creating the symbolic link).
  58 Either name may be an arbitrary path name; the files need not
  59 be on the same file system.
  60 .Sh RETURN VALUES
  61 .Rv -std symlink
  62 .Sh ERRORS
  63 The symbolic link succeeds unless:
  64 .Bl -tag -width Er
  65 .It Bq Er ENOTDIR
  66 A component of the
  67 .Fa name2
  68 prefix is not a directory.
  69 .It Bq Er ENAMETOOLONG
  70 A component of either pathname exceeded 255 characters,
  71 or the entire length of either path name exceeded 1023 characters.
  72 .It Bq Er ENOENT
  73 The named file does not exist.
  74 .It Bq Er EACCES
  75 A component of the
  76 .Fa name2
  77 path prefix denies search permission.
  78 .It Bq Er ELOOP
  79 Too many symbolic links were encountered in translating the pathname.
  80 .It Bq Er EEXIST
  81 .Fa Name2
  82 already exists.
  83 .It Bq Er EIO
  84 An I/O error occurred while making the directory entry for
  85 .Fa name2 ,
  86 or allocating the inode for
  87 .Fa name2 ,
  88 or writing out the link contents of
  89 .Fa name2 .
  90 .It Bq Er EROFS
  91 The file
  92 .Fa name2
  93 would reside on a read-only file system.
  94 .It Bq Er ENOSPC
  95 The directory in which the entry for the new symbolic link is being placed
  96 cannot be extended because there is no space left on the file
  97 system containing the directory.
  98 .It Bq Er ENOSPC
  99 The new symbolic link cannot be created because
 100 there is no space left on the file
 101 system that will contain the symbolic link.
 102 .It Bq Er ENOSPC
 103 There are no free inodes on the file system on which the
 104 symbolic link is being created.
 105 .It Bq Er EDQUOT
 106 The directory in which the entry for the new symbolic link
 107 is being placed cannot be extended because the
 108 user's quota of disk blocks on the file system
 109 containing the directory has been exhausted.
 110 .It Bq Er EDQUOT
 111 The new symbolic link cannot be created because the user's
 112 quota of disk blocks on the file system that will
 113 contain the symbolic link has been exhausted.
 114 .It Bq Er EDQUOT
 115 The user's quota of inodes on the file system on
 116 which the symbolic link is being created has been exhausted.
 117 .It Bq Er EIO
 118 An I/O error occurred while making the directory entry or allocating the inode.
 119 .It Bq Er EFAULT
 120 .Fa Name1
 121 or
 122 .Fa name2
 123 points outside the process's allocated address space.
 124 .El
 125 .Sh SEE ALSO
 126 .Xr ln 1 ,
 127 .Xr link 2 ,
 128 .Xr lstat 2 ,
 129 .Xr readlink 2 ,
 130 .Xr unlink 2 ,
 131 .Xr symlink 7
 132 .Sh HISTORY
 133 The
 134 .Fn symlink
 135 function call appeared in
 136 .Bx 4.2 .