doc/man/pam_syslog.3.xml - master - githubmirror/linux-pam

doc/man/pam_syslog.3.xml
79 строк3 KB
Stefan Schubert
doc: Update PAM documentation from DockBook 4 to DocBook 5
16 дек 2022, 12:31
16 дек 2022, 12:31cf2fc5f
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="pam_syslog">

  <refmeta>
    <refentrytitle>pam_syslog</refentrytitle>
    <manvolnum>3</manvolnum>
    <refmiscinfo class="source">Linux-PAM</refmiscinfo>
    <refmiscinfo class="manual">Linux-PAM Manual</refmiscinfo>
  </refmeta>

  <refnamediv xml: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 xml: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 xml: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 xml:id="pam_syslog-see_also">
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>
    </para>
  </refsect1>

  <refsect1 xml: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>