]> git.sur5r.net Git - openldap/blobdiff - doc/guide/admin/runningslapd.sdf
This is used in the Makefile rule to build guide.pdf. Hence the -f is bogus.
[openldap] / doc / guide / admin / runningslapd.sdf
index c3da2cd7135573d294e6c04a89aaf14cdc3f3e1a..fda57ae21cf02a3b2df6db3a01e4757e6f472e90 100644 (file)
@@ -1,42 +1,54 @@
 # $OpenLDAP$
-# Copyright 1999-2000, The OpenLDAP Foundation, All Rights Reserved.
+# Copyright 1999-2007 The OpenLDAP Foundation, All Rights Reserved.
 # COPYING RESTRICTIONS APPLY, see COPYRIGHT.
 H1: Running slapd
 
-{{slapd}}(8) is designed to be run as a stand-alone server.  This allows
-the server to take advantage of caching, manage concurrency issues
-with underlying databases, and conserve system resources.  Running
-from {{inetd}}(8) is {{NOT}} an option.
+{{slapd}}(8) is designed to be run as a standalone service.  This
+allows the server to take advantage of caching, manage concurrency
+issues with underlying databases, and conserve system resources.
+Running from {{inetd}}(8) is {{NOT}} an option.
 
 
 H2: Command-Line Options
 
 {{slapd}}(8) supports a number of command-line options as detailed
-in manual page.  This section details a few commonly used options.
+in the manual page.  This section details a few commonly used options.
 
 >      -f <filename>
 
 This option specifies an alternate configuration file for slapd.
 The default is normally {{F:/usr/local/etc/openldap/slapd.conf}}.
 
+>      -F <slapd-config-directory>
+
+Specifies the slapd configuration directory. The default is {{F:/usr/local/etc/openldap/slapd.d}}
+
+If both {{EX:-f}} and {{EX:-F}} are specified, the config file will be read and converted 
+to config directory format and written to the specified directory.  
+If neither option is specified, slapd will attempt to read the default config 
+directory before trying to use the default config file. If a valid config 
+directory exists then the default config file is ignored. All of the slap tools 
+that use the config options observe this same behavior.
+
 >      -h <URLs>
 
-This option specifies alternative listener configuration.  The
-default is {{EX:ldap:///}} which implies LDAP over TCP, on all
-interfaces, on the default LDAP port 389.  You can specify
-specific host-port pairs or other protocol schemes (such as
-ldaps:// or ldapi://).  For example,
-{{EX:-h "ldaps:// ldap://127.0.0.1:666"}} will create
-two listeners: one for LDAP over SSL, on all interfaces, on
-the default LDAP/SSL port 646 and one for LDAP over TCL, only
-the {{EX:localhost}} ({{loopback}}) interface, on port 666.
-Hosts may be specified using IPv4 dot-decimal form or
-using host names.  Ports values must be numeric.
+This option specifies alternative listener configurations.  The
+default is {{EX:ldap:///}} which implies {{TERM:LDAP}} over
+{{TERM:TCP}} on all interfaces on the default LDAP port 389.  You
+can specify specific host-port pairs or other protocol schemes (such
+as {{EX:ldaps://}} or {{EX:ldapi://}}).  For example, {{EX:-h
+"ldaps:// ldap://127.0.0.1:666"}} will create two listeners: one
+for the (non-standard) {{EX:ldaps://}} scheme on all interfaces on
+the default {{EX:ldaps://}} port 636, and one for the standard
+{{EX:ldap://}} scheme on the {{EX:localhost}} ({{loopback}}) interface
+on port 666.  Hosts may be specified using using hostnames or
+{{TERM:IPv4}} or {{TERM:IPv6}} addresses.  Port values must be
+numeric.
 
 >      -n <service-name>
 
 This option specifies the service name used for logging and
-other purposes.  The default service name is {{EX:slapd}}.
+other purposes. The default service name is {{EX:slapd}}.
 
 >      -l <syslog-local-user>
 
@@ -55,8 +67,8 @@ can be either a group name or gid.
 
 This option specifies a run-time directory.  slapd will
 {{chroot}}(2) to this directory after opening listeners but
-before any reading any configuration file or initializing
-any backend.
+before reading any configuration files or initializing
+any backends.
 .
 
 >      -d <level> | ?
@@ -67,7 +79,7 @@ exits, regardless of any other options you give it. Current
 debugging levels are
 
 !block table; colaligns="RL"; align=Center; \
-       title="Table 6.1: Debugging Levels"
+       title="Table 7.1: Debugging Levels"
 Level  Description
 -1     enable all debugging
 0      no debugging
@@ -91,7 +103,7 @@ additive, you can do the math yourself. That is, if you want
 to trace function calls and watch the config file being
 processed, you could set level to the sum of those two levels
 (in this case, {{EX: -d 65}}).  Or, you can let slapd do the
-math, (e.g. {{EX: -d 1 -d 64}}).  Consult {{F: <ldap.h>}} for
+math, (e.g. {{EX: -d 1 -d 64}}).  Consult {{F: <ldap_log.h>}} for
 more details.
 
 Note: slapd must have been compiled with {{EX:-DLDAP_DEBUG}}
@@ -103,9 +115,9 @@ H2: Starting slapd
 
 In general, slapd is run like this:
 
->      /usr/local/etc/libexec/slapd [<option>]*
+>      /usr/local/libexec/slapd [<option>]*
 
-where {{F:/usr/local/etc/libexec}} is determined by {{EX:configure}}.
+where {{F:/usr/local/libexec}} is determined by {{EX:configure}}
 and <option> is one of the options described above (or in {{slapd}}(8)).
 Unless you have specified a debugging level (including level {{EX:0}}),
 slapd will automatically fork and detach itself from its controlling
@@ -113,11 +125,11 @@ terminal and run in the background.
 
 H2: Stopping slapd
 
-To kill off slapd safely, you should give a command like this
+To kill off {{slapd}}(8) safely, you should give a command like this
 
 >      kill -INT `cat /usr/local/var/slapd.pid`
 
 where {{F:/usr/local/var}} is determined by {{EX:configure}}.
 
-Killing slapd by a more drastic method may cause its information
-loss or database corruption.
+Killing slapd by a more drastic method may cause information loss or
+database corruption.