1 .TH SLAPD-SHELL 5 "2 May 2002" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2002 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
19 options apply to the SHELL backend database.
20 That is, they must follow a "database shell" line and come before any
21 subsequent "backend" or "database" lines.
22 Other database options are described in the
26 These options specify the pathname and arguments of the program to
27 execute in response to the given LDAP operation.
28 Each option is followed by the input lines that the program receives:
30 .B abandon <pathname> <argument>...
34 <repeat { "suffix:" <database suffix DN> }>
37 .B add <pathname> <argument>...
41 <repeat { "suffix:" <database suffix DN> }>
42 <entry in LDIF format>
45 .B bind <pathname> <argument>...
49 <repeat { "suffix:" <database suffix DN> }>
51 method: <method number>
52 credlen: <length of <credentials>>
56 .B compare <pathname> <argument>...
60 <repeat { "suffix:" <database suffix DN> }>
65 .B delete <pathname> <argument>...
69 <repeat { "suffix:" <database suffix DN> }>
73 .B modify <pathname> <argument>...
77 <repeat { "suffix:" <database suffix DN> }>
80 <"add"/"delete"/"replace">: <attribute>
81 <repeat { <attribute>: <value> }>
86 .B modrdn <pathname> <argument>...
90 <repeat { "suffix:" <database suffix DN> }>
93 deleteoldrdn: <0 or 1>
94 <if new superior is specified: "newSuperior: <DN>">
97 .B search <pathname> <argument>...
101 <repeat { "suffix:" <database suffix DN> }>
103 scope: <0-2, see ldap.h>
104 deref: <0-3, see ldap.h>
105 sizelimit: <size limit>
106 timelimit: <time limit>
109 attrs: <"all" or space-separated attribute list>
112 .B unbind <pathname> <argument>...
116 <repeat { "suffix:" <database suffix DN> }>
120 Note that you need only supply configuration lines for those commands you
121 want the backend to handle.
122 Operations for which a command is not supplied will be refused with an
123 "unwilling to perform" error.
125 The commands - except \fBabandon\fP and \fBunbind\fP - should output:
130 matched: <matched DN>
134 where only RESULT is mandatory.
135 The \fBsearch\fP RESULT should be preceded by the entries in LDIF
136 format, each entry followed by a blank line.
137 Lines starting with `#' or `DEBUG:' are ignored.
139 There is an example search script in the slapd/back-shell/ directory
140 in the OpenLDAP source tree.