BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / sys / symlink.2

diff --git a/usr/src/lib/libc/sys/symlink.2 b/usr/src/lib/libc/sys/symlink.2
index 5285eca..4ab58b7 100644 (file)
--- a/usr/src/lib/libc/sys/symlink.2
+++ b/usr/src/lib/libc/sys/symlink.2
@@ -1,118 +1,139 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
+.\" Copyright (c) 1983, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)symlink.2   6.5 (Berkeley) 6/23/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.TH SYMLINK 2 "June 23, 1990"
-.UC 5
-.SH NAME
-symlink \- make symbolic link to a file
-.SH SYNOPSIS
-.nf
-.ft B
-symlink(name1, name2)
-char *name1, *name2;
-.fi
-.ft R
-.SH DESCRIPTION
+.\"     @(#)symlink.2  6.6 (Berkeley) 3/10/91
+.\"
+.Dd March 10, 1991
+.Dt SYMLINK 2
+.Os BSD 4.2
+.Sh NAME
+.Nm symlink
+.Nd make symbolic link to a file
+.Sh SYNOPSIS
+.Fd #include <unistd.h>
+.Ft int
+.Fn symlink "const char *name1" "const char *name2"
+.Sh DESCRIPTION

 A symbolic link
 A symbolic link

-.I name2
+.Fa name2

 is created to
 is created to

-.IR name1
-(\fIname2\fP is the name of the
-file created, \fIname1\fP is the string
+.Fa name1
+.Pf ( Fa name2
+is the name of the
+file created,
+.Fa name1
+is the string

 used in creating the symbolic link).
 Either name may be an arbitrary path name; the files need not
 be on the same file system.
 used in creating the symbolic link).
 Either name may be an arbitrary path name; the files need not
 be on the same file system.

-.SH "RETURN VALUE
+.Sh RETURN VALUES

 Upon successful completion, a zero value is returned.
 Upon successful completion, a zero value is returned.

-If an error occurs, the error code is stored in \fIerrno\fP
-and a \-1 value is returned.
-.SH "ERRORS
-The symbolic link is made unless on or more of the
-following are true:
-.TP 15
-[ENOTDIR]
-A component of the \fIname2\fP prefix is not a directory.
-.TP 15
-[EINVAL]
-Either \fIname1\fP or \fIname2\fP
+If an error occurs, the error code is stored in
+.Va errno
+and a -1 value is returned.
+.Sh ERRORS
+The symbolic link succeeds unless:
+.Bl -tag -width ENAMETOO
+.It Bq Er ENOTDIR
+A component of the
+.Fa name2
+prefix is not a directory.
+.It Bq Er EINVAL
+Either
+.Fa name1
+or
+.Fa name2

 contains a character with the high-order bit set.
 contains a character with the high-order bit set.

-.TP 15
-[ENAMETOOLONG]
+.It Bq Er ENAMETOOLONG

 A component of either pathname exceeded 255 characters,
 or the entire length of either path name exceeded 1023 characters.
 A component of either pathname exceeded 255 characters,
 or the entire length of either path name exceeded 1023 characters.

-.TP 15
-[ENOENT]
+.It Bq Er ENOENT

 The named file does not exist.
 The named file does not exist.

-.TP 15
-[EACCES]
-A component of the \fIname2\fP path prefix denies search permission.
-.TP 15
-[ELOOP]
+.It Bq Er EACCES
+A component of the
+.Fa name2
+path prefix denies search permission.
+.It Bq Er ELOOP

 Too many symbolic links were encountered in translating the pathname.
 Too many symbolic links were encountered in translating the pathname.

-.TP 15
-[EEXIST]
-\fIName2\fP already exists.
-.TP 15
-[EIO]
-An I/O error occurred while making the directory entry for \fIname2\fP,
-or allocating the inode for \fIname2\fP,
-or writing out the link contents of \fIname2\fP.
-.TP 15
-[EROFS]
-The file \fIname2\fP would reside on a read-only file system.
-.TP 15
-[ENOSPC]
+.It Bq Er EEXIST
+.Fa Name2
+already exists.
+.It Bq Er EIO
+An I/O error occurred while making the directory entry for
+.Fa name2 ,
+or allocating the inode for
+.Fa name2 ,
+or writing out the link contents of
+.Fa name2 .
+.It Bq Er EROFS
+The file
+.Fa name2
+would reside on a read-only file system.
+.It Bq Er ENOSPC

 The directory in which the entry for the new symbolic link is being placed
 cannot be extended because there is no space left on the file
 system containing the directory.
 The directory in which the entry for the new symbolic link is being placed
 cannot be extended because there is no space left on the file
 system containing the directory.

-.TP 15
-[ENOSPC]
+.It Bq Er ENOSPC

 The new symbolic link cannot be created because there
 there is no space left on the file
 system that will contain the symbolic link.
 The new symbolic link cannot be created because there
 there is no space left on the file
 system that will contain the symbolic link.

-.TP 15
-[ENOSPC]
+.It Bq Er ENOSPC

 There are no free inodes on the file system on which the
 symbolic link is being created.
 There are no free inodes on the file system on which the
 symbolic link is being created.

-.TP 15
-[EDQUOT]
+.It Bq Er EDQUOT

 The directory in which the entry for the new symbolic link
 is being placed cannot be extended because the
 user's quota of disk blocks on the file system
 containing the directory has been exhausted.
 The directory in which the entry for the new symbolic link
 is being placed cannot be extended because the
 user's quota of disk blocks on the file system
 containing the directory has been exhausted.

-.TP 15
-[EDQUOT]
+.It Bq Er EDQUOT

 The new symbolic link cannot be created because the user's
 quota of disk blocks on the file system that will
 contain the symbolic link has been exhausted.
 The new symbolic link cannot be created because the user's
 quota of disk blocks on the file system that will
 contain the symbolic link has been exhausted.

-.TP 15
-[EDQUOT]
+.It Bq Er EDQUOT

 The user's quota of inodes on the file system on
 which the symbolic link is being created has been exhausted.
 The user's quota of inodes on the file system on
 which the symbolic link is being created has been exhausted.

-.TP 15
-[EIO]
+.It Bq Er EIO

 An I/O error occurred while making the directory entry or allocating the inode.
 An I/O error occurred while making the directory entry or allocating the inode.

-.TP 15
-[EFAULT]
-.I Name1
+.It Bq Er EFAULT
+.Fa Name1

 or
 or

-.I name2
+.Fa name2

 points outside the process's allocated address space.
 points outside the process's allocated address space.

-.SH "SEE ALSO"
-link(2), ln(1), unlink(2)
+.El
+.Sh SEE ALSO
+.Xr link 2 ,
+.Xr ln 1 ,
+.Xr unlink 2
+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.2 .