"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

   nslcd.8.xml - docbook manual page for nslcd

   Copyright (C) 2006 West Consulting

   Copyright (C) 2006-2018 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="nslcd8">

 <refentryinfo>

  <author>

   <firstname>Arthur</firstname>

   <surname>de Jong</surname>

  </author>

 </refentryinfo>

 <refmeta>

  <refentrytitle>nslcd</refentrytitle>

  <manvolnum>8</manvolnum>

  <refmiscinfo class="version">Version 0.9.9</refmiscinfo>

  <refmiscinfo class="manual">System Manager's Manual</refmiscinfo>

  <refmiscinfo class="date">Feb 2018</refmiscinfo>

 </refmeta>

 <refnamediv id="name">

  <refname>nslcd</refname>

  <refpurpose>local LDAP name service daemon</refpurpose>

 </refnamediv>

 <refsynopsisdiv id="synopsis">

  <cmdsynopsis>

   <command>nslcd</command>

   <arg choice="opt"><replaceable>options</replaceable></arg>

  </cmdsynopsis>

 </refsynopsisdiv>

 <refsect1 id="description">

  <title>Description</title>

  <para>

   <command>nslcd</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>nslcd</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>nslcd</command> accepts the following options:</para>

  <variablelist remap="TP">

   <varlistentry id="check">

    <term>

     <option>-c</option>, <option>--check</option>

    </term>

    <listitem>

     <para>

      Check if the daemon is running.

      This causes <command>nslcd</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</option>, <option>--debug</option>

    </term>

    <listitem>

     <para>

      Enable debugging mode.

      <command>nslcd</command> will not put itself in the background and sends

      verbose debugging info to stderr.

      <command>nslcd</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="nofork">

    <term>

     <option>-n</option>, <option>--nofork</option>

    </term>

    <listitem>

     <para>

      Do not fork or daemonise and run <command>nslcd</command> in the

      foreground.

     </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</option>, <option>--version</option>

    </term>

    <listitem>

     <para>Output version information and exit.</para>

    </listitem>

   </varlistentry>

  </variablelist>

 </refsect1>

 <refsect1 id="signals">

  <title>Signals</title>

  <variablelist remap="IP">

   <varlistentry id="sigterm">

    <term><option>SIGTERM</option>/<option>SIGINT</option></term>

    <listitem>

     <para>Cancel any running queries and exit.</para>

    </listitem>

   </varlistentry>

   <varlistentry id="sigusr1"> 

    <term><option>SIGUSR1</option></term>

    <listitem>

     <para>Cause <command>nslcd</command> to retry any failing connections

     to the LDAP server, regardless of the <option>reconnect_sleeptime</option>

     and <option>reconnect_retrytime</option> options.</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 <arthur@arthurdejong.org>.</para>

 </refsect1>

</refentry>