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

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