ITS#2906: report invalid userPassword schemes, clarify documentation

[openldap] / doc / man / man5 / slapd-shell.5

diff --git a/doc/man/man5/slapd-shell.5 b/doc/man/man5/slapd-shell.5
index 0beee6d65781911b3c1ea7457c2c91e5e9d55250..24d217b2143bb908be38724a81dd2c665339f6ba 100644 (file)
--- a/doc/man/man5/slapd-shell.5
+++ b/doc/man/man5/slapd-shell.5
@@ -1,5 +1,5 @@
-.TH SLAPD-SHELL 5 "2 May 2002" "OpenLDAP LDVERSION"
-.\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved.
+.TH SLAPD-SHELL 5 "RELEASEDATE" "OpenLDAP LDVERSION"
+.\" Copyright 1998-2004 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .\" $OpenLDAP$
 .SH NAME
@@ -13,12 +13,12 @@ executes external programs to implement operations, and is designed to
 make it easy to tie an existing database to the
 .B slapd
 front-end.
+.LP
+This backend is is primarily intended to be used in prototypes.
 .SH WARNING
-.B "This backend's calling conventions have changed since OpenLDAP 2.0."
-The operations receive a new "opid:" (operation ID) line, to be used
-instead of "msgid:".
-The "msgid:" line will be removed in a future version.
-Also, abandon now gets a new "abandonid:" line.
+The
+.B abandon
+shell command has been removed since OpenLDAP 2.1.
 .SH CONFIGURATION
 These
 .B slapd.conf
@@ -33,20 +33,10 @@ These options specify the pathname and arguments of the program to
 execute in response to the given LDAP operation.
 Each option is followed by the input lines that the program receives:
 .TP
-.B abandon  <pathname> <argument>...
-.nf
-ABANDON
-opid: <operation ID>
-msgid: <message ID of operation to abandon>
-<repeat { "suffix:" <database suffix DN> }>
-abandonid: <operation ID of operation to abandon>
-.fi
-.TP
 .B add      <pathname> <argument>...
 .nf
 ADD
-opid: <operation ID>
-msgid: <message ID>
+msgid: <message id>
 <repeat { "suffix:" <database suffix DN> }>
 <entry in LDIF format>
 .fi
@@ -54,8 +44,7 @@ msgid: <message ID>
 .B bind     <pathname> <argument>...
 .nf
 BIND
-opid: <operation ID>
-msgid: <message ID>
+msgid: <message id>
 <repeat { "suffix:" <database suffix DN> }>
 dn: <DN>
 method: <method number>
@@ -66,8 +55,7 @@ cred: <credentials>
 .B compare  <pathname> <argument>...
 .nf
 COMPARE
-opid: <operation ID>
-msgid: <message ID>
+msgid: <message id>
 <repeat { "suffix:" <database suffix DN> }>
 dn: <DN>
 <attribute>: <value>
@@ -76,8 +64,7 @@ dn: <DN>
 .B delete   <pathname> <argument>...
 .nf
 DELETE
-opid: <operation ID>
-msgid: <message ID>
+msgid: <message id>
 <repeat { "suffix:" <database suffix DN> }>
 dn: <DN>
 .fi
@@ -85,8 +72,7 @@ dn: <DN>
 .B modify   <pathname> <argument>...
 .nf
 MODIFY
-opid: <operation ID>
-msgid: <message ID>
+msgid: <message id>
 <repeat { "suffix:" <database suffix DN> }>
 dn: <DN>
 <repeat {
@@ -99,8 +85,7 @@ dn: <DN>
 .B modrdn   <pathname> <argument>...
 .nf
 MODRDN
-opid: <operation ID>
-msgid: <message ID>
+msgid: <message id>
 <repeat { "suffix:" <database suffix DN> }>
 dn: <DN>
 newrdn: <new RDN>
@@ -111,8 +96,7 @@ deleteoldrdn: <0 or 1>
 .B search   <pathname> <argument>...
 .nf
 SEARCH
-opid: <operation ID>
-msgid: <message ID>
+msgid: <message id>
 <repeat { "suffix:" <database suffix DN> }>
 base: <base DN>
 scope: <0-2, see ldap.h>
@@ -127,22 +111,17 @@ attrs: <"all" or space-separated attribute list>
 .B unbind   <pathname> <argument>...
 .nf
 UNBIND
-opid: <operation ID>
-msgid: <message ID>
+msgid: <message id>
 <repeat { "suffix:" <database suffix DN> }>
 dn: <bound DN>
 .fi
 .LP
-An
-.I operation ID
-is a "connection ID/message ID" string identifying an operation.
-.LP
 Note that you need only supply configuration lines for those commands you
 want the backend to handle.
 Operations for which a command is not supplied will be refused with an
 "unwilling to perform" error.
 .LP
-The commands - except \fBabandon\fP and \fBunbind\fP - should output:
+The commands - except \fBunbind\fP - should output:
 .RS
 .nf
 RESULT
@@ -158,6 +137,12 @@ Lines starting with `#' or `DEBUG:' are ignored.
 .SH EXAMPLE
 There is an example search script in the slapd/back-shell/ directory
 in the OpenLDAP source tree.
+.SH LIMITATIONS
+The shell backend does not support threaded environments.
+When using the shell backend, 
+.BR slapd (8)
+should be built
+.IR --without-threads .
 .SH FILES
 .TP
 ETCDIR/slapd.conf