]> git.sur5r.net Git - openldap/commitdiff
document new tools
authorPierangelo Masarati <ando@openldap.org>
Thu, 18 Mar 2004 00:07:24 +0000 (00:07 +0000)
committerPierangelo Masarati <ando@openldap.org>
Thu, 18 Mar 2004 00:07:24 +0000 (00:07 +0000)
doc/man/man8/slapdn.8 [new file with mode: 0644]
doc/man/man8/slaptest.8 [new file with mode: 0644]

diff --git a/doc/man/man8/slapdn.8 b/doc/man/man8/slapdn.8
new file mode 100644 (file)
index 0000000..2d2a53f
--- /dev/null
@@ -0,0 +1,61 @@
+.TH SLAPDN 8C "RELEASEDATE" "OpenLDAP LDVERSION"
+.\" Copyright 2004 The OpenLDAP Foundation All Rights Reserved.
+.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
+.SH NAME
+slapdn \- Check a list of string-represented DNs based on schema syntax.
+.SH SYNOPSIS
+.B SBINDIR/slapdn
+.B [\-v]
+.B [\-d level]
+.B [\-f slapd.conf]
+.B DN [...]
+.LP
+.SH DESCRIPTION
+.LP
+.B Slapdn
+is used to check the conformance of a DN based on the schema
+defined in
+.BR slapd (8)
+and that loaded via 
+.BR slapd.conf (5).
+It opens the
+.BR slapd.conf (5)
+configuration file, reads in the schema definitions, and then
+parses the 
+.B DN
+list given on the command-line.
+.LP
+.SH OPTIONS
+.TP
+.B \-v
+enable verbose mode.
+.TP
+.BI \-d " level"
+enable debugging messages as defined by the specified
+.IR level .
+.TP
+.BI \-f " slapd.conf"
+specify an alternative
+.BR slapd.conf (5)
+file.
+.SH EXAMPLES
+To check a
+.B DN
+give the command:
+.LP
+.nf
+.ft tt
+       SBINDIR/slapdn -f /ETCDIR/slapd.conf -v DN
+.ft
+.fi
+.SH "SEE ALSO"
+.BR ldap (3),
+.BR slapd (8)
+.BR slaptest (8)
+.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.  
diff --git a/doc/man/man8/slaptest.8 b/doc/man/man8/slaptest.8
new file mode 100644 (file)
index 0000000..f01ba04
--- /dev/null
@@ -0,0 +1,56 @@
+.TH SLAPTEST 8C "RELEASEDATE" "OpenLDAP LDVERSION"
+.\" Copyright 2004 The OpenLDAP Foundation All Rights Reserved.
+.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
+.SH NAME
+slaptest \- Check the suitability of the slapd.conf file.
+.SH SYNOPSIS
+.B SBINDIR/slaptest
+.B [\-v]
+.B [\-d level]
+.B [\-f slapd.conf]
+.LP
+.SH DESCRIPTION
+.LP
+.B Slaptest
+is used to check the conformance of the
+.BR slapd.conf (5)
+configurtion 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
+.B \-v
+enable verbose mode.
+.TP
+.BI \-d " level"
+enable debugging messages as defined by the specified
+.IR level .
+.TP
+.BI \-f " slapd.conf"
+specify an alternative
+.BR slapd.conf (5)
+file.
+.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
+.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.