]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/man/man2/unlink.2
xnu-1228.9.59.tar.gz
[apple/xnu.git] / bsd / man / man2 / unlink.2
index 6dfd46035f196f3c075dc0d98c0485e340f3ded5..3418f53fa6f2c872f4a7c9988241d7ec2791c6cf 100644 (file)
@@ -42,7 +42,9 @@
 .Sh SYNOPSIS
 .Fd #include <unistd.h>
 .Ft int
-.Fn unlink "const char *path"
+.Fo unlink
+.Fa "const char *path"
+.Fc
 .Sh DESCRIPTION
 The
 .Fn unlink
@@ -66,48 +68,67 @@ is set to indicate the error.
 .Sh ERRORS
 The
 .Fn unlink
-succeeds unless:
+system call will fail if:
 .Bl -tag -width Er
-.It Bq Er ENOTDIR
-A component of the path 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
 Search permission is denied for a component of the path prefix.
+.\" ===========
 .It Bq Er EACCES
 Write permission is denied on the directory containing the link
 to be removed.
+.\" ===========
+.It Bq Er EBUSY
+The entry to be unlinked is the mount point for a
+mounted file system.
+.\" ===========
+.It Bq Er EBUSY
+The file named by the
+.Fa path
+argument cannot be unlinked
+because it is being used by the system or by another process.
+.\" ===========
+.It Bq Er EFAULT
+.Fa Path
+points outside the process's allocated address space.
+.\" ===========
+.It Bq Er EIO
+An I/O error occurs while deleting the directory entry
+or deallocating the inode.
+.\" ===========
 .It Bq Er ELOOP
-Too many symbolic links were encountered in translating the pathname.
+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 (possibly as a result of expanding a symlink).
+.\" ===========
+.It Bq Er ENOENT
+The named file does not exist.
+.\" ===========
+.It Bq Er ENOTDIR
+A component of the path prefix is not a directory.
+.\" ===========
 .It Bq Er EPERM
 The named file is a directory and the effective user ID
 of the process is not the super-user.
+.\" ===========
 .It Bq Er EPERM
 The directory containing the file is marked sticky,
 and neither the containing directory nor the file to be removed
 are owned by the effective user ID.
-.It Bq Er EBUSY
-The entry to be unlinked is the mount point for a
-mounted file system.
-.It Bq Er EIO
-An I/O error occurred while deleting the directory entry
-or deallocating the inode.
+.\" ===========
 .It Bq Er EROFS
 The named file resides on a read-only file system.
-.It Bq Er EFAULT
-.Fa Path
-points outside the process's allocated address space.
 .El
 .Sh SEE ALSO
 .Xr close 2 ,
 .Xr link 2 ,
-.Xr rmdir 2
+.Xr rmdir 2 ,
 .Xr symlink 7
 .Sh HISTORY
 An