]> git.sur5r.net Git - openldap/blobdiff - doc/guide/admin/runningslapd.sdf
Merge remote branch 'origin/mdb.master' into OPENLDAP_REL_ENG_2_4
[openldap] / doc / guide / admin / runningslapd.sdf
index 68b32be7141bb433a81fd3f3fd357bd2a47d9b84..7161ce1cbc646e731ea5805e12abe70dfb287f49 100644 (file)
@@ -1,5 +1,5 @@
 # $OpenLDAP$
-# Copyright 1999-2009 The OpenLDAP Foundation, All Rights Reserved.
+# Copyright 1999-2012 The OpenLDAP Foundation, All Rights Reserved.
 # COPYING RESTRICTIONS APPLY, see COPYRIGHT.
 H1: Running slapd
 
@@ -36,7 +36,16 @@ 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
+as {{EX:ldaps://}} or {{EX:ldapi://}}).
+
+!block table
+URL        Protocol        Transport
+ldap:///   LDAP            TCP port 389
+ldaps:///  LDAP over SSL   TCP port 636
+ldapi:///  LDAP            IPC (Unix-domain socket)
+!endblock
+
+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
@@ -45,6 +54,18 @@ on port 666.  Hosts may be specified using using hostnames or
 {{TERM:IPv4}} or {{TERM:IPv6}} addresses.  Port values must be
 numeric.
 
+For LDAP over IPC, the pathname of the Unix-domain socket can be encoded
+in the URL. Note that directory separators must be 
+URL-encoded, like any other characters that are special to URLs.
+Thus the socket {{EX:/usr/local/var/ldapi}} must be encoded as
+
+>      ldapi://%2Fusr%2Flocal%2Fvar%2Fldapi
+
+ldapi: is described in detail in {{Using LDAP Over IPC Mechanisms}} [{{REF:Chu-LDAPI}}]
+
+Note that the ldapi:/// transport is not widely implemented: non-OpenLDAP clients
+may not be able to use it.
+
 >      -n <service-name>
 
 This option specifies the service name used for logging and
@@ -80,35 +101,30 @@ debugging levels are
 
 !block table; colaligns="RL"; align=Center; \
        title="Table 7.1: Debugging Levels"
-Level  Description
--1     enable all debugging
-0      no debugging
-1      trace function calls
-2      debug packet handling
-4      heavy trace debugging
-8      connection management
-16     print out packets sent and received
-32     search filter processing
-64     configuration file processing
-128    access control list processing
-256    stats log connections/operations/results
-512    stats log entries sent
-1024   print communication with shell backends
-2048   print entry parsing debugging
+Level  Keyword         Description
+-1     any             enable all debugging
+0                      no debugging
+1      (0x1 trace)     trace function calls
+2      (0x2 packets)   debug packet handling
+4      (0x4 args)      heavy trace debugging
+8      (0x8 conns)     connection management
+16     (0x10 BER)      print out packets sent and received
+32     (0x20 filter)   search filter processing
+64     (0x40 config)   configuration processing
+128    (0x80 ACL)      access control list processing
+256    (0x100 stats)   stats log connections/operations/results
+512    (0x200 stats2)  stats log entries sent
+1024   (0x400 shell)   print communication with shell backends
+2048   (0x800 parse)   print entry parsing debugging
+16384  (0x4000 sync)   syncrepl consumer processing
+32768  (0x8000 none)   only messages that get logged whatever log level is set
 !endblock
 
-You may enable multiple levels by specifying the debug option
-once for each desired level.  Or, since debugging levels are
-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_log.h>}} for
-more details.
+You may enable multiple levels by specifying the debug option once for each desired level.  Or, since debugging levels are 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_log.h>}} for more details.
 
-Note: slapd must have been compiled with {{EX:-DLDAP_DEBUG}}
+Note: slapd must have been compiled with {{EX:--enable-debug}}
 defined for any debugging information beyond the two stats levels
-to be available.
+to be available (the default).
 
 
 H2: Starting slapd