openldap/doc/man/man8/slaptest.8
2008-01-08 00:19:56 +00:00

97 lines
2.1 KiB
Groff

.TH SLAPTEST 8C "RELEASEDATE" "OpenLDAP LDVERSION"
.\" Copyright 2004-2008 The OpenLDAP Foundation All Rights Reserved.
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
.SH NAME
slaptest \- Check the suitability of the OpenLDAP slapd.conf file
.SH SYNOPSIS
.B SBINDIR/slaptest
.B [\-d level]
.B [\-f slapd.conf]
.B [\-F confdir]
.B [\-o name[=value]]
.B [\-Q]
.B [\-u]
.B [\-v]
.LP
.SH DESCRIPTION
.LP
.B Slaptest
is used to check the conformance of the
.BR slapd.conf (5)
configuration file.
It opens the
.BR slapd.conf (5)
configuration file, and parses it according to the general
and the backend-specific rules, checking its sanity.
.LP
.SH OPTIONS
.TP
.BI \-d " level"
enable debugging messages as defined by the specified
.IR level ;
see
.BR slapd (8)
for details.
.TP
.BI \-f " slapd.conf"
specify an alternative
.BR slapd.conf (5)
file.
.TP
.BI \-F " confdir"
specify a config directory.
If both
.B -f
and
.B -F
are specified, the config file will be read and converted to
config directory format and written to the specified directory.
If neither option is specified, slaptest will attempt to read the
default config directory before trying to use the default
config file. If a valid config directory exists then the
default config file is ignored. If dryrun mode is also specified,
no conversion will occur.
.TP
.BI \-o " option[=value]"
Specify an
.BR option
with a(n optional)
.BR value .
Possible generic options/values are:
.LP
.nf
syslog=<subsystems> (see `\-s' in slapd(8))
syslog-level=<level> (see `\-S' in slapd(8))
syslog-user=<user> (see `\-l' in slapd(8))
.fi
.TP
.BI \-Q
Be extremely quiet: only the exit code indicates success (0) or not
(any other value).
.TP
.BI \-u
enable dryrun mode (i.e. don't fail if databases cannot be opened,
but config is fine).
.TP
.BI \-v
enable verbose mode.
.SH EXAMPLES
To check a
.BR slapd.conf (5)
give the command:
.LP
.nf
.ft tt
SBINDIR/slaptest -f /ETCDIR/slapd.conf -v
.ft
.fi
.SH "SEE ALSO"
.BR ldap (3),
.BR slapd (8)
.BR slapdn (8)
.LP
"OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
.SH ACKNOWLEDGEMENTS
.so ../Project