Merge remote-tracking branch 'origin/mdb.master' into OPENLDAP_REL_ENG_2_4

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

diff --git a/doc/man/man8/slapdn.8 b/doc/man/man8/slapdn.8
index 01513f2ee5de538c8e257f373503d98b0b27a02c..7a039ff49792b27d721d591c558b9df4aebbf3d6 100644 (file)
--- a/doc/man/man8/slapdn.8
+++ b/doc/man/man8/slapdn.8
@@ -1,16 +1,24 @@
 .TH SLAPDN 8C "RELEASEDATE" "OpenLDAP LDVERSION"
 .TH SLAPDN 8C "RELEASEDATE" "OpenLDAP LDVERSION"

-.\" Copyright 2004-2006 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 2004-2013 The OpenLDAP Foundation All Rights Reserved.

 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.

+.\" $OpenLDAP$

 .SH NAME
 .SH NAME

-slapdn \- Check a list of string-represented DNs based on schema syntax.
+slapdn \- Check a list of string-represented LDAP DNs based on schema syntax

 .SH SYNOPSIS
 .B SBINDIR/slapdn
 .SH SYNOPSIS
 .B SBINDIR/slapdn

-.B [\-v]
-.B [\-d level]
-.B [\-f slapd.conf]
-.B [\-F confdir]
-.B [\-N | \-P]
-.B DN [...]
+[\c
+.BI \-d \ debug-level\fR]
+[\c
+.BI \-f \ slapd.conf\fR]
+[\c
+.BI \-F \ confdir\fR]
+[\c
+.BR \-N | \-P ]
+[\c
+.BI \-o \ option\fR[ = value\fR]]
+[\c
+.BR \-v ]
+.IR DN \ [...]

 .LP
 .SH DESCRIPTION
 .LP
 .LP
 .SH DESCRIPTION
 .LP


@@ -22,31 +30,31 @@ and that loaded via
 .BR slapd.conf (5).
 It opens the
 .BR slapd.conf (5)
 .BR slapd.conf (5).
 It opens the
 .BR slapd.conf (5)

-configuration file, reads in the schema definitions, and then
+configuration file or the slapd\-config (5) backend, reads in the schema definitions, and then

 parses the 
 parses the 

-.B DN
+.I DN

 list given on the command-line.
 .LP
 .SH OPTIONS
 .TP
 list given on the command-line.
 .LP
 .SH OPTIONS
 .TP

-.B \-v
-enable verbose mode.
-.TP
-.BI \-d " level"
+.BI \-d \ debug-level

 enable debugging messages as defined by the specified
 enable debugging messages as defined by the specified

-.IR level .
+.IR debug-level ;
+see
+.BR slapd (8)
+for details.

 .TP
 .TP

-.BI \-f " slapd.conf"
+.BI \-f \ slapd.conf

 specify an alternative
 .BR slapd.conf (5)
 file.
 .TP
 specify an alternative
 .BR slapd.conf (5)
 file.
 .TP

-.BI \-F " confdir"
+.BI \-F \ confdir

 specify a config directory.
 If both
 specify a config directory.
 If both

-.B -f
+.B \-f

 and
 and

-.B -F
+.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, an attempt to read the
 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, an attempt to read the


@@ -55,14 +63,31 @@ config file. If a valid config directory exists then the
 default config file is ignored.
 .TP
 .BI \-N
 default config file is ignored.
 .TP
 .BI \-N

-only output a normalized form of the DN, suitable to be used
+only output a normalized form of the \fIDN\fP, suitable to be used

 in a normalization tool; incompatible with
 .BR \-P .
 .TP
 in a normalization tool; incompatible with
 .BR \-P .
 .TP

+.BI \-o \ option\fR[ = value\fR]
+Specify an
+.I option
+with a(n optional)
+.IR 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 \-P
 .BI \-P

-only output a prettified form of the DN, suitable to be used
+only output a prettified form of the \fIDN\fP, suitable to be used

 in a check and beautification tool; incompatible with
 .BR \-N .
 in a check and beautification tool; incompatible with
 .BR \-N .

+.TP
+.B \-v
+enable verbose mode.

 .SH EXAMPLES
 To check a
 .B DN
 .SH EXAMPLES
 To check a
 .B DN


@@ -70,17 +95,14 @@ give the command:
 .LP
 .nf
 .ft tt
 .LP
 .nf
 .ft tt

-       SBINDIR/slapdn -f /ETCDIR/slapd.conf -v DN
+       SBINDIR/slapdn \-f /ETCDIR/slapd.conf \-v DN

 .ft
 .fi
 .SH "SEE ALSO"
 .BR ldap (3),
 .ft
 .fi
 .SH "SEE ALSO"
 .BR ldap (3),

-.BR slapd (8)
+.BR slapd (8),

 .BR slaptest (8)
 .LP
 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 .SH ACKNOWLEDGEMENTS
 .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.  
+.so ../Project