git.sur5r.net Git - openldap/blob - doc/man/man8/slaptest.8

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