granicus.if.org Git - linux-pam/blob - doc/man/pam_syslog.3.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
   4
   5 <refentry id="pam_syslog">
   6
   7   <refmeta>
   8     <refentrytitle>pam_syslog</refentrytitle>
   9     <manvolnum>3</manvolnum>
  10     <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
  11   </refmeta>
  12
  13   <refnamediv id="pam_syslog-name">
  14     <refname>pam_syslog</refname>
  15     <refname>pam_vsyslog</refname>
  16     <refpurpose>send messages to the system logger</refpurpose>
  17   </refnamediv>
  18
  19 <!-- body begins here -->
  20
  21   <refsynopsisdiv id="pam_syslog-synopsis">
  22     <funcsynopsis>
  23       <funcsynopsisinfo>#include &lt;syslog.h&gt;</funcsynopsisinfo>
  24       <funcsynopsisinfo>#include &lt;security/pam_ext.h&gt;</funcsynopsisinfo>
  25       <funcprototype>
  26         <funcdef>void <function>pam_syslog</function></funcdef>
  27         <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
  28         <paramdef>int <parameter>priority</parameter></paramdef>
  29         <paramdef>const char *<parameter>fmt</parameter></paramdef>
  30         <paramdef><parameter>...</parameter></paramdef>
  31       </funcprototype>
  32       <funcprototype>
  33         <funcdef>void <function>pam_vsyslog</function></funcdef>
  34         <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
  35         <paramdef>int <parameter>priority</parameter></paramdef>
  36         <paramdef>const char *<parameter>fmt</parameter></paramdef>
  37         <paramdef>va_list <parameter>args</parameter></paramdef>
  38       </funcprototype>
  39     </funcsynopsis>
  40   </refsynopsisdiv>
  41
  42   <refsect1 id='pam_syslog-description'>
  43     <title>DESCRIPTION</title>
  44     <para>
  45       The <function>pam_syslog</function> function logs messages using
  46       <citerefentry>
  47         <refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum>
  48       </citerefentry> and is intended for internal use by Linux-PAM and
  49       PAM service modules. The <emphasis>priority</emphasis> argument is
  50       formed by ORing the facility and the level values as documented
  51       in the <citerefentry>
  52         <refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum>
  53       </citerefentry> manual page.
  54     </para>
  55     <para>
  56       The <function>pam_vsyslog</function> function performs the same
  57       task as <function>pam_syslog()</function> with the difference
  58       that it takes a set of arguments which have been obtained using
  59       the <citerefentry>
  60         <refentrytitle>stdarg</refentrytitle><manvolnum>3</manvolnum>
  61       </citerefentry> variable argument list macros.
  62     </para>
  63   </refsect1>
  64
  65   <refsect1 id='pam_syslog-see_also'>
  66     <title>SEE ALSO</title>
  67     <para>
  68       <citerefentry>
  69         <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
  70       </citerefentry>
  71     </para>
  72   </refsect1>
  73
  74   <refsect1 id='pam_syslog-standards'>
  75     <title>STANDARDS</title>
  76     <para>
  77       The <function>pam_syslog</function> and <function>pam_vsyslog</function>
  78       functions are Linux-PAM extensions.
  79     </para>
  80   </refsect1>
  81
  82 </refentry>