Document for driver authors.

This commit is contained in:
gmcgarry 2002-06-24 22:45:41 +00:00
parent 37f335b28b
commit 4f8707c5a1
2 changed files with 68 additions and 2 deletions

View File

@ -1,4 +1,4 @@
# $NetBSD: Makefile,v 1.111 2002/05/31 11:11:29 kleink Exp $
# $NetBSD: Makefile,v 1.112 2002/06/24 22:45:41 gmcgarry Exp $
# Makefile for section 9 (kernel function and variable) manual pages.
@ -24,7 +24,7 @@ MAN= access.9 altq.9 arc4random.9 arp.9 audio.9 autoconf.9 \
psignal.9 radio.9 rasops.9 ratecheck.9 resettodr.9 rnd.9 rt_timer.9 \
scsipi.9 setjmp.9 setrunqueue.9 shutdownhook_establish.9 \
sleep.9 softintr.9 \
spl.9 store.9 tc.9 time.9 todr.9 uiomove.9 ucom.9 \
spl.9 store.9 suser.9 tc.9 time.9 todr.9 uiomove.9 ucom.9 \
vattr.9 vfs.9 vfsops.9 vme.9 vnode.9 vnodeops.9 vnsubr.9 \
usbdi.9 uvm.9 wdc.9 wscons.9 wsdisplay.9 wsfont.9 wskbd.9 wsmouse.9

66
share/man/man9/suser.9 Normal file
View File

@ -0,0 +1,66 @@
.\" $NetBSD: suser.9,v 1.1 2002/06/24 22:45:41 gmcgarry Exp $
.\"
.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Gregory McGarry.
.\"
.\" 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.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the NetBSD
.\" Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\" contributors may be used to endorse or promote products derived
.\" from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``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 FOUNDATION OR CONTRIBUTORS
.\" 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.
.\"
.Dd June 25, 2002
.Dt SUSER 9
.Os
.Sh NAME
.Nm suser
.Nd test for super-user credentials
.Sh SYNOPSIS
.Fd #include \*[Lt]sys/ucred.h\*[Gt]
.Fd #include \*[Lt]sys/acct.h\*[Gt]
.Ft int
.Fn suser "struct ucred *cred" "u_short *acflag"
.Sh DESCRIPTION
.Fn suser
tests whether the specified credentials
.Fa cred
imply super-user privilege. The argument
.Fa acflag ,
if non-NULL, is a pointer to the
.Em ac_flag
in the accounting structure. If super-user privilege is implied by
the credentials, and
.Fa acflag
is not NULL,
the ASU flags is set in
.Fa acflag
to indicate the use of super-powers.
.Pp
.Fn suser
returns zero on success, or EPERM if super-user privilege is
not implied by the credentials.