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

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