"Fossies" - the Fresh Open Source Software Archive

Member "nss-pam-ldapd-0.9.12/man/nslcd.8.xml" (20 Nov 2021, 5367 Bytes) of package /linux/privat/nss-pam-ldapd-0.9.12.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) XML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 <?xml version="1.0" encoding="utf-8"?>
    2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    4 
    5 <!--
    6    nslcd.8.xml - docbook manual page for nslcd
    7 
    8    Copyright (C) 2006 West Consulting
    9    Copyright (C) 2006-2021 Arthur de Jong
   10 
   11    This library is free software; you can redistribute it and/or
   12    modify it under the terms of the GNU Lesser General Public
   13    License as published by the Free Software Foundation; either
   14    version 2.1 of the License, or (at your option) any later version.
   15 
   16    This library is distributed in the hope that it will be useful,
   17    but WITHOUT ANY WARRANTY; without even the implied warranty of
   18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   19    Lesser General Public License for more details.
   20 
   21    You should have received a copy of the GNU Lesser General Public
   22    License along with this library; if not, write to the Free Software
   23    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
   24    02110-1301 USA
   25 -->
   26 
   27 <refentry id="nslcd8">
   28 
   29  <refentryinfo>
   30   <author>
   31    <firstname>Arthur</firstname>
   32    <surname>de Jong</surname>
   33   </author>
   34  </refentryinfo>
   35 
   36  <refmeta>
   37   <refentrytitle>nslcd</refentrytitle>
   38   <manvolnum>8</manvolnum>
   39   <refmiscinfo class="version">Version 0.9.12</refmiscinfo>
   40   <refmiscinfo class="manual">System Manager's Manual</refmiscinfo>
   41   <refmiscinfo class="date">Nov 2021</refmiscinfo>
   42  </refmeta>
   43 
   44  <refnamediv id="name">
   45   <refname>nslcd</refname>
   46   <refpurpose>local LDAP name service daemon</refpurpose>
   47  </refnamediv>
   48 
   49  <refsynopsisdiv id="synopsis">
   50   <cmdsynopsis>
   51    <command>nslcd</command>
   52    <arg choice="opt"><replaceable>options</replaceable></arg>
   53   </cmdsynopsis>
   54  </refsynopsisdiv>
   55 
   56  <refsect1 id="description">
   57   <title>Description</title>
   58   <para>
   59    <command>nslcd</command> is a daemon that will do LDAP queries for local
   60    processes that want to do user, group and other naming lookups (NSS) or do
   61    user authentication, authorisation or password modification (PAM).
   62   </para>
   63   <para>
   64    <command>nslcd</command> is configured through a configuration file
   65    (see <citerefentry><refentrytitle>nslcd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
   66   </para>
   67   <para>
   68    See the included README for information on configuring the LDAP server.
   69   </para>
   70  </refsect1>
   71 
   72  <refsect1 id="options">
   73   <title>Options</title>
   74   <para>
   75   <command>nslcd</command> accepts the following options:</para>
   76   <variablelist remap="TP">
   77 
   78    <varlistentry id="check">
   79     <term>
   80      <option>-c</option>, <option>--check</option>
   81     </term>
   82     <listitem>
   83      <para>
   84       Check if the daemon is running.
   85       This causes <command>nslcd</command> to return 0 if the daemon is already running and 1 if it is not.
   86      </para>
   87     </listitem>
   88    </varlistentry>
   89 
   90    <varlistentry id="debug">
   91     <term>
   92      <option>-d</option>, <option>--debug</option>
   93     </term>
   94     <listitem>
   95      <para>
   96       Enable debugging mode.
   97       <command>nslcd</command> will not put itself in the background and sends
   98       verbose debugging info to stderr.
   99       <command>nslcd</command> will handle connections as usual.
  100       This option is for debugging purposes only.
  101       Specify this option multiple times to also include more detailed logging
  102       from the LDAP library.
  103      </para>
  104     </listitem>
  105    </varlistentry>
  106 
  107    <varlistentry id="nofork">
  108     <term>
  109      <option>-n</option>, <option>--nofork</option>
  110     </term>
  111     <listitem>
  112      <para>
  113       Do not fork or daemonise and run <command>nslcd</command> in the
  114       foreground.
  115      </para>
  116     </listitem>
  117    </varlistentry>
  118 
  119    <varlistentry id="help">
  120     <term>
  121      <option>--help</option>
  122     </term>
  123     <listitem>
  124      <para>Display short help and exit.</para>
  125     </listitem>
  126    </varlistentry>
  127 
  128    <varlistentry id="version">
  129     <term>
  130      <option>-V</option>, <option>--version</option>
  131     </term>
  132     <listitem>
  133      <para>Output version information and exit.</para>
  134     </listitem>
  135    </varlistentry>
  136 
  137   </variablelist>
  138  </refsect1>
  139 
  140  <refsect1 id="signals">
  141   <title>Signals</title>
  142   <variablelist remap="IP">
  143    <varlistentry id="sigterm">
  144     <term><option>SIGTERM</option>/<option>SIGINT</option></term>
  145     <listitem>
  146      <para>Cancel any running queries and exit.</para>
  147     </listitem>
  148    </varlistentry>
  149    <varlistentry id="sigusr1"> <!-- since 0.9.1 -->
  150     <term><option>SIGUSR1</option></term>
  151     <listitem>
  152      <para>Cause <command>nslcd</command> to retry any failing connections
  153      to the LDAP server, regardless of the <option>reconnect_sleeptime</option>
  154      and <option>reconnect_retrytime</option> options.</para>
  155     </listitem>
  156    </varlistentry>
  157   </variablelist>
  158  </refsect1>
  159 
  160  <refsect1 id="files">
  161   <title>Files</title>
  162   <para>
  163    <filename>/etc/nslcd.conf</filename> - the configuration file
  164    (see <citerefentry><refentrytitle>nslcd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
  165   </para>
  166  </refsect1>
  167 
  168  <refsect1 id="see_also">
  169   <title>See Also</title>
  170   <para>
  171    <citerefentry><refentrytitle>nslcd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  172   </para>
  173  </refsect1>
  174 
  175  <refsect1 id="author">
  176   <title>Author</title>
  177   <para>This manual was written by Arthur de Jong &lt;arthur@arthurdejong.org&gt;.</para>
  178  </refsect1>
  179 
  180 </refentry>