diff options
Diffstat (limited to 'share/man/man9/VOP_ACCESS.9')
-rw-r--r-- | share/man/man9/VOP_ACCESS.9 | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/share/man/man9/VOP_ACCESS.9 b/share/man/man9/VOP_ACCESS.9 new file mode 100644 index 000000000000..76073db597a5 --- /dev/null +++ b/share/man/man9/VOP_ACCESS.9 @@ -0,0 +1,85 @@ +.\" -*- nroff -*- +.\" -*- nroff -*- +.\" +.\" Copyright (c) 1996 Doug Rabson +.\" +.\" All rights reserved. +.\" +.\" This program is free software. +.\" +.\" 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. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``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 DEVELOPERS 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. +.\" +.\" $FreeBSD$ +.\" +.Dd July 24, 1996 +.Os +.Dt VOP_ACCESS 9 +.Sh NAME +.Nm VOP_ACCESS +.Nd "check access permissions of a file or Unix domain socket" +.Sh SYNOPSIS +.In sys/param.h +.In sys/vnode.h +.Ft int +.Fn VOP_ACCESS "struct vnode *vp" "accmode_t accmode" "struct ucred *cred" "struct thread *td" +.Sh DESCRIPTION +This entry point checks the access permissions of the file against the +given credentials. +.Pp +Its arguments are: +.Bl -tag -width accmode +.It Fa vp +The vnode of the file to check. +.It Fa accmode +The type of access required. +.It Fa cred +The user credentials to check. +.It Fa td +The thread which is checking. +.El +.Pp +The +.Fa accmode +is a mask which can contain flags described in <sys/vnode.h>, e.g. +.Dv VREAD , +.Dv VWRITE +or +.Dv VEXEC . +.Sh LOCKS +The vnode will be locked on entry and should remain locked on return. +.Sh RETURN VALUES +If the file is accessible in the specified way, then zero is returned, +otherwise an appropriate error code is returned. +.Sh ERRORS +.Bl -tag -width Er +.It Bq Er EPERM +An attempt was made to change an immutable file. +.It Bq Er EACCES +The permission bits the file mode or the ACL do not permit the +requested access. +.El +.Sh SEE ALSO +.Xr vaccess 9 , +.Xr vaccess_acl_posix1e 9 , +.Xr vnode 9 +.Sh AUTHORS +This manual page was written by +.An Doug Rabson . |