Arthur de Jong

Open Source / Free Software developer

summaryrefslogtreecommitdiffstats
path: root/man/nslcd.8.xml
blob: 1c3a52e36b77fe796f35e468348fa1eb4f4eca29 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<?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">

<!--
   nslcd.8.xml - docbook manual page for nslcd

   Copyright (C) 2006 West Consulting
   Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 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.7.15</refmiscinfo>
  <refmiscinfo class="manual">System Manager's Manual</refmiscinfo>
  <refmiscinfo class="date">Oct 2011</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>
    <term>
     <option>-c, --check</option>
    </term>
    <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.
     </para>
    </listitem>
    </varlistentry>
    <varlistentry>
    <term>
     <option>-d, --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>
    <term>
     <option>--help</option>
    </term>
    <listitem>
     <para>Display short help and exit.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <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>