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