mention new tools

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

diff --git a/doc/man/man8/slapcat.8 b/doc/man/man8/slapcat.8
index 54cfca15be0ca4819738babf261ce1a9478701ed..faa4fb468cad1bdffed4d3605f65800f703ce5a6 100644 (file)
--- a/doc/man/man8/slapcat.8
+++ b/doc/man/man8/slapcat.8
@@ -1,6 +1,6 @@
-.TH SLAPCAT 8C "17 August 1999" "OpenLDAP LDVERSION"
+.TH SLAPCAT 8C "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
-.\" Copyright 1998-1999 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2004 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 slapcat \- SLAPD database to LDIF utility
@@ -8,9 +8,12 @@ slapcat \- SLAPD database to LDIF utility
 .B SBINDIR/slapcat
 .B [\-v]
 .B [\-c]
+.B [\-k]
+.B [\-m]
 .B [\-d level]
 .B [\-b suffix]
 .B [\-n dbnum]
+.B [\-s subtree-dn]
 .B [\-f slapd.conf]
 .B [\-l ldif-file]
 .B 
@@ -23,23 +26,35 @@ is used to generate an LDAP Directory Interchange Format
 .BR slapd (8)
 database.
 It opens the given database determined by the database number or
-suffix and and writes the corresponding LDIF to standard output or
+suffix and writes the corresponding LDIF to standard output or
 the specified file.
 .LP
 The LDIF generated by this tool is suitable for use with
-.BR ldapadd (1)
-or
 .BR slapadd (8).
+As the entries are in database order, not superior first order,
+they cannot be loaded with
+.BR ldapadd (1)
+without first being reordered.
 .SH OPTIONS
 .TP
 .B \-v
-enable verbose mode.
+Enable verbose mode.
 .TP
 .B \-c
-enable continue (ignore errors) mode.
+Enable continue (ignore errors) mode.
+.TP
+.B \-k
+Include
+.B syncConsumerSubentry
+of the syncrepl consumer in the generated LDIF output.
+.TP
+.B \-m
+Include
+.B syncProviderSubentry
+of the syncrepl provider in the generated LDIF output.
 .TP
 .BI \-d " level"
-enable debugging messages as defined by the specified
+Enable debugging messages as defined by the specified
 .IR level .
 .TP
 .BI \-b " suffix" 
@@ -57,8 +72,16 @@ cannot be used in conjunction with the
 .B \-b
 option.
 .TP
+.BI \-s " subtree-dn"
+Only dump entries in the subtree specified by this DN.
+Implies `-b subtree-dn' if no
+.B \-b
+or
+.B \-n
+option is given.
+.TP
 .BI \-f " slapd.conf"
-specify an alternative
+Specify an alternative
 .BR slapd.conf (5)
 file.
 .TP
@@ -85,8 +108,10 @@ give the command:
 .BR slapadd (8),
 .BR ldapadd (1),
 .BR slapd (8)
+.LP
+"OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 .SH ACKNOWLEDGEMENTS
-.B     OpenLDAP
+.B OpenLDAP
 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
-.B     OpenLDAP
+.B OpenLDAP
 is derived from University of Michigan LDAP 3.3 Release.