summaryrefslogtreecommitdiff
path: root/sss_client/man
diff options
context:
space:
mode:
authorSumit Bose <sbose@redhat.com>2009-09-23 17:28:00 +0200
committerSimo Sorce <ssorce@redhat.com>2009-09-23 12:33:02 -0400
commit2d122490cb57fe4e8c4b8968d68576f092eb0e60 (patch)
treebc14f84c4db9a7f6a21fd6132bfd83d4026dc38c /sss_client/man
parent5085072530ead6c81d5e73fe11c41441470eb15b (diff)
downloadsssd-2d122490cb57fe4e8c4b8968d68576f092eb0e60.tar.gz
sssd-2d122490cb57fe4e8c4b8968d68576f092eb0e60.tar.bz2
sssd-2d122490cb57fe4e8c4b8968d68576f092eb0e60.zip
add a man page for pam_sss
Diffstat (limited to 'sss_client/man')
-rw-r--r--sss_client/man/pam_sss.8.xml97
1 files changed, 97 insertions, 0 deletions
diff --git a/sss_client/man/pam_sss.8.xml b/sss_client/man/pam_sss.8.xml
new file mode 100644
index 00000000..f6ac9f47
--- /dev/null
+++ b/sss_client/man/pam_sss.8.xml
@@ -0,0 +1,97 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+<reference>
+<title>SSSD Manual pages</title>
+<refentry>
+ <refentryinfo>
+ <productname>SSSD</productname>
+ <orgname>The SSSD upstream - http://fedorahosted.org/sssd</orgname>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>pam_sss</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv id='name'>
+ <refname>pam_sss</refname>
+ <refpurpose>PAM module for SSSD</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>pam_sss.so</command>
+ <arg choice='opt'>
+ <replaceable>forward_pass</replaceable>
+ </arg>
+ <arg choice='opt'>
+ <replaceable>use_first_pass</replaceable>
+ </arg>
+ <arg choice='opt'>
+ <replaceable>use_authtok</replaceable>
+ </arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para><command>pam_sss.so</command> is the PAM interface to the System
+ Security Services daemon (SSSD). Errors and results are logged through
+ <command>syslog(3)</command> with the LOG_AUTHPRIV facility.</para>
+ </refsect1>
+
+ <refsect1 id='options'>
+ <title>OPTIONS</title>
+ <variablelist remap='IP'>
+ <varlistentry>
+ <term>
+ <option>forward_pass</option>
+ </term>
+ <listitem>
+ <para>If <option>forward_pass</option> is set the entered
+ password is put on the stack for other PAM modules to use.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>use_first_pass</option>
+ </term>
+ <listitem>
+ <para>The argument use_first_pass forces the module to use
+ a previous stacked modules password and will never prompt
+ the user - if no password is available or the password is
+ not appropriate, the user will be denied access.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>use_authtok</option>
+ </term>
+ <listitem>
+ <para>When password changing enforce the module to set the
+ new password to the one provided by a previously stacked
+ password module.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 id='module_types_provides'>
+ <title>MODULE TYPES PROVIDED</title>
+ <para>All module types (<option>account</option>, <option>auth</option>,
+ <option>password</option> and <option>session</option>) are provided.
+ </para>
+ </refsect1>
+
+ <refsect1 id='see_also'>
+ <title>SEE ALSO</title>
+ <para>
+ <citerefentry>
+ <refentrytitle>sssd.conf</refentrytitle><manvolnum>8</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+</refentry>
+</reference>