docs: Add manpage for winbind_krb5_localauth.8
authorAndreas Schneider <asn@samba.org>
Wed, 27 Jun 2018 13:06:07 +0000 (15:06 +0200)
committerKarolin Seeger <kseeger@samba.org>
Thu, 23 Aug 2018 08:38:27 +0000 (10:38 +0200)
BUG: https://bugzilla.samba.org/show_bug.cgi?id=13489

Signed-off-by: Andreas Schneider <asn@samba.org>
Reviewed-by: Alexander Bokovoy <ab@samba.org>
Autobuild-User(master): Andreas Schneider <asn@cryptomilk.org>
Autobuild-Date(master): Wed Jun 27 18:45:56 CEST 2018 on sn-devel-144

(cherry picked from commit e88d68c253b4398eaed701d1a9bcc1b83882e127)

docs-xml/manpages/winbind_krb5_localauth.8.xml [new file with mode: 0644]
docs-xml/wscript_build

diff --git a/docs-xml/manpages/winbind_krb5_localauth.8.xml b/docs-xml/manpages/winbind_krb5_localauth.8.xml
new file mode 100644 (file)
index 0000000..a382e71
--- /dev/null
@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
+<refentry id="winbind_krb5_localauth.8">
+
+<refmeta>
+       <refentrytitle>winbind_krb5_localauth</refentrytitle>
+       <manvolnum>8</manvolnum>
+       <refmiscinfo class="source">Samba</refmiscinfo>
+       <refmiscinfo class="manual">8</refmiscinfo>
+       <refmiscinfo class="version">&doc.version;</refmiscinfo>
+</refmeta>
+
+
+<refnamediv>
+       <refname>winbind_krb5_localauth</refname>
+       <refpurpose>A plugin for MIT Kerberos for mapping user accounts.</refpurpose>
+</refnamediv>
+
+
+<refsect1>
+       <title>DESCRIPTION</title>
+
+       <para>
+               This plugin is part of the
+               <citerefentry><refentrytitle>samba</refentrytitle>
+               <manvolnum>7</manvolnum></citerefentry> suite.
+       </para>
+
+       <para>
+               <command>winbind_krb5_localauth</command> is a plugin that
+               permits the MIT Kerberos libraries that Kerberos principals can
+               be validated against local user accounts.
+       </para>
+</refsect1>
+<refsect1>
+       <title>PREREQUISITES</title>
+       <para>
+               MIT Kerberos (at least version 1.12) is required.
+       </para>
+
+       <para>
+               The plugin queries the <citerefentry><refentrytitle>winbindd</refentrytitle>
+               <manvolnum>8</manvolnum></citerefentry> daemon which needs to be configured
+               and started separately.
+       </para>
+
+       <para>
+               The following sections needs to be added to the
+               <filename>krb5.conf</filename> file.
+
+               <programlisting>
+[plugins]
+       localauth = {
+               module = winbind:/usr/lib64/samba/krb5/winbind_krb5_localauth.so
+               enable_only = winbind
+       }
+               </programlisting>
+       </para>
+</refsect1>
+
+<refsect1>
+       <title>VERSION</title>
+
+       <para>
+               This man page is part of version &doc.version; of the Samba
+               suite.
+       </para>
+</refsect1>
+
+<refsect1>
+       <title>AUTHOR</title>
+
+       <para>
+               The original Samba software and related utilities were created
+               by Andrew Tridgell. Samba is now developed by the Samba Team as
+               an Open Source project similar to the way the Linux kernel is
+               developed.
+       </para>
+
+       <para>
+               The winbind_krb5_localauth manpage was written by Andreas
+               Schneider.
+       </para>
+</refsect1>
+
+</refentry>
index 2d686eb..ec5d28f 100644 (file)
@@ -104,6 +104,7 @@ pam_winbind_manpages = '''
                        '''
 
 krb5_locator_manpages = 'manpages/winbind_krb5_locator.8'
+krb5_localauth_manpages = 'manpages/winbind_krb5_localauth.8'
 
 def smbdotconf_generate_parameter_list(task):
     parameter_all = task.outputs[0].bldpath(task.env)
@@ -162,5 +163,8 @@ if ('XSLTPROC_MANPAGES' in bld.env and bld.env['XSLTPROC_MANPAGES']):
     if bld.CONFIG_SET('HAVE_KRB5_LOCATE_PLUGIN_H'):
         bld.SAMBAMANPAGES(krb5_locator_manpages)
 
+    if bld.CONFIG_SET('HAVE_KRB5_LOCALAUTH_PLUGIN_H'):
+        bld.SAMBAMANPAGES(krb5_localauth_manpages)
+
     if bld.SAMBA3_IS_ENABLED_MODULE('vfs_zfsacl'):
         bld.SAMBAMANPAGES('manpages/vfs_zfsacl.8')