xref: /netbsd-src/external/bsd/openpam/dist/doc/man/openpam_log.3 (revision 946379e7b37692fc43f68eb0d1c10daa0a7f3b6c)
1.\"	$NetBSD: openpam_log.3,v 1.6 2014/10/24 18:25:14 christos Exp $
2.\"
3.\" Generated from openpam_log.c by gendoc.pl
4.\" Id: openpam_log.c 686 2013-07-11 16:36:02Z des
5.Dd September 12, 2014
6.Dt OPENPAM_LOG 3
7.Os
8.Sh NAME
9.Nm openpam_log
10.Nd log a message through syslog
11.Sh LIBRARY
12.Lb libpam
13.Sh SYNOPSIS
14.In sys/types.h
15.In security/pam_appl.h
16.In security/openpam.h
17.Ft "void"
18.Fn openpam_log "int level" "const char *fmt" "..."
19.Sh DESCRIPTION
20The
21.Fn openpam_log
22function logs messages using
23.Xr syslog 3 .
24It is primarily intended for internal use by the library and modules.
25.Pp
26The
27.Fa level
28argument indicates the importance of the message.
29The following levels are defined:
30.Bl -tag -width 18n
31.It Dv PAM_LOG_LIBDEBUG
32Debugging messages.
33For internal use only.
34.It Dv PAM_LOG_DEBUG
35Debugging messages.
36These messages are normally not logged unless the global
37integer variable
38.Va openpam_debug
39is set to a non-zero
40value, in which case they are logged with a
41.Xr syslog 3
42priority of
43.Dv LOG_DEBUG .
44.It Dv PAM_LOG_VERBOSE
45Information about the progress of the authentication
46process, or other non-essential messages.
47These messages are logged with a
48.Xr syslog 3
49priority of
50.Dv LOG_INFO .
51.It Dv PAM_LOG_NOTICE
52Messages relating to non-fatal errors.
53These messages are logged with a
54.Xr syslog 3
55priority of
56.Dv LOG_NOTICE .
57.It Dv PAM_LOG_ERROR
58Messages relating to serious errors.
59These messages are logged with a
60.Xr syslog 3
61priority of
62.Dv LOG_ERR .
63.El
64.Pp
65The remaining arguments are a
66.Xr printf 3
67format string and the
68corresponding arguments.
69.Pp
70The
71.Fn openpam_log
72function does not modify the value of
73.Va errno .
74.Sh SEE ALSO
75.Xr pam 3 ,
76.Xr printf 3 ,
77.Xr syslog 3
78.Sh STANDARDS
79The
80.Fn openpam_log
81function is an OpenPAM extension.
82.Sh AUTHORS
83The
84.Fn openpam_log
85function and this manual page were
86developed for the
87.Fx
88Project by ThinkSec AS and Network Associates Laboratories, the
89Security Research Division of Network Associates, Inc.\& under
90DARPA/SPAWAR contract N66001-01-C-8035
91.Pq Dq CBOSS ,
92as part of the DARPA CHATS research program.
93.Pp
94The OpenPAM library is maintained by
95.An Dag-Erling Sm\(/orgrav Aq des@des.no .
96