X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/9bccf70c0258c7cac2dcb80011b2a964d884c552..935ed37a5c468c8a1c07408573c08b8b7ef80e8b:/bsd/man/man2/access.2 diff --git a/bsd/man/man2/access.2 b/bsd/man/man2/access.2 index 0d168d3c8..d1114f5e9 100644 --- a/bsd/man/man2/access.2 +++ b/bsd/man/man2/access.2 @@ -42,7 +42,10 @@ .Sh SYNOPSIS .Fd #include .Ft int -.Fn access "const char *path" "int mode" +.Fo access +.Fa "const char *path" +.Fa "int amode" +.Fc .Sh DESCRIPTION The .Fn access @@ -50,9 +53,9 @@ function checks the accessibility of the file named by .Fa path for the access permissions indicated by -.Fa mode . +.Fa amode . The value of -.Fa mode +.Fa amode is the bitwise inclusive OR of the access permissions to be checked .Pf ( Dv R_OK @@ -82,46 +85,60 @@ and .Sh RETURN VALUES If .Fa path -cannot be found or if any of the desired access modes would -not be granted, then a -1 value is returned; otherwise -a 0 value is returned. +cannot be found +or if any of the desired access modes would not be granted, +then a -1 value is returned and the global integer variable +.Va errno +is set to indicate the error. +Otherwise, a 0 value is returned. .Sh ERRORS Access to the file is denied if: .Bl -tag -width Er -.It Bq Er ENOTDIR -A component of the path prefix is not a directory. +.\" ========== +.It Bq Er EACCES +Permission bits of the file mode do not permit the requested access, +or search permission is denied on a component of the path prefix. +.Pp +The owner of a file has permission checked +with respect to the ``owner'' read, write, and execute mode bits, +members of the file's group other than the owner have permission checked +with respect to the ``group'' mode bits, +and all others have permissions checked +with respect to the ``other'' mode bits. +.\" +.\" ========== +.It Bq Er EFAULT +.Fa Path +points outside the process's allocated address space. +.It Bq Er EINVAL +An invalid value was specified for +.Ar amode . +.\" ========== +.It Bq Er EIO +An I/O error occurred while reading from or writing to the file system. +.\" ========== +.It Bq Er ELOOP +Too many symbolic links were encountered in translating the pathname. +.\" ========== .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 ELOOP -Too many symbolic links were encountered in translating the pathname. +.\" ========== +.It Bq Er ENOTDIR +A component of the path prefix is not a directory. +.\" ========== .It Bq Er EROFS Write access is requested for a file on a read-only file system. +.\" ========== .It Bq Er ETXTBSY Write access is requested for a pure procedure (shared text) -file presently being executed. -.It Bq Er EACCES -Permission bits of the file mode do not permit the requested -access, or search permission is denied on a component of the -path prefix. The owner of a file has permission checked with -respect to the ``owner'' read, write, and execute mode bits, -members of the file's group other than the owner have permission -checked with respect to the ``group'' mode bits, and all -others have permissions checked with respect to the ``other'' -mode bits. -.It Bq Er EFAULT -.Fa Path -points outside the process's allocated address space. -.It Bq Er EIO -An I/O error occurred while reading from or writing to the file system. -.It Bq Er EINVAL -An invalid value was specified for -.Ar mode . +file that is presently being executed. .El .Sh SEE ALSO .Xr chmod 2 ,