make a pynslcd manual page and install it if pynslcd is enabled (and small fix in nslcd manual page)

git-svn-id: http://arthurdejong.org/svn/nss-pam-ldapd/nss-pam-ldapd@1804 ef36b2f9-881f-0410-afb5-c4e39611909c

3 files changed, 154 insertions, 2 deletions

diff --git a/man/Makefile.am b/man/Makefile.am
index 144167c..f88d6ef 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -19,7 +19,7 @@
 
 dist_man_MANS = nslcd.conf.5 nslcd.8
 
-EXTRA_DIST = nslcd.conf.5.xml nslcd.8.xml pam_ldap.8.xml
+EXTRA_DIST = nslcd.conf.5.xml nslcd.8.xml pam_ldap.8.xml pynslcd.8.xml
 
 # ensure that the pam_ldap manpage is always built but only installed
 # if the PAM module is built
@@ -30,6 +30,14 @@ EXTRA_DIST += pam_ldap.8
 noinst_DATA = pam_ldap.8
 endif
 
+# ensure that pynslcd manpage is installed when pynslcd is built
+if ENABLE_PYNSLCD
+dist_man_MANS += pynslcd.8
+else
+EXTRA_DIST += pynslcd.8
+noinst_DATA = pynslcd.8
+endif
+
 if GENMAN
 
 MAINTAINERCLEANFILES = $(dist_man_MANS)
diff --git a/man/nslcd.8.xml b/man/nslcd.8.xml
index e7da8b4..3ae39a5 100644
--- a/man/nslcd.8.xml
+++ b/man/nslcd.8.xml
@@ -83,7 +83,7 @@
     <listitem>
      <para>
       Check if the daemon is running.
-      This causes nslcd to return 0 if the daemon is already running and 1 if it is not.
+      This causes <command>nslcd</command> to return 0 if the daemon is already running and 1 if it is not.
      </para>
     </listitem>
     </varlistentry>
diff --git a/man/pynslcd.8.xml b/man/pynslcd.8.xml
new file mode 100644
index 0000000..c24f458
--- /dev/null
+++ b/man/pynslcd.8.xml
@@ -0,0 +1,144 @@
+<?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">
+
+<!--
+   pynslcd.8.xml - docbook manual page for pynslcd
+
+   Copyright (C) 2012 Arthur de Jong
+
+   This library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
+
+   This library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Lesser General Public License for more details.
+
+   You should have received a copy of the GNU Lesser General Public
+   License along with this library; if not, write to the Free Software
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+   02110-1301 USA
+-->
+
+<refentry id="pynslcd8">
+
+ <refentryinfo>
+  <author>
+   <firstname>Arthur</firstname>
+   <surname>de Jong</surname>
+  </author>
+ </refentryinfo>
+
+ <refmeta>
+  <refentrytitle>pynslcd</refentrytitle>
+  <manvolnum>8</manvolnum>
+  <refmiscinfo class="version">Version 0.8.11</refmiscinfo>
+  <refmiscinfo class="manual">System Manager's Manual</refmiscinfo>
+  <refmiscinfo class="date">Oct 2012</refmiscinfo>
+ </refmeta>
+
+ <refnamediv id="name">
+  <refname>pynslcd</refname>
+  <refpurpose>local LDAP name service daemon.</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv id="synopsis">
+  <cmdsynopsis>
+   <command>pynslcd</command>
+   <arg choice="opt">
+    <replaceable>options</replaceable>
+   </arg>
+  </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id="description">
+  <title>Description</title>
+  <para>
+   <command>pynslcd</command> is a daemon that will do LDAP queries for local
+   processes that want to do user, group and other naming lookups (NSS) or do
+   user authentication, authorisation or password modification (PAM).
+  </para>
+  <para>
+   <command>pynslcd</command> is configured through a configuration file
+   (see <citerefentry><refentrytitle>nslcd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
+  </para>
+  <para>
+   See the included README for information on configuring the LDAP server.
+  </para>
+ </refsect1>
+
+ <refsect1 id="options">
+  <title>Options</title>
+  <para>
+  <command>pynslcd</command> accepts the following options:</para>
+  <variablelist remap="TP">
+   <varlistentry id="check">
+    <term>
+     <option>-c, --check</option>
+    </term>
+    <listitem>
+     <para>
+      Check if the daemon is running.
+      This causes <command>pynslcd</command> to return 0 if the daemon is already running and 1 if it is not.
+     </para>
+    </listitem>
+    </varlistentry>
+    <varlistentry id="debug">
+    <term>
+     <option>-d, --debug</option>
+    </term>
+    <listitem>
+     <para>
+      Enable debugging mode.
+      <command>pynslcd</command> will not put itself in the background and sends
+      verbose debugging info to stderr.
+      <command>pynslcd</command> will handle connections as usual.
+      This option is for debugging purposes only.
+      Specify this option multiple times to also include more detailed logging
+      from the LDAP library.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry id="help">
+    <term>
+     <option>--help</option>
+    </term>
+    <listitem>
+     <para>Display short help and exit.</para>
+    </listitem>
+   </varlistentry>
+   <varlistentry id="version">
+    <term>
+     <option>-V, --version</option>
+    </term>
+    <listitem>
+     <para>Output version information and exit.</para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 id="files">
+  <title>Files</title>
+  <para>
+   <filename>/etc/nslcd.conf</filename> - the configuration file
+   (see <citerefentry><refentrytitle>nslcd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
+  </para>
+ </refsect1>
+
+ <refsect1 id="see_also">
+  <title>See Also</title>
+  <para>
+   <citerefentry><refentrytitle>nslcd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+  </para>
+ </refsect1>
+
+ <refsect1 id="author">
+  <title>Author</title>
+  <para>This manual was written by Arthur de Jong &lt;arthur@arthurdejong.org&gt;.</para>
+ </refsect1>
+
+</refentry>