diff options
Diffstat (limited to 'doc/man/pam_misc_drop_env.3.xml')
-rw-r--r-- | doc/man/pam_misc_drop_env.3.xml | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/doc/man/pam_misc_drop_env.3.xml b/doc/man/pam_misc_drop_env.3.xml new file mode 100644 index 0000000..1941f58 --- /dev/null +++ b/doc/man/pam_misc_drop_env.3.xml @@ -0,0 +1,63 @@ +<?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_drop_env"> + + <refmeta> + <refentrytitle>pam_misc_drop_env</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo> + </refmeta> + + <refnamediv id="pam_misc_drop_env-name"> + <refname>pam_misc_drop_env</refname> + <refpurpose>liberating a locally saved environment</refpurpose> + </refnamediv> + +<!-- body begins here --> + + <refsynopsisdiv> + <funcsynopsis id="pam_misc_drop_env-synopsis"> + <funcsynopsisinfo>#include <security/pam_misc.h></funcsynopsisinfo> + <funcprototype> + <funcdef>int <function>pam_misc_drop_env</function></funcdef> + <paramdef>char **<parameter>env</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1 id='pam_misc_drop_env-description'> + <title>DESCRIPTION</title> + <para> + This function is defined to complement the <citerefentry> + <refentrytitle>pam_getenvlist</refentrytitle><manvolnum>3</manvolnum> + </citerefentry> function. It liberates the memory associated + with <parameter>env</parameter>, <emphasis>overwriting</emphasis> + with <emphasis>0</emphasis> all memory before + <function>free()</function>ing it. + </para> + </refsect1> + + <refsect1 id='pam_misc_drop_env-see_also'> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>pam_getenvlist</refentrytitle><manvolnum>3</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> + </para> + </refsect1> + + <refsect1 id='pam_misc_drop_env-standards'> + <title>STANDARDS</title> + <para> + The <function>pam_misc_drop_env</function> function is part of the + <command>libpam_misc</command> Library and not defined in any + standard. + </para> + </refsect1> + +</refentry> |