ITS#4225 added proxyCacheQueries keyword

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

diff --git a/doc/man/man8/slapcat.8 b/doc/man/man8/slapcat.8
index 20e8369fa24a89008b8e97b689b74e2612a8e2b1..3cba0bb71927f625ec1b015c6d57be4a34057781 100644 (file)
--- a/doc/man/man8/slapcat.8
+++ b/doc/man/man8/slapcat.8
@@ -1,13 +1,21 @@
-.TH SLAPCAT 8C "17 August 1999" "OpenLDAP LDVERSION"
+.TH SLAPCAT 8C "RELEASEDATE" "OpenLDAP LDVERSION"
+.\" $OpenLDAP$
+.\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.
+.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 slapcat \- SLAPD database to LDIF utility
 .SH SYNOPSIS
 .B SBINDIR/slapcat
 .B [\-v]
+.B [\-c]
+.B [\-g]
 .B [\-d level]
 .B [\-b suffix]
 .B [\-n dbnum]
+.B [\-a filter]
+.B [\-s subtree-dn]
 .B [\-f slapd.conf]
+.B [\-F confdir]
 .B [\-l ldif-file]
 .B 
 .LP
@@ -19,20 +27,32 @@ 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.
+Databases configured as
+.B subordinate
+of this one are also output, unless \fB-g\fP is specified.
 .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.
+.TP
+.B \-g
+disable subordinate gluing.  Only the specified database will be
+processed, and not its glued subordinates (if any).
 .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" 
@@ -50,15 +70,46 @@ cannot be used in conjunction with the
 .B \-b
 option.
 .TP
+.BI \-a " filter"
+Only dump entries matching the asserted filter.
+For example
+
+slapcat -a \\
+    "(!(entryDN:dnSubtreeMatch:=ou=People,dc=example,dc=com))"
+
+will dump all but the "ou=People,dc=example,dc=com" subtree
+of the "dc=example,dc=com" database.
+.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
+.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, an attempt to read the
+default config directory will be made before trying to use the default
+config file. If a valid config directory exists then the
+default config file is ignored.
+.TP
 .BI \-l " ldif-file"
 Write LDIF to specified file instead of standard output.
-.SH Limitations
-Your
+.SH LIMITATIONS
+In general, your
 .BR slapd (8)
 should not be running (at least, not in read-write
 mode) when you do this to ensure consistency of the database.
@@ -78,8 +129,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.