summaryrefslogtreecommitdiff
path: root/doc/man/pam_close_session.3.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/pam_close_session.3.xml')
-rw-r--r--doc/man/pam_close_session.3.xml115
1 files changed, 0 insertions, 115 deletions
diff --git a/doc/man/pam_close_session.3.xml b/doc/man/pam_close_session.3.xml
deleted file mode 100644
index db549bda..00000000
--- a/doc/man/pam_close_session.3.xml
+++ /dev/null
@@ -1,115 +0,0 @@
-<?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_send'>
-
- <refmeta>
- <refentrytitle>pam_close_session</refentrytitle>
- <manvolnum>3</manvolnum>
- <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
- </refmeta>
-
- <refnamediv id="pam_close_session-name">
- <refname>pam_close_session</refname>
- <refpurpose>terminate PAM session management</refpurpose>
- </refnamediv>
-
-<!-- body begins here -->
-
- <refsynopsisdiv>
- <funcsynopsis id="pam_close_session-synopsis">
- <funcsynopsisinfo>#include &lt;security/pam_appl.h&gt;</funcsynopsisinfo>
- <funcprototype>
- <funcdef>int <function>pam_close_session</function></funcdef>
- <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
- <paramdef>int <parameter>flags</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- </refsynopsisdiv>
-
-
- <refsect1 id="pam_close_session-description">
- <title>DESCRIPTION</title>
- <para>
- The <function>pam_close_session</function> function is used
- to indicate that an authenticated session has ended.
- The session should have been created with a call to
- <citerefentry>
- <refentrytitle>pam_open_session</refentrytitle><manvolnum>3</manvolnum>
- </citerefentry>.
- </para>
- <para>
- It should be noted that the effective uid,
- <citerefentry>
- <refentrytitle>geteuid</refentrytitle><manvolnum>2</manvolnum>
- </citerefentry>. of the application should be of sufficient
- privilege to perform such tasks as unmounting the
- user's home directory for example.
- </para>
- <para>
- The flags argument is the binary or of zero or more of the
- following values:
- </para>
- <variablelist>
- <varlistentry>
- <term>PAM_SILENT</term>
- <listitem>
- <para>
- Do not emit any messages.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
-
- <refsect1 id="pam_close_session-return_values">
- <title>RETURN VALUES</title>
- <variablelist>
- <varlistentry>
- <term>PAM_ABORT</term>
- <listitem>
- <para>
- General failure.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>PAM_BUF_ERR</term>
- <listitem>
- <para>
- Memory buffer error.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>PAM_SESSION_ERR</term>
- <listitem>
- <para>
- Session failure.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>PAM_SUCCESS</term>
- <listitem>
- <para>
- Session was successful terminated.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
-
- <refsect1 id="pam_close_session-see_also">
- <title>SEE ALSO</title>
- <para>
- <citerefentry>
- <refentrytitle>pam_open_session</refentrytitle><manvolnum>3</manvolnum>
- </citerefentry>,
- <citerefentry>
- <refentrytitle>pam_strerror</refentrytitle><manvolnum>3</manvolnum>
- </citerefentry>
- </para>
- </refsect1>
-</refentry>