granicus.if.org Git - linux-pam/blob - doc/man/pam_misc_setenv.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_misc_setenv">
   6
   7   <refmeta>
   8     <refentrytitle>pam_misc_setenv</refentrytitle>
   9     <manvolnum>3</manvolnum>
  10     <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
  11   </refmeta>
  12   <refnamediv id="pam_misc_setenv-name">
  13     <refname>pam_misc_setenv</refname>
  14     <refpurpose>BSD like PAM environment variable setting</refpurpose>
  15   </refnamediv>
  16
  17 <!-- body begins here -->
  18
  19   <refsynopsisdiv>
  20     <funcsynopsis id="pam_misc_setenv-synopsis">
  21       <funcsynopsisinfo>#include &lt;security/pam_misc.h&gt;</funcsynopsisinfo>
  22       <funcprototype>
  23         <funcdef>int <function>pam_misc_setenv</function></funcdef>
  24         <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
  25         <paramdef>const char *<parameter>name</parameter></paramdef>
  26         <paramdef>const char *<parameter>value</parameter></paramdef>
  27         <paramdef>int<parameter>readonly</parameter></paramdef>
  28       </funcprototype>
  29     </funcsynopsis>
  30   </refsynopsisdiv>
  31
  32   <refsect1 id='pam_misc_setenv-description'>
  33     <title>DESCRIPTION</title>
  34     <para>
  35       This function performs a task equivalent to <citerefentry>
  36       <refentrytitle>pam_putenv</refentrytitle><manvolnum>3</manvolnum>
  37       </citerefentry>, its syntax is, however, more like the BSD style
  38       function; <function>setenv()</function>. The <parameter>name</parameter>
  39       and <parameter>value</parameter> are concatenated with an '=' to
  40       form a name=value and passed to <function>pam_putenv()</function>.
  41       If, however, the PAM variable is already set, the replacement will
  42       only be applied if the last argument, <parameter>readonly</parameter>,
  43       is zero.
  44     </para>
  45   </refsect1>
  46
  47   <refsect1 id='pam_misc_setenv-see_also'>
  48     <title>SEE ALSO</title>
  49     <para>
  50       <citerefentry>
  51         <refentrytitle>pam_putenv</refentrytitle><manvolnum>3</manvolnum>
  52       </citerefentry>,
  53       <citerefentry>
  54         <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
  55       </citerefentry>
  56     </para>
  57   </refsect1>
  58
  59   <refsect1 id='pam_misc_setenv-standards'>
  60     <title>STANDARDS</title>
  61     <para>
  62       The <function>pam_misc_setenv</function> function is part of the
  63       <command>libpam_misc</command> Library and not defined in any
  64       standard.
  65     </para>
  66   </refsect1>
  67
  68 </refentry>