1 .TH SLAPD.PLUGIN 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 2002-2003 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
5 slapd.plugin \- plugin configuration for slapd, the stand-alone LDAP daemon
11 file contains configuration information for the
13 daemon. This configuration file is also used by the
15 replication daemon and by the SLAPD tools
23 file consists of a series of global configuration options that apply to
25 as a whole (including all backends), followed by zero or more database
26 backend definitions that contain information specific to a backend
34 # comment - these options apply to every database
35 <global configuration options>
36 # first database definition & configuration options
37 database <backend 1 type>
38 <configuration options specific to backend 1>
39 # subsequent database definitions & configuration options
43 If slapd is compiled with \fI--enable-slapi\fP, support for plugins
44 according to \fINetscape's Directory Server Plug-Ins\fP.
45 Version 4.0 of the API is currently implemented.
47 Database specific data may contain plugin information.
48 This manpage details the
50 configuration statements that affect the loading of SLAPI \fIplugins\fP.
52 Arguments that should be replaced by actual text are shown in brackets <>.
54 The structure of the plugin directives is
56 .B plugin "<type> <lib_path> <init_function> [<arguments>]"
57 Load a plugin of the specified type for the current database.
63 that is executed before processing the operation for the specified
66 that is execured after the operation for the specified database
67 has been processed, or
69 The latter is used when executing an extended operation [FIXME].
73 argument specifies the path to the plugin loadable object; if a relative
74 path is given, the object is looked for according to the underlying
75 dynamic loading package (libtool's ltdl is used).
79 argument specifies what symbol must be called when the plugin is first
81 This function should register the functions provided by the plugin
82 for the desired operations.
85 list is passed to the init function.
88 Specify an alternative path for the plugin log file (default is
91 .B modulepath <pathspec>
92 This statement sets the module load path for dynamically loadable
93 backends, as described in
95 however, since both the dynamically loadable backends
96 and the SLAPI plugins use the same underlying library (libtool's ltdl)
97 its value also affects the plugin search path.
98 In general the search path is made of colon-separated paths; usually
99 the user-defined path is searched first; then the value of the
100 \fILTDL_LIBRARY_PATH\fP environment variable, if defined, is used;
101 finally, the systemi-specific dynamic load path is attempted (e.g. on
102 Linux the value of the environment variable \fILD_LIBRARY_PATH\fP).
103 Please carefully read the documentation of ltdl because its behavior
104 is very platform dependent.
108 default slapd configuration file
112 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
115 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
117 is derived from University of Michigan LDAP 3.3 Release.