doc/man/pam_syslog.3.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="pam_syslog">

  <refmeta>
    <refentrytitle>pam_syslog</refentrytitle>
    <manvolnum>3</manvolnum>
    <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
  </refmeta>

  <refnamediv id="pam_syslog-name">
    <refname>pam_syslog</refname>
    <refname>pam_vsyslog</refname>
    <refpurpose>send messages to the system logger</refpurpose>
  </refnamediv>

<!-- body begins here -->

  <refsynopsisdiv id="pam_syslog-synopsis">
    <funcsynopsis>
      <funcsynopsisinfo>#include &lt;syslog.h&gt;</funcsynopsisinfo>
      <funcsynopsisinfo>#include &lt;security/pam_ext.h&gt;</funcsynopsisinfo>
      <funcprototype>
        <funcdef>void <function>pam_syslog</function></funcdef>
        <paramdef>const pam_handle_t *<parameter>pamh</parameter></paramdef>
        <paramdef>int <parameter>priority</parameter></paramdef>
        <paramdef>const char *<parameter>fmt</parameter></paramdef>
        <paramdef><parameter>...</parameter></paramdef>
      </funcprototype>
      <funcprototype>
        <funcdef>void <function>pam_vsyslog</function></funcdef>
        <paramdef>const pam_handle_t *<parameter>pamh</parameter></paramdef>
        <paramdef>int <parameter>priority</parameter></paramdef>
        <paramdef>const char *<parameter>fmt</parameter></paramdef>
        <paramdef>va_list <parameter>args</parameter></paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>

  <refsect1 id='pam_syslog-description'>
    <title>DESCRIPTION</title>
    <para>
      The <function>pam_syslog</function> function logs messages using
      <citerefentry>
        <refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry> and is intended for internal use by Linux-PAM and
      PAM service modules. The <emphasis>priority</emphasis> argument is
      formed by ORing the facility and the level values as documented
      in the <citerefentry>
        <refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry> manual page.
    </para>
    <para>
      The <function>pam_vsyslog</function> function performs the same
      task as <function>pam_syslog()</function> with the difference
      that it takes a set of arguments which have been obtained using
      the <citerefentry>
        <refentrytitle>stdarg</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry> variable argument list macros.
    </para>
  </refsect1>

  <refsect1 id='pam_syslog-see_also'>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>
    </para>
  </refsect1>

  <refsect1 id='pam_syslog-standards'>
    <title>STANDARDS</title>
    <para>
      The <function>pam_syslog</function> and <function>pam_vsyslog</function>
      functions are Linux-PAM extensions.
    </para>
  </refsect1>

</refentry>