freebsd-nq/lib/libc/sys/symlink.2

.\" Copyright (c) 1983, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" 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.
.\"
.\" 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.
.\"
.\"     @(#)symlink.2	8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
.Dd June 4, 1993
.Dt SYMLINK 2
.Os
.Sh NAME
.Nm symlink
.Nd make symbolic link to a file
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In unistd.h
.Ft int
.Fn symlink "const char *name1" "const char *name2"
.Sh DESCRIPTION
A symbolic link
.Fa name2
is created to
.Fa name1
.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.
.Sh RETURN VALUES
.Rv -std symlink
.Sh ERRORS
The symbolic link succeeds unless:
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the
.Fa name2
prefix is not a directory.
.It Bq Er ENAMETOOLONG
A component of either pathname exceeded 255 characters,
or the entire length of either path name exceeded 1023 characters.
.It Bq Er ENOENT
The named file does not exist.
.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.
.It Bq Er EEXIST
The path name pointed at by the
.Fa name2
argument
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.
.It Bq Er ENOSPC
The new symbolic link cannot be created because
there is no space left on the file
system that will contain the symbolic link.
.It Bq Er ENOSPC
There are no free inodes on the file system on which the
symbolic link is being created.
.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.
.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.
.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.
.It Bq Er EIO
An I/O error occurred while making the directory entry or allocating the inode.
.It Bq Er EFAULT
The
.Fa name1
or
.Fa name2
argument
points outside the process's allocated address space.
.El
.Sh SEE ALSO
.Xr ln 1 ,
.Xr link 2 ,
.Xr lstat 2 ,
.Xr readlink 2 ,
.Xr unlink 2 ,
.Xr symlink 7
.Sh HISTORY
The
.Fn symlink
system call appeared in
.Bx 4.2 .
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" Copyright (c) 1983, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" 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.`
			`.\"`
			.\" 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.`
			`.\"`
			`.\" @(#)symlink.2 8.1 (Berkeley) 6/4/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
			`.Dd June 4, 1993`
			`.Dt SYMLINK 2`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 13:41:46 +00:00			`.Os`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh NAME`
			`.Nm symlink`
			`.Nd make symbolic link to a file`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In unistd.h`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft int`
			`.Fn symlink "const char name1" "const char name2"`
			`.Sh DESCRIPTION`
			`A symbolic link`
			`.Fa name2`
			`is created to`
			`.Fa name1`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`.Fa ( name2`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`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.`
			`.Sh RETURN VALUES`
Use the ``.Rv -std'' mdoc(7) macro in appropriate cases. Reviewed by: ru 2001-08-09 13:32:13 +00:00			`.Rv -std symlink`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh ERRORS`
			`The symbolic link succeeds unless:`
Use `Er' variable to define first column width in ERRORS section. It was initially suggested by mdoc(7) style, but was broken over the years 2000-05-04 13:09:25 +00:00			`.Bl -tag -width Er`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.It Bq Er ENOTDIR`
			`A component of the`
			`.Fa name2`
			`prefix is not a directory.`
			`.It Bq Er ENAMETOOLONG`
			`A component of either pathname exceeded 255 characters,`
			`or the entire length of either path name exceeded 1023 characters.`
			`.It Bq Er ENOENT`
			`The named file does not exist.`
			`.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.`
			`.It Bq Er EEXIST`
mdoc(7) police: "The .Fa argument.". 2002-12-19 09:40:28 +00:00			`The path name pointed at by the`
			`.Fa name2`
			`argument`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`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.`
			`.It Bq Er ENOSPC`
Removed occurrences of consecutive repeated words (such as "the the"). 1999-02-12 02:12:08 +00:00			`The new symbolic link cannot be created because`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`there is no space left on the file`
			`system that will contain the symbolic link.`
			`.It Bq Er ENOSPC`
			`There are no free inodes on the file system on which the`
			`symbolic link is being created.`
			`.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.`
			`.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.`
			`.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.`
			`.It Bq Er EIO`
			`An I/O error occurred while making the directory entry or allocating the inode.`
			`.It Bq Er EFAULT`
mdoc(7) police: "The .Fa argument.". 2002-12-19 09:40:28 +00:00			`The`
			`.Fa name1`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`or`
			`.Fa name2`
mdoc(7) police: "The .Fa argument.". 2002-12-19 09:40:28 +00:00			`argument`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`points outside the process's allocated address space.`
			`.El`
			`.Sh SEE ALSO`
			`.Xr ln 1 ,`
add references lstat(2), readlink(2), symlink(7) in section SEE ALSO 1996-07-07 12:52:51 +00:00			`.Xr link 2 ,`
			`.Xr lstat 2 ,`
			`.Xr readlink 2 ,`
Sort cross references. 1997-01-20 23:23:22 +00:00			`.Xr unlink 2 ,`
			`.Xr symlink 7`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh HISTORY`
			`The`
Correctly use .Fn instead of .Nm to reference function names in a bunch of man pages. Use the correct .Bx (BSD UNIX) or .At (AT&T UNIX) macros instead of explicitly specifying the version in the text in a bunch of man pages. 1996-08-22 23:31:07 +00:00			`.Fn symlink`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call appeared in`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Bx 4.2 .`