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