Expand PMF_FN_* macros.
[netbsd-mini2440.git] / lib / libpam / modules / pam_rootok / pam_rootok.8
blobb7c26f02bb553a05b0cadbf5948bdf26e5cd008d
1 .\" $NetBSD: pam_rootok.8,v 1.2 2004/12/12 08:18:47 christos Exp $
2 .\" Copyright (c) 2001 Mark R V Murray
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 .\" SUCH DAMAGE.
25 .\"
26 .\" $FreeBSD: src/lib/libpam/modules/pam_rootok/pam_rootok.8,v 1.4 2001/08/15 20:05:31 markm Exp $
27 .\"
28 .Dd July 8, 2001
29 .Dt PAM_ROOTOK 8
30 .Os
31 .Sh NAME
32 .Nm pam_rootok
33 .Nd RootOK PAM module
34 .Sh SYNOPSIS
35 .Op Ar service-name
36 .Ar module-type
37 .Ar control-flag
38 .Pa pam_rootok
39 .Op Ar options
40 .Sh DESCRIPTION
41 The RootOK authentication service module for PAM
42 provides functionality for only one PAM category:
43 authentication.
44 In terms of the
45 .Ar module-type
46 parameter, this is the
47 .Dq Li auth
48 feature.
49 It also provides a null function for session management.
50 .Ss RootOK Authentication Module
51 The RootOK authentication component
52 .Pq Fn pam_sm_authenticate ,
53 always returns success for the superuser;
54 i.e.,
56 .Xr getuid 2
57 returns 0.
58 .Pp
59 The following options may be passed to the authentication module:
60 .Bl -tag -width ".Cm no_warn"
61 .It Cm debug
62 .Xr syslog 3
63 debugging information at
64 .Dv LOG_DEBUG
65 level.
66 .It Cm no_warn
67 suppress warning messages to the user.
68 These messages include
69 reasons why the user's
70 authentication attempt was declined.
71 .El
72 .Sh SEE ALSO
73 .Xr getuid 2 ,
74 .Xr pam.conf 5 ,
75 .Xr pam 8