git.sur5r.net Git - openldap/blob - doc/man/man5/slapd-shell.5

   1 .TH SLAPD-SHELL 5 "25 April 2002" "OpenLDAP LDVERSION"
   2 .\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapd-shell \- Shell backend to slapd
   7 .SH SYNOPSIS
   8 ETCDIR/slapd.conf
   9 .SH DESCRIPTION
  10 The Shell backend to
  11 .BR slapd (8)
  12 executes external programs to implement operations, and is designed to
  13 make it easy to tie an existing database to the
  14 .B slapd
  15 front-end.
  16 .SH CONFIGURATION
  17 The
  18 .BR slapd.conf (5)
  19 options in this category 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 .LP
  23 These options specify the pathname of the command to execute in response
  24 to the given LDAP operation.
  25 Note that you need only supply configuration lines for those commands you
  26 want the backend to handle.
  27 Operations for which a command is not supplied will be refused with an
  28 "unwilling to perform" error.
  29 .TP
  30 .B bind <pathname>
  31 .TP
  32 .B unbind <pathname>
  33 .TP
  34 .B search <pathname>
  35 .TP
  36 .B compare <pathname>
  37 .TP
  38 .B modify <pathname>
  39 .TP
  40 .B modrdn <pathname>
  41 .TP
  42 .B add <pathname>
  43 .TP
  44 .B delete <pathname>
  45 .TP
  46 .B abandon <pathname>
  47 .SH EXAMPLE
  48 There is a skeleton search script in the slapd/back-shell/ directory
  49 in the OpenLDAP source tree.
  50 .SH SEE ALSO
  51 .BR slapd.conf (5),
  52 .BR slapd (8),
  53 .BR sh (1).