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

doc/man/pam_misc_setenv.3.xml
65 строк2 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_misc_setenv">

  <refmeta>
    <refentrytitle>pam_misc_setenv</refentrytitle>
    <manvolnum>3</manvolnum>
    <refmiscinfo class="source">Linux-PAM</refmiscinfo>
    <refmiscinfo class="manual">Linux-PAM Manual</refmiscinfo>
  </refmeta>
  <refnamediv xml:id="pam_misc_setenv-name">
    <refname>pam_misc_setenv</refname>
    <refpurpose>BSD like PAM environment variable setting</refpurpose>
  </refnamediv>

<!-- body begins here -->

  <refsynopsisdiv>
    <funcsynopsis xml:id="pam_misc_setenv-synopsis">
      <funcsynopsisinfo>#include &lt;security/pam_misc.h&gt;</funcsynopsisinfo>
      <funcprototype>
        <funcdef>int <function>pam_misc_setenv</function></funcdef>
        <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
        <paramdef>const char *<parameter>name</parameter></paramdef>
        <paramdef>const char *<parameter>value</parameter></paramdef>
        <paramdef>int <parameter>readonly</parameter></paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>

  <refsect1 xml:id="pam_misc_setenv-description">
    <title>DESCRIPTION</title>
    <para>
      This function performs a task equivalent to <citerefentry>
      <refentrytitle>pam_putenv</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry>, its syntax is, however, more like the BSD style
      function; <function>setenv()</function>. The <parameter>name</parameter>
      and <parameter>value</parameter> are concatenated with an '=' to
      form a name=value and passed to <function>pam_putenv()</function>.
      If, however, the PAM variable is already set, the replacement will
      only be applied if the last argument, <parameter>readonly</parameter>,
      is zero.
    </para>
  </refsect1>

  <refsect1 xml:id="pam_misc_setenv-see_also">
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>pam_putenv</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>
    </para>
  </refsect1>

  <refsect1 xml:id="pam_misc_setenv-standards">
    <title>STANDARDS</title>
    <para>
      The <function>pam_misc_setenv</function> function is part of the
      <command>libpam_misc</command> Library and not defined in any
      standard.
    </para>
  </refsect1>

</refentry>