contrib/openpam/doc/man/openpam_log.3

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