1 .TH SLAPD.PLUGIN 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 2002-2006 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 of the API is currently implemented, with some extensions
48 Both global and database specific data may contain plugin information.
49 Plugins associated with a specific database are called before global
51 This manpage details the
53 configuration statements that affect the loading of SLAPI \fIplugins\fP.
55 Arguments that should be replaced by actual text are shown in brackets <>.
57 The structure of the plugin directives is
59 .B plugin "<type> <lib_path> <init_function> [<arguments>]"
60 Load a plugin of the specified type for the current database.
66 that is executed before processing the operation for the specified
69 that is executed after the operation for the specified database
72 that is used when executing an extended operation, or
74 The latter is used for miscellaneous types such as ACL, computed
75 attribute and search filter rewriter plugins.
79 argument specifies the path to the plugin loadable object; if a relative
80 path is given, the object is looked for according to the underlying
81 dynamic loading package (libtool's ltdl is used).
85 argument specifies what symbol must be called when the plugin is first
87 This function should register the functions provided by the plugin
88 for the desired operations. It should be noted that it is this
89 init function, not the plugin type specified as the first argument,
90 that determines when and for what operations the plugin will be invoked.
93 list is passed to the init function.
96 Specify an alternative path for the plugin log file (default is
99 .B modulepath <pathspec>
100 This statement sets the module load path for dynamically loadable
101 backends, as described in
103 however, since both the dynamically loadable backends
104 and the SLAPI plugins use the same underlying library (libtool's ltdl)
105 its value also affects the plugin search path.
106 In general the search path is made of colon-separated paths; usually
107 the user-defined path is searched first; then the value of the
108 \fILTDL_LIBRARY_PATH\fP environment variable, if defined, is used;
109 finally, the system-specific dynamic load path is attempted (e.g. on
110 Linux the value of the environment variable \fILD_LIBRARY_PATH\fP).
111 Please carefully read the documentation of ltdl because its behavior
112 is very platform dependent.
116 default slapd configuration file
120 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
123 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
125 is derived from University of Michigan LDAP 3.3 Release.