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