1 .TH SLAPD-SHELL 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2003 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapd-shell \- Shell backend to slapd
12 executes external programs to implement operations, and is designed to
13 make it easy to tie an existing database to the
17 This backend is is primarily intended to be used in prototypes.
19 .B "This backend's calling conventions have changed since OpenLDAP 2.0."
20 The abandon operation now gets a new "pid:" line.
21 The "msgid:" lines will be removed in a future version.
25 options apply to the SHELL backend database.
26 That is, they must follow a "database shell" line and come before any
27 subsequent "backend" or "database" lines.
28 Other database options are described in the
32 These options specify the pathname and arguments of the program to
33 execute in response to the given LDAP operation.
34 Each option is followed by the input lines that the program receives:
36 .B abandon <pathname> <argument>...
39 msgid: <message ID of operation to abandon>
40 <repeat { "suffix:" <database suffix DN> }>
41 pid: <process ID of operation to abandon>
44 .B add <pathname> <argument>...
48 <repeat { "suffix:" <database suffix DN> }>
49 <entry in LDIF format>
52 .B bind <pathname> <argument>...
56 <repeat { "suffix:" <database suffix DN> }>
58 method: <method number>
59 credlen: <length of <credentials>>
63 .B compare <pathname> <argument>...
67 <repeat { "suffix:" <database suffix DN> }>
72 .B delete <pathname> <argument>...
76 <repeat { "suffix:" <database suffix DN> }>
80 .B modify <pathname> <argument>...
84 <repeat { "suffix:" <database suffix DN> }>
87 <"add"/"delete"/"replace">: <attribute>
88 <repeat { <attribute>: <value> }>
93 .B modrdn <pathname> <argument>...
97 <repeat { "suffix:" <database suffix DN> }>
100 deleteoldrdn: <0 or 1>
101 <if new superior is specified: "newSuperior: <DN>">
104 .B search <pathname> <argument>...
108 <repeat { "suffix:" <database suffix DN> }>
110 scope: <0-2, see ldap.h>
111 deref: <0-3, see ldap.h>
112 sizelimit: <size limit>
113 timelimit: <time limit>
116 attrs: <"all" or space-separated attribute list>
119 .B unbind <pathname> <argument>...
123 <repeat { "suffix:" <database suffix DN> }>
127 Note that you need only supply configuration lines for those commands you
128 want the backend to handle.
129 Operations for which a command is not supplied will be refused with an
130 "unwilling to perform" error.
132 The commands - except \fBabandon\fP and \fBunbind\fP - should output:
137 matched: <matched DN>
141 where only RESULT is mandatory.
142 The \fBsearch\fP RESULT should be preceded by the entries in LDIF
143 format, each entry followed by a blank line.
144 Lines starting with `#' or `DEBUG:' are ignored.
146 There is an example search script in the slapd/back-shell/ directory
147 in the OpenLDAP source tree.
149 The shell backend does not support threaded environments.
150 When using the shell backend,
153 .IR --without-thread .
157 default slapd configuration file