2002-05-01 12:38:30 -04:00
|
|
|
.TH SLAPD-SHELL 5 "30 April 2002" "OpenLDAP LDVERSION"
|
2002-04-29 16:24:29 -04:00
|
|
|
.\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved.
|
|
|
|
|
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
|
|
|
|
|
.\" $OpenLDAP$
|
|
|
|
|
.SH NAME
|
|
|
|
|
slapd-shell \- Shell backend to slapd
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
ETCDIR/slapd.conf
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
The Shell backend to
|
|
|
|
|
.BR slapd (8)
|
|
|
|
|
executes external programs to implement operations, and is designed to
|
|
|
|
|
make it easy to tie an existing database to the
|
|
|
|
|
.B slapd
|
|
|
|
|
front-end.
|
|
|
|
|
.SH CONFIGURATION
|
2002-05-01 12:38:30 -04:00
|
|
|
These
|
|
|
|
|
.B slapd.conf
|
|
|
|
|
options apply to the SHELL backend database.
|
2002-04-29 16:24:29 -04:00
|
|
|
That is, they must follow a "database shell" line and come before any
|
|
|
|
|
subsequent "backend" or "database" lines.
|
2002-05-01 12:38:30 -04:00
|
|
|
Other database options are described in the
|
|
|
|
|
.BR slapd.conf (5)
|
|
|
|
|
manual page.
|
2002-04-29 16:24:29 -04:00
|
|
|
.TP
|
2002-05-01 12:38:30 -04:00
|
|
|
.B bind <pathname>
|
2002-04-29 16:24:29 -04:00
|
|
|
.TP
|
2002-05-01 12:38:30 -04:00
|
|
|
.B unbind <pathname>
|
2002-04-29 16:24:29 -04:00
|
|
|
.TP
|
2002-05-01 12:38:30 -04:00
|
|
|
.B search <pathname>
|
2002-04-29 16:24:29 -04:00
|
|
|
.TP
|
2002-05-01 12:38:30 -04:00
|
|
|
.B compare <pathname>
|
2002-04-29 16:24:29 -04:00
|
|
|
.TP
|
2002-05-01 12:38:30 -04:00
|
|
|
.B modify <pathname>
|
2002-04-29 16:24:29 -04:00
|
|
|
.TP
|
2002-05-01 12:38:30 -04:00
|
|
|
.B modrdn <pathname>
|
2002-04-29 16:24:29 -04:00
|
|
|
.TP
|
2002-05-01 12:38:30 -04:00
|
|
|
.B add <pathname>
|
2002-04-29 16:24:29 -04:00
|
|
|
.TP
|
2002-05-01 12:38:30 -04:00
|
|
|
.B delete <pathname>
|
2002-04-29 16:24:29 -04:00
|
|
|
.TP
|
2002-05-01 12:38:30 -04:00
|
|
|
.B abandon <pathname>
|
|
|
|
|
These options specify the pathname of the command to execute in response
|
|
|
|
|
to the given LDAP operation.
|
|
|
|
|
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.
|
2002-04-29 16:24:29 -04:00
|
|
|
.SH EXAMPLE
|
|
|
|
|
There is a skeleton search script in the slapd/back-shell/ directory
|
|
|
|
|
in the OpenLDAP source tree.
|
2002-05-01 12:38:30 -04:00
|
|
|
.SH FILES
|
|
|
|
|
ETCDIR/slapd.conf
|
2002-04-29 16:24:29 -04:00
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR slapd.conf (5),
|
|
|
|
|
.BR slapd (8),
|
|
|
|
|
.BR sh (1).
|