xnu-2422.115.4.tar.gz

[apple/xnu.git] / bsd / man / man2 / symlink.2

diff --git a/bsd/man/man2/symlink.2 b/bsd/man/man2/symlink.2
index cee3f9ff6dd9ffada6787bce549e392009add77e..ff2d106de1d404c0b7f1caaca630c902ac1f4721 100644 (file)
--- a/bsd/man/man2/symlink.2
+++ b/bsd/man/man2/symlink.2
@@ -42,16 +42,19 @@
 .Sh SYNOPSIS
 .Fd #include <unistd.h>
 .Ft int
-.Fn symlink "const char *name1" "const char *name2"
+.Fo symlink
+.Fa "const char *path1"
+.Fa "const char *path2"
+.Fc
 .Sh DESCRIPTION
 A symbolic link
-.Fa name2
+.Fa path2
 is created to
-.Fa name1
-.Pf ( Fa name2
+.Fa path1
+.Pf ( Fa path2
 is the name of the
 file created,
-.Fa name1
+.Fa path1
 is the string
 used in creating the symbolic link).
 Either name may be an arbitrary path name; the files need not
@@ -64,74 +67,100 @@ and a -1 value is returned.
 .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 a pathname exceeded 
-.Dv {NAME_MAX}
-characters, or an entire path name exceeded 
-.Dv {PATH_MAX}
-characters.
-.It Bq Er ENOENT
-The named file does not exist.
+.\" ===========
+.It Bq Er EACCES
+Write permission is denied in the directory
+where the symbolic link is being created.
+.\" ===========
 .It Bq Er EACCES
 A component of the
-.Fa name2
+.Fa path2
 path prefix denies search permission.
-.It Bq Er ELOOP
-Too many symbolic links were encountered in translating the pathname.
+.\" ===========
+.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 EEXIST
-.Fa Name2
+.Fa Path2
 already exists.
+.\" ===========
+.It Bq Er EFAULT
+.Fa Path1
+or
+.Fa path2
+points outside the process's allocated address space.
+.\" ===========
+.It Bq Er EIO
+An I/O error occurs while making the directory entry
+or allocating the inode.
+.\" ===========
 .It Bq Er EIO
-An I/O error occurred while making the directory entry for
-.Fa name2 ,
+An I/O error occurs while making the directory entry for
+.Fa path2 ,
 or allocating the inode for
-.Fa name2 ,
+.Fa path2 ,
 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.
+.Fa path2 .
+.\" ===========
+.It Bq Er ELOOP
+Too many symbolic links are encountered in translating the pathname.
+This is taken to be indicative of a looping symbolic link.
+.\" ===========
+.It Bq Er ENAMETOOLONG
+A component of a pathname exceeds 
+.Dv {NAME_MAX}
+characters, or an entire path name exceeds
+.Dv {PATH_MAX}
+characters.
+.\" ===========
+.It Bq Er ENOENT
+A component of
+.Fa path2
+does not name an existing file or
+.Fa path2
+is an empty string.
+.\" ===========
 .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
 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
-.Fa Name1
-or
-.Fa name2
-points outside the process's allocated address space.
+.\" ===========
+.It Bq Er ENOTDIR
+A component of the
+.Fa path2
+prefix is not a directory.
+.\" ===========
+.It Bq Er EROFS
+The file
+.Fa path2
+would reside on a read-only file system.
 .El
 .Sh SEE ALSO
 .Xr ln 1 ,
 .Xr link 2 ,
-.Xr unlink 2
-.Xr symlink 7 ,
+.Xr unlink 2 ,
+.Xr symlink 7
 .Sh HISTORY
 The
 .Fn symlink