]> git.sur5r.net Git - openldap/blob - doc/man/man8/slaptest.8
Add comment
[openldap] / doc / man / man8 / slaptest.8
1 .TH SLAPTEST 8C "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 2004-2006 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 [\-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 .TP
32 .BI \-f " slapd.conf"
33 specify an alternative
34 .BR slapd.conf (5)
35 file.
36 .TP
37 .BI \-F " confdir"
38 specify a config directory.
39 If both
40 .B -f
41 and
42 .B -F
43 are specified, the config file will be read and converted to
44 config directory format and written to the specified directory.
45 If neither option is specified, slaptest will attempt to read the
46 default config directory before trying to use the default
47 config file. If a valid config directory exists then the
48 default config file is ignored. If dryrun mode is also specified,
49 no conversion will occur.
50 .TP
51 .BI \-o " option[=value]"
52 Specify an
53 .BR option
54 with a(n optional)
55 .BR value .
56 Possible generic options/values are:
57 .LP
58 .nf
59               syslog=<subsystems>  (see `\-s' in slapd(8))
60               syslog-level=<level> (see `\-S' in slapd(8))
61               syslog-user=<user>   (see `\-l' in slapd(8))
62
63 .fi
64 .TP
65 .B \-u
66 enable dryrun mode (i.e. don't fail if databases cannot be opened,
67 but config is fine).
68 .TP
69 .B \-v
70 enable verbose mode.
71 .SH EXAMPLES
72 To check a 
73 .BR slapd.conf (5)
74 give the command:
75 .LP
76 .nf
77 .ft tt
78         SBINDIR/slaptest -f /ETCDIR/slapd.conf -v
79 .ft
80 .fi
81 .SH "SEE ALSO"
82 .BR ldap (3),
83 .BR slapd (8)
84 .BR slapdn (8)
85 .LP
86 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
87 .SH ACKNOWLEDGEMENTS
88 .so ../Project