Start documenting pam_winbind's options. Maybe someone more fluent in
[Samba/gebeck_regimport.git] / docs / manpages / pam_winbind.8.xml
blob3af9c79ee296071dbe857bc236a7cd350ee514ae
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
3                                   
4 <!ENTITY % globalentities SYSTEM '../entities/global.entities'> %globalentities;
5 ]>
6 <refentry id="pam_winbind.8">
8 <refmeta>
9         <refentrytitle>pam_winbind</refentrytitle>
10         <manvolnum>8</manvolnum>
11 </refmeta>
14 <refnamediv>
15         <refname>pam_winbind</refname>
16         <refpurpose>PAM module for Winbind</refpurpose>
17 </refnamediv>
19 <refsect1>
20         <title>DESCRIPTION</title>
22         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
23         <manvolnum>7</manvolnum></citerefentry> suite.</para>
25         <para>pam_winbind is a PAM module that can authenticate users against the local domain 
26         by talking to the Winbind daemon.</para>
28 </refsect1>
30 <refsect1>
31         <title>OPTIONS</title>
32         <para>
33                 pam_winbind does support several options:
34                 <variablelist>
36                 <varlistentry>
37                 <term>debug</term>
38                 <listitem><para>Gives debugging-output to syslog.</para></listitem>
39                 </varlistentry>
41                 <varlistentry>
42                 <term>require_membership_of=[SID or NAME]</term>
43                 <listitem><para>
44                 If this option is set, pam_winbind will only succeed if the
45                 user is a member of the given SID or NAME. A SID can be either a group-SID, a
46                 alias-SID or even a user-SID. It is also possible to give a NAME instead of the
47                 SID. That name must have the form: <parameter>MYDOMAIN\mygroup</parameter> or
48                 <parameter>MYDOMAIN\myuser</parameter>.  pam_winbind will, in that case, lookup
49                 the SID internally. You can verify the list of SIDs a user is a member of with
50                 wbinfo --user-sids=SID.
51                 </para></listitem>
52                 </varlistentry>
54                 <varlistentry>
55                 <term>try_first_pass</term>
56                 <listitem><para></para></listitem>
57                 </varlistentry>
59                 <varlistentry>
60                 <term>use_first_pass</term>
61                 <listitem><para>
62                 The default is, that pam_winbind tries to get the
63                 authentication token from a previous module. If no token is available, the user
64                 is asked for the old password. With this option, pam_winbind aborts with an
65                 error if no authentication token from a previous module is available.
66                 </para></listitem>
67                 </varlistentry>
69                 <varlistentry>
70                 <term>use_authtok</term>
71                 <listitem><para>
72                 Set the new password to the one provided by the previously
73                 stacked password module. If this option is not set, pam_winbind would ask the
74                 user for the new password.
75                 </para></listitem>
76                 </varlistentry>
78                 </variablelist>
81         </para>
83 </refsect1>
85 <refsect1>
86         <title>SEE ALSO</title>
87         <para><citerefentry>
88         <refentrytitle>wbinfo</refentrytitle>
89         <manvolnum>1</manvolnum></citerefentry>, <citerefentry>
90         <refentrytitle>winbindd</refentrytitle>
91         <manvolnum>8</manvolnum></citerefentry></para>
92 </refsect1>
94 <refsect1>
95         <title>VERSION</title>
97         <para>This man page is correct for version 3.0 of Samba.</para>
98 </refsect1>
100 <refsect1>
101         <title>AUTHOR</title>
102         
103         <para>The original Samba software and related utilities 
104         were created by Andrew Tridgell. Samba is now developed
105         by the Samba Team as an Open Source project similar 
106         to the way the Linux kernel is developed.</para>
107         
108         <para>This manpage was written by Jelmer Vernooij and Guenther Deschner.</para>
110 </refsect1>
112 </refentry>