external/bsd/openldap/man/slaptest.8

   1 .TH SLAPTEST 8C "2008/07/16" "OpenLDAP 2.4.11"
   2 .\" Copyright 2004-2008 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .SH NAME
   5 slaptest \- Check the suitability of the OpenLDAP slapd.conf file
   6 .SH SYNOPSIS
   7 .B /usr/sbin/slaptest
   8 .B [\-d level]
   9 .B [\-f slapd.conf]
  10 .B [\-F confdir]
  11 .B [\-o name[=value]]
  12 .B [\-Q]
  13 .B [\-u]
  14 .B [\-v]
  15 .LP
  16 .SH DESCRIPTION
  17 .LP
  18 .B Slaptest
  19 is used to check the conformance of the
  20 .BR slapd.conf (5)
  21 configuration file.
  22 It opens the
  23 .BR slapd.conf (5)
  24 configuration file, and parses it according to the general
  25 and the backend-specific rules, checking its sanity.
  26 .LP
  27 .SH OPTIONS
  28 .TP
  29 .BI \-d " level"
  30 enable debugging messages as defined by the specified
  31 .IR level ;
  32 see
  33 .BR slapd (8)
  34 for details.
  35 .TP
  36 .BI \-f " slapd.conf"
  37 specify an alternative
  38 .BR slapd.conf (5)
  39 file.
  40 .TP
  41 .BI \-F " confdir"
  42 specify a config directory.
  43 If both
  44 .B -f
  45 and
  46 .B -F
  47 are specified, the config file will be read and converted to
  48 config directory format and written to the specified directory.
  49 If neither option is specified, slaptest will attempt to read the
  50 default config directory before trying to use the default
  51 config file. If a valid config directory exists then the
  52 default config file is ignored. If dryrun mode is also specified,
  53 no conversion will occur.
  54 .TP
  55 .BI \-o " option[=value]"
  56 Specify an
  57 .BR option
  58 with a(n optional)
  59 .BR value .
  60 Possible generic options/values are:
  61 .LP
  62 .nf
  63               syslog=<subsystems>  (see `\-s' in slapd(8))
  64               syslog-level=<level> (see `\-S' in slapd(8))
  65               syslog-user=<user>   (see `\-l' in slapd(8))
  66
  67 .fi
  68 .TP
  69 .BI \-Q
  70 Be extremely quiet: only the exit code indicates success (0) or not
  71 (any other value).
  72 .TP
  73 .BI \-u
  74 enable dryrun mode (i.e. don't fail if databases cannot be opened,
  75 but config is fine).
  76 .TP
  77 .BI \-v
  78 enable verbose mode.
  79 .SH EXAMPLES
  80 To check a
  81 .BR slapd.conf (5)
  82 give the command:
  83 .LP
  84 .nf
  85 .ft tt
  86         /usr/sbin/slaptest -f //etc/openldap/slapd.conf -v
  87 .ft
  88 .fi
  89 .SH "SEE ALSO"
  90 .BR ldap (3),
  91 .BR slapd (8)
  92 .BR slapdn (8)
  93 .LP
  94 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
  95 .SH ACKNOWLEDGEMENTS
  96 .\" Shared Project Acknowledgement Text
  97 .B "OpenLDAP Software"
  98 is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>.
  99 .B "OpenLDAP Software"
 100 is derived from University of Michigan LDAP 3.3 Release.