allow to customize the modifiersName of internal modifications (partially addresses...

[openldap] / doc / man / man8 / slaptest.8

diff --git a/doc/man/man8/slaptest.8 b/doc/man/man8/slaptest.8
index 50d30a67899e01540b317b18699d4031e04c29c5..36262e2f8b7b66d38f95d00b469620895fef10f3 100644 (file)
--- a/doc/man/man8/slaptest.8
+++ b/doc/man/man8/slaptest.8
@@ -1,13 +1,15 @@
 .TH SLAPTEST 8C "RELEASEDATE" "OpenLDAP LDVERSION"
-.\" Copyright 2004-2005 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 2004-2008 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
-slaptest \- Check the suitability of the slapd.conf file.
+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
@@ -16,7 +18,7 @@ slaptest \- Check the suitability of the slapd.conf file.
 .B Slaptest
 is used to check the conformance of the
 .BR slapd.conf (5)
-configurtion file.
+configuration file.
 It opens the
 .BR slapd.conf (5)
 configuration file, and parses it according to the general 
@@ -26,7 +28,10 @@ and the backend-specific rules, checking its sanity.
 .TP
 .BI \-d " level"
 enable debugging messages as defined by the specified
-.IR level .
+.IR level ;
+see
+.BR slapd (8)
+for details.
 .TP
 .BI \-f " slapd.conf"
 specify an alternative
@@ -35,12 +40,41 @@ 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
-.B \-u
+.BI \-u
 enable dryrun mode (i.e. don't fail if databases cannot be opened,
 but config is fine).
 .TP
-.B \-v
+.BI \-v
 enable verbose mode.
 .SH EXAMPLES
 To check a 
@@ -59,7 +93,4 @@ give the command:
 .LP
 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 .SH ACKNOWLEDGEMENTS
-.B OpenLDAP
-is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
-.B OpenLDAP
-is derived from University of Michigan LDAP 3.3 Release.  
+.so ../Project