← Back to branch summary

~ttx/openldap/lucid-gssapi-495418

« back to all changes in this revision

Viewing changes to doc/man/man8/slaptest.8

  • Committer: Bazaar Package Importer
  • Author(s): Steve Langasek
  • Date: 2009-07-28 10:17:15 UTC
  • mto: (0.3.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 16.
  • Revision ID: james.westby@ubuntu.com-20090728101715-g0isvetelfeqm48k
Tags: upstream-2.4.17
Import upstream version 2.4.17

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/man8/slaptest.8
1
1
.TH SLAPTEST 8C "RELEASEDATE" "OpenLDAP LDVERSION"
2
2
.\" Copyright 2004-2009 The OpenLDAP Foundation All Rights Reserved.
3
3
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
4
 
.\" $OpenLDAP: pkg/ldap/doc/man/man8/slaptest.8,v 1.7.2.9 2009/01/30 19:34:31 quanah Exp $
 
4
.\" $OpenLDAP: pkg/ldap/doc/man/man8/slaptest.8,v 1.7.2.10 2009/06/03 01:42:01 quanah Exp $
5
5
.SH NAME
6
6
slaptest \- Check the suitability of the OpenLDAP slapd.conf file
7
7
.SH SYNOPSIS
8
8
.B SBINDIR/slaptest
9
 
.B [\-d level]
10
 
.B [\-f slapd.conf]
11
 
.B [\-F confdir]
12
 
.B [\-o name[=value]]
13
 
.B [\-Q]
14
 
.B [\-u]
15
 
.B [\-v]
 
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 ]
16
23
.LP
17
24
.SH DESCRIPTION
18
25
.LP
23
30
It opens the
24
31
.BR slapd.conf (5)
25
32
configuration file or the 
26
 
.BR slapd-config (5) 
 
33
.BR slapd\-config (5) 
27
34
backend, and parses it according to the general and the backend-specific 
28
35
rules, checking its sanity.
29
36
.LP
30
37
.SH OPTIONS
31
38
.TP
32
 
.BI \-d " level"
 
39
.BI \-d \ debug-level
33
40
enable debugging messages as defined by the specified
34
 
.IR level ;
 
41
.IR debug-level ;
35
42
see
36
43
.BR slapd (8)
37
44
for details.
38
45
.TP
39
 
.BI \-f " slapd.conf"
 
46
.BI \-f \ slapd.conf
40
47
specify an alternative
41
48
.BR slapd.conf (5)
42
49
file.
43
50
.TP
44
 
.BI \-F " confdir"
 
51
.BI \-F \ confdir
45
52
specify a config directory.
46
53
If both
47
 
.B -f
 
54
.B \-f
48
55
and
49
 
.B -F
 
56
.B \-F
50
57
are specified, the config file will be read and converted to
51
58
config directory format and written to the specified directory.
52
59
If neither option is specified, slaptest will attempt to read the
53
60
default config directory before trying to use the default
54
61
config file. If a valid config directory exists then the
55
 
default config file is ignored. If dryrun mode is also specified,
 
62
default config file is ignored. If dry-run mode is also specified,
56
63
no conversion will occur.
57
64
.TP
58
 
.BI \-o " option[=value]"
 
65
.BI \-o \ option\fR[ = value\fR]
59
66
Specify an
60
 
.BR option
 
67
.I option
61
68
with a(n optional)
62
 
.BR value .
 
69
.IR value .
63
70
Possible generic options/values are:
64
71
.LP
65
72
.nf
66
73
              syslog=<subsystems>  (see `\-s' in slapd(8))
67
 
              syslog-level=<level> (see `\-S' in slapd(8))
68
 
              syslog-user=<user>   (see `\-l' in slapd(8))
 
74
              syslog\-level=<level> (see `\-S' in slapd(8))
 
75
              syslog\-user=<user>   (see `\-l' in slapd(8))
69
76
 
70
77
.fi
71
78
.TP
73
80
Be extremely quiet: only the exit code indicates success (0) or not 
74
81
(any other value).
75
82
.TP
76
 
.BI \-u
77
 
enable dryrun mode (i.e. don't fail if databases cannot be opened,
 
83
.B \-u
 
84
enable dry-run mode (i.e. don't fail if databases cannot be opened,
78
85
but config is fine).
79
86
.TP
80
87
.BI \-v
86
93
.LP
87
94
.nf
88
95
.ft tt
89
 
        SBINDIR/slaptest -f /ETCDIR/slapd.conf -v
 
96
        SBINDIR/slaptest \-f /ETCDIR/slapd.conf \-v
90
97
.ft
91
98
.fi
92
99
.SH "SEE ALSO"
93
100
.BR ldap (3),
94
 
.BR slapd (8)
 
101
.BR slapd (8),
95
102
.BR slapdn (8)
96
103
.LP
97
104
"OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)