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

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