git.sur5r.net Git - openldap/blob - doc/man/man8/ldapd.8

   1 .TH LDAPD 8C "22 September 1998" "OpenLDAP LDVERSION"
   2 .SH NAME
   3 ldapd \- LDAP X.500 Protocol Daemon
   4 .SH SYNOPSIS
   5 .B LIBEXECDIR/ldapd [\-d level] [\-l] [\-c dsaname]
   6 .B [\-p port] [\-t timeout] [\-r referraltimeout]
   7 .B [\-I] [\-U]
   8 .SH DESCRIPTION
   9 .LP
  10 .B Ldapd
  11 is the LDAP to X.500 gateway daemon.  The LDAP protocol is used to
  12 provide lightweight TCP/IP access to the X.500 Directory. The
  13 .B ldapd
  14 server is typically invoked at boot time, usually out of
  15 .BR  /etc/rc.local .
  16 Upon startup,
  17 .B ldapd
  18 normally forks and disassociates itself from the invoking tty, and then
  19 listens on port 389 for TCP connections from LDAP clients.
  20 The server performs the following basic operations for the client:
  21 .TP 14
  22 .B Bind
  23 Bind to the X.500 directory.  Currently only simple (clear-text password)
  24 and kerberos version 4 authentication are supported.
  25 .TP
  26 .B Search
  27 Search the X.500 directory for entries that match a given filter.
  28 The scope of the search can be base object, one level, or whole subtree.
  29 Note that the X.500 read and list can be emulated using search.
  30 .TP
  31 .B Modify
  32 Change the attributes and values of an existing X.500 entry.
  33 .TP
  34 .B Modify RDN
  35 Change the Relative Distinguished Name of an X.500 entry.
  36 .TP
  37 .B Add
  38 Add an entry to the X.500 directory.
  39 .TP
  40 .B Remove
  41 Remove an entry from the X.500 directory.
  42 .TP
  43 .B Abandon
  44 Abort an operation in progress.
  45 .LP
  46 See
  47 .BR ldap (3)
  48 for details on client-side access to the ldap server.  See
  49 .I RFC 1777: Lightweight Directory Access Protocol
  50 and
  51 .I RFC 1778: The String Representation of
  52 .I Standard Attribute Syntaxes
  53 for details of the protocol supporting the above operations.
  54 .SH OPTIONS
  55 .TP
  56 .BI \-d " level"
  57 Turn on debugging as defined by
  58 .I level.
  59 If this option is specified,
  60 .I ldapd
  61 will not fork or disassociate from the invoking terminal.  Some general
  62 operation and status messages are printed for any value of \fIlevel\fP.
  63 \fIlevel\fP is taken as a bit string, with each bit corresponding to a
  64 different kind of debugging information.  See <ldap.h> for details.
  65 .TP
  66 .B \-l
  67 Enable logging of various status and errors to the LOG_LOCAL4 facility via
  68 .BR syslog (8).
  69 .TP
  70 .RB \-c " dsaname"
  71 Connect to the named DSA initially.  The
  72 .I dsaname
  73 given should be a name found in the local dsaptailor file or an
  74 actual presentation address.
  75 .TP
  76 .BI \-p " port"
  77 Listen on port
  78 .I port
  79 instead of the default port.  This is useful for debugging purposes.
  80 .TP
  81 .BI \-t " timeout"
  82 Specify the timeout value after which idle connections from
  83 clients are closed.
  84 .TP
  85 .BI \-r " referraltimeout"
  86 Specify the timeout value after which idle connections to DSAs
  87 are closed.
  88 .TP
  89 .B \-I
  90 Run from
  91 .BR inetd (8)
  92 instead of as a stand-alone daemon.
  93 .TP
  94 .B \-U
  95 Support Connectionless LDAP (CLDAP).  In this mode, ldapd listens for
  96 CLDAP search requests only on a UDP port, performs the search, and
  97 returns the result.  See
  98 .BR udp (4)
  99 for more information on UDP.
 100 .SH EXAMPLES
 101 To start ldapd and have it fork and detach from the terminal and connect
 102 to the first DSA listed in the dsaptailor file, just type:
 103 .LP
 104 .nf
 105 .ft tt
 106         LIBEXECDIR/ldapd
 107 .ft
 108 .fi
 109 .LP
 110 To connect to an alternate DSA and turn on voluminous debugging which
 111 will be printed on standard error, type:
 112 .LP
 113 .nf
 114 .ft tt
 115         LIBEXECDIR/ldapd -c dsanameoraddr -d 31
 116 .ft
 117 .fi
 118 .LP
 119 where dsanameoraddr is a presentation address or a name that appears
 120 in the local dsaptailor file.
 121 .SH "SEE ALSO"
 122 .BR ldap (3),
 123 .BR udp (4),
 124 .BR slapd (8)
 125 .BR inetd (8)
 126 .LP
 127 Volume 5 of The ISODE Manual
 128 .SH ACKNOWLEDGEMENTS
 129 .B      OpenLDAP
 130 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 131 .B      OpenLDAP
 132 is derived from University of Michigan LDAP 3.3 Release.