summaryrefslogtreecommitdiff
path: root/doc/man/pam_start.3.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/pam_start.3.xml')
-rw-r--r--doc/man/pam_start.3.xml22
1 files changed, 21 insertions, 1 deletions
diff --git a/doc/man/pam_start.3.xml b/doc/man/pam_start.3.xml
index 50a65a47..1d544e64 100644
--- a/doc/man/pam_start.3.xml
+++ b/doc/man/pam_start.3.xml
@@ -12,6 +12,7 @@
<refnamediv id="pam_start-name">
<refname>pam_start</refname>
+ <refname>pam_start_confdir</refname>
<refpurpose>initialization of PAM transaction</refpurpose>
</refnamediv>
@@ -27,6 +28,14 @@
<paramdef>const struct pam_conv *<parameter>pam_conversation</parameter></paramdef>
<paramdef>pam_handle_t **<parameter>pamh</parameter></paramdef>
</funcprototype>
+ <funcprototype>
+ <funcdef>int <function>pam_start_confdir</function></funcdef>
+ <paramdef>const char *<parameter>service_name</parameter></paramdef>
+ <paramdef>const char *<parameter>user</parameter></paramdef>
+ <paramdef>const struct pam_conv *<parameter>pam_conversation</parameter></paramdef>
+ <paramdef>const char *<parameter>confdir</parameter></paramdef>
+ <paramdef>pam_handle_t **<parameter>pamh</parameter></paramdef>
+ </funcprototype>
</funcsynopsis>
</refsynopsisdiv>
@@ -87,6 +96,17 @@
same time as long as <function>pam_end</function> was not called on
it before.
</para>
+
+ <para>
+ The <function>pam_start_confdir</function> function behaves
+ like the <function>pam_start</function> function but it also
+ allows setting <emphasis>confdir</emphasis> argument with
+ a path to a directory to override the default
+ (<filename>/etc/pam.d</filename>) path for service policy
+ files. If the <emphasis>confdir</emphasis> is NULL, the function
+ works exactly the same as <function>pam_start</function>.
+ </para>
+
</refsect1>
<refsect1 id="pam_start-return_values">
<title>RETURN VALUES</title>
@@ -111,7 +131,7 @@
<term>PAM_SUCCESS</term>
<listitem>
<para>
- Transaction was successful created.
+ Transaction was successfully started.
</para>
</listitem>
</varlistentry>