xnu-1228.7.58.tar.gz

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

diff --git a/bsd/man/man2/link.2 b/bsd/man/man2/link.2
index 2a6f8b66c88730c10e33c1c950a932bea8bbe4a2..6392e7ceacabd8aa64eb1409a5a28a550ddea1b9 100644 (file)
--- a/bsd/man/man2/link.2
+++ b/bsd/man/man2/link.2
@@ -42,42 +42,44 @@
 .Sh SYNOPSIS
 .Fd #include <unistd.h>
 .Ft int
 .Sh SYNOPSIS
 .Fd #include <unistd.h>
 .Ft int

-.Fn link "const char *name1" "const char *name2"
+.Fo link
+.Fa "const char *path1"
+.Fa "const char *path2"
+.Fc

 .Sh DESCRIPTION
 The
 .Fn link
 function call
 atomically creates the specified directory entry (hard link)
 .Sh DESCRIPTION
 The
 .Fn link
 function call
 atomically creates the specified directory entry (hard link)

-.Fa name2
+.Fa path2

 with the attributes of the underlying object pointed at by
 with the attributes of the underlying object pointed at by

-.Fa name1
-If the link is successful: the link count of the underlying object
-is incremented;
-.Fa name1
+.Fa path1 .
+If the link is successful,
+the link count of the underlying object is incremented;
+.Fa path1

 and
 and

-.Fa name2
+.Fa path2

 share equal access and rights
 to the
 underlying object.
 .Pp
 If
 share equal access and rights
 to the
 underlying object.
 .Pp
 If

-.Fa name1
+.Fa path1

 is removed, the file
 is removed, the file

-.Fa name2
+.Fa path2

 is not deleted and the link count of the
 underlying object is
 decremented.
 .Pp
 is not deleted and the link count of the
 underlying object is
 decremented.
 .Pp

-.Fa Name1
-must exist for the hard link to
-succeed and
-both
-.Fa name1
+In order for the system call to succeed,
+.Fa path1
+must exist and both
+.Fa path1

 and
 and

-.Fa name2
+.Fa path2

 must be in the same file system.
 must be in the same file system.

-As mandated by POSIX.1
-.Fa name1
+As mandated by POSIX.1,
+.Fa path1

 may not be a directory.
 .Sh RETURN VALUES
 Upon successful completion, a value of 0 is returned.  Otherwise,
 may not be a directory.
 .Sh RETURN VALUES
 Upon successful completion, a value of 0 is returned.  Otherwise,


@@ -88,60 +90,81 @@ is set to indicate the error.
 .Fn Link
 will fail and no link will be created if:
 .Bl -tag -width Er
 .Fn Link
 will fail and no link will be created if:
 .Bl -tag -width Er

-.It Bq Er ENOTDIR
-A component of either path prefix is not a directory.
+.\" ==========
+.It Bq Er EACCES
+A component of either path prefix denies search permission.
+.\" ==========
+.It Bq Er EACCES
+The requested link requires writing in a directory with a mode
+that denies write permission.
+.\" ==========
+.It Bq Er EACCES
+The current process cannot access the existing file.
+.\" ==========
+.It Bq Er EDQUOT
+The directory in which the entry for the new 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 EEXIST
+The link named by
+.Fa path2
+already exists.
+.\" ==========
+.It Bq Er EFAULT
+One of the pathnames specified
+is outside the process's allocated address space.
+.\" ==========
+.It Bq Er EIO
+An I/O error occurs while reading from or writing to 
+the file system to make the directory entry.
+.\" ==========
+.It Bq Er ELOOP
+Too many symbolic links are encountered in translating one of the pathnames.
+This is taken to be indicative of a looping symbolic link.
+.\" ==========
+.It Bq Er EMLINK
+The file already has {LINK_MAX} links.
+.\" ==========

 .It Bq Er ENAMETOOLONG
 .It Bq Er ENAMETOOLONG

-A component of a pathname exceeded 
+A component of a pathname exceeds 

 .Dv {NAME_MAX}
 characters, or an entire path name exceeded 
 .Dv {PATH_MAX}
 characters.
 .Dv {NAME_MAX}
 characters, or an entire path name exceeded 
 .Dv {PATH_MAX}
 characters.

+.\" ==========

 .It Bq Er ENOENT
 A component of either path prefix does not exist.
 .It Bq Er ENOENT
 A component of either path prefix does not exist.

-.It Bq Er EACCES
-A component of either path prefix denies search permission.
-.It Bq Er EACCES
-The requested link requires writing in a directory with a mode
-that denies write permission.
-.It Bq Er ELOOP
-Too many symbolic links were encountered in translating one of the pathnames.
+.\" ==========

 .It Bq Er ENOENT
 The file named by
 .It Bq Er ENOENT
 The file named by

-.Fa name1
+.Fa path1

 does not exist.
 does not exist.

-.It Bq Er EEXIST
-The link named by
-.Fa name2
-does exist.
+.\" ==========
+.It Bq Er ENOSPC
+The directory in which the entry for the new link is being placed
+cannot be extended because there is no space left on the file
+system containing the directory.
+.\" ==========
+.It Bq Er ENOTDIR
+A component of either path prefix is not a directory.
+.\" ==========

 .It Bq Er EPERM
 The file named by
 .It Bq Er EPERM
 The file named by

-.Fa name1
+.Fa path1

 is a directory.
 is a directory.

+.\" ==========
+.It Bq Er EROFS
+The requested link requires writing in a directory
+on a read-only file system.
+.\" ==========

 .It Bq Er EXDEV
 The link named by
 .It Bq Er EXDEV
 The link named by

-.Fa name2
+.Fa path2

 and the file named by
 and the file named by

-.Fa name1
+.Fa path1

 are on different file systems.
 are on different file systems.

-.It Bq Er ENOSPC
-The directory in which the entry for the new link is being placed
-cannot be extended because there is no space left on the file
-system containing the directory.
-.ne 3v
-.It Bq Er EDQUOT
-The directory in which the entry for the new 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 EIO
-An I/O error occurred while reading from or writing to 
-the file system to make the directory entry.
-.It Bq Er EROFS
-The requested link requires writing in a directory on a read-only file
-system.
-.It Bq Er EFAULT
-One of the pathnames specified
-is outside the process's allocated address space.

 .El
 .Sh SEE ALSO
 .Xr symlink 2 ,
 .El
 .Sh SEE ALSO
 .Xr symlink 2 ,