]> git.sur5r.net Git - openldap/blob - doc/man/man8/slaptest.8
Sync with HEAD
[openldap] / doc / man / man8 / slaptest.8
1 .TH SLAPTEST 8C "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 2004-2005 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
4 .SH NAME
5 slaptest \- Check the suitability of the 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 [\-u]
12 .B [\-v]
13 .LP
14 .SH DESCRIPTION
15 .LP
16 .B Slaptest
17 is used to check the conformance of the
18 .BR slapd.conf (5)
19 configurtion file.
20 It opens the
21 .BR slapd.conf (5)
22 configuration file, and parses it according to the general 
23 and the backend-specific rules, checking its sanity.
24 .LP
25 .SH OPTIONS
26 .TP
27 .BI \-d " level"
28 enable debugging messages as defined by the specified
29 .IR level .
30 .TP
31 .BI \-f " slapd.conf"
32 specify an alternative
33 .BR slapd.conf (5)
34 file.
35 .TP
36 .BI \-F " confdir"
37 specify a config directory.
38 If both
39 .B -f
40 and
41 .B -F
42 are specified, the config file will be read and converted to
43 config directory format and written to the specified directory.
44 If neither option is specified, slaptest will attempt to read the
45 default config directory before trying to use the default
46 config file. If a valid config directory exists then the
47 default config file is ignored. If dryrun mode is also specified,
48 no conversion will occur. All of the slap tools that
49 use the config options observe this same behavior.
50 .TP
51 .B \-u
52 enable dryrun mode (i.e. don't fail if databases cannot be opened,
53 but config is fine).
54 .TP
55 .B \-v
56 enable verbose mode.
57 .SH EXAMPLES
58 To check a 
59 .BR slapd.conf (5)
60 give the command:
61 .LP
62 .nf
63 .ft tt
64         SBINDIR/slaptest -f /ETCDIR/slapd.conf -v
65 .ft
66 .fi
67 .SH "SEE ALSO"
68 .BR ldap (3),
69 .BR slapd (8)
70 .BR slapdn (8)
71 .LP
72 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
73 .SH ACKNOWLEDGEMENTS
74 .B OpenLDAP
75 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
76 .B OpenLDAP
77 is derived from University of Michigan LDAP 3.3 Release.