From b6291f03fee621ba0db44e6067d2ab3919920f3e Mon Sep 17 00:00:00 2001
From: Thorsten Kukuk <kukuk@thkukuk.de>
Date: Sun, 25 Jun 2006 20:28:14 +0000
Subject: Relevant BUGIDs:

Purpose of commit: new feature

Commit summary:
---------------

2006-06-25  Thorsten Kukuk  <kukuk@thkukuk.de>

        * doc/man/misc_conv.3.xml: New.
        * doc/man/misc_conv.3: New.
        * doc/man/pam_misc_paste_env.3.xml: New.
        * doc/man/pam_misc_paste_env.3: New.
        * doc/man/pam_misc_drop_env.3.xml: New.
        * doc/man/pam_misc_drop_env.3: New.
        * doc/man/pam_misc_setenv.3.xml: New.
        * doc/man/pam_misc_setenv.3: New.
        * doc/man/Makefile.am: Add new manual pages.
---
 doc/man/pam_misc_setenv.3.xml | 69 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 69 insertions(+)
 create mode 100644 doc/man/pam_misc_setenv.3.xml

(limited to 'doc/man/pam_misc_setenv.3.xml')

diff --git a/doc/man/pam_misc_setenv.3.xml b/doc/man/pam_misc_setenv.3.xml
new file mode 100644
index 00000000..99317859
--- /dev/null
+++ b/doc/man/pam_misc_setenv.3.xml
@@ -0,0 +1,69 @@
+<?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_misc_setenv">
+
+  <refmeta>
+    <refentrytitle>pam_misc_setenv</refentrytitle>
+    <manvolnum>3</manvolnum>
+    <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
+  </refmeta>
+
+  <refnamediv id="pam_misc_setenv-name">
+    <refname>pam_misc_setenv</refname>
+    <refpurpose>BSD like PAM environment variable setting</refpurpose>
+  </refnamediv>
+
+<!-- body begins here -->
+
+  <refsynopsisdiv id="pam_misc_setenv-synopsis">
+    <funcsynopsis>
+      <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 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 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 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>
-- 
cgit v1.2.3