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

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

diff --git a/doc/man/man8/slapcat.8 b/doc/man/man8/slapcat.8
index 70954fe6636c218af1765f3580e7193c3ce13dcf..9191be7eeee10383969664759a8d86607b9ad4cb 100644 (file)
--- a/doc/man/man8/slapcat.8
+++ b/doc/man/man8/slapcat.8
@@ -1,21 +1,37 @@
 .TH SLAPCAT 8C "RELEASEDATE" "OpenLDAP LDVERSION"
 .TH SLAPCAT 8C "RELEASEDATE" "OpenLDAP LDVERSION"

-.\" $OpenLDAP$
-.\" Copyright 1998-2005 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2013 The OpenLDAP Foundation All Rights Reserved.

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

+.\" $OpenLDAP$

 .SH NAME
 slapcat \- SLAPD database to LDIF utility
 .SH SYNOPSIS
 .B SBINDIR/slapcat
 .SH NAME
 slapcat \- SLAPD database to LDIF utility
 .SH SYNOPSIS
 .B SBINDIR/slapcat

-.B [\-v]
-.B [\-c]
-.B [\-d level]
-.B [\-b suffix]
-.B [\-n dbnum]
-.B [\-a filter]
-.B [\-s subtree-dn]
-.B [\-f slapd.conf]
-.B [\-l ldif-file]
-.B 
+[\c
+.BI \-a filter\fR]
+[\c
+.BI \-b suffix\fR]
+[\c
+.BR \-c ]
+[\c
+.BI \-d debug-level\fR]
+[\c
+.BI \-f slapd.conf\fR]
+[\c
+.BI \-F confdir\fR]
+[\c
+.BR \-g ]
+[\c
+.BI \-H URI\fR]
+[\c
+.BI \-l ldif-file\fR]
+[\c
+.BI \-n dbnum\fR]
+[\c
+.BI \-o option\fR[ = value\fR]]
+[\c
+.BI \-s subtree-dn\fR]
+[\c
+.BR \-v ]

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


@@ -27,73 +43,143 @@ database.
 It opens the given database determined by the database number or
 suffix and writes the corresponding LDIF to standard output or
 the specified file.
 It opens the given database determined by the database number or
 suffix and writes the corresponding LDIF to standard output or
 the specified file.

-Subordinate databases glued with
-.BR slapo-glue (5)
-are also output.
+Databases configured as
+.B subordinate
+of this one are also output, unless \fB\-g\fP is specified.
+.LP
+The entry records are presented in database order, not superior first
+order.  The entry records will include all (user and operational)
+attributes stored in the database.  The entry records will not include
+dynamically generated attributes (such as subschemaSubentry).

 .LP
 .LP

-The LDIF generated by this tool is suitable for use with
+The output of slapcat is intended to be used as input to

 .BR slapadd (8).
 .BR slapadd (8).

-As the entries are in database order, not superior first order,
-they cannot be loaded with
+The output of slapcat cannot generally be used as input to

 .BR ldapadd (1)
 .BR ldapadd (1)

-without first being reordered.
+or other LDAP clients without first editing the output.
+This editing would normally include reordering the records
+into superior first order and removing no-user-modification
+operational attributes.

 .SH OPTIONS
 .TP
 .SH OPTIONS
 .TP

-.B \-v
-Enable verbose mode.
+.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.
+Deprecated; use \fB-H\fP \fIldap:///???(filter)\fP instead.
+.TP
+.BI \-b \ suffix 
+Use the specified \fIsuffix\fR to determine which database to
+generate output for.  The \fB\-b\fP cannot be used in conjunction
+with the
+.B \-n
+option.

 .TP
 .B \-c
 Enable continue (ignore errors) mode.
 .TP
 .B \-c
 Enable continue (ignore errors) mode.

+Multiple occorrences of
+.B \-c
+make
+.BR slapcat (8)
+try harder.

 .TP
 .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 \-b " suffix" 
-Use the specified \fIsuffix\fR to determine which database to
-generate output for.  The \-b cannot be used in conjunction
-with the
-.B \-n
-option.
+.BI \-f \ slapd.conf
+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
+.B \-g
+disable subordinate gluing.  Only the specified database will be
+processed, and not its glued subordinates (if any).
+.TP
+.B \-H \ URI
+use dn, scope and filter from URI to only handle matching entries.
+.TP
+.BI \-l \ ldif-file
+Write LDIF to specified file instead of standard output.

 .TP
 .TP

-.BI \-n " dbnum"
-Generate output for the \fIdbnum\fR\-th database listed in the
-configuration file.  The
+.BI \-n \ dbnum
+Generate output for the \fIdbnum\fR-th database listed in the
+configuration file. The config database
+.BR slapd\-config (5),
+is always the first database, so use
+.B \-n 0
+to select it.
+
+The

 .B \-n
 cannot be used in conjunction with the
 .B \-b
 option.
 .TP
 .B \-n
 cannot be used in conjunction with the
 .B \-b
 option.
 .TP

-.BI \-a " filter"
-Only dump entries matching the asserted filter.
-For example
+.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))

 
 

-slapcat -a \\
-    "(!(entryDN:dnSubtreeMatch:=ou=People,dc=example,dc=com))"
+              ldif-wrap={no|<n>}

 
 

-will dump all but the "ou=People,dc=example,dc=com" subtree
-of the "dc=example,dc=com" database.
+.in
+\fIn\fP is the number of columns allowed for the LDIF output
+(\fIn\fP equal to \fI0\fP uses the default, corresponding to 76).
+Use \fIno\fP for no wrap.

 .TP
 .TP

-.BI \-s " subtree-dn"
+.BI \-s \ subtree-dn

 Only dump entries in the subtree specified by this DN.
 Only dump entries in the subtree specified by this DN.

-Implies `-b subtree-dn' if no
+Implies \fB\-b\fP \fIsubtree-dn\fP if no

 .B \-b
 or
 .B \-n
 option is given.
 .B \-b
 or
 .B \-n
 option is given.

+Deprecated; use \fB-H\fP \fIldap:///subtree-dn\fP instead.

 .TP
 .TP

-.BI \-f " slapd.conf"
-Specify an alternative
-.BR slapd.conf (5)
-file.
-.TP
-.BI \-l " ldif-file"
-Write LDIF to specified file instead of standard output.
+.B \-v
+Enable verbose mode.

 .SH LIMITATIONS
 .SH LIMITATIONS

-In general, your
+For some backend types, your

 .BR slapd (8)
 should not be running (at least, not in read-write
 .BR slapd (8)
 should not be running (at least, not in read-write

-mode) when you do this to ensure consistency of the database.
+mode) when you do this to ensure consistency of the database. It is
+always safe to run 
+.B slapcat
+with the
+.BR slapd\-bdb (5),
+.BR slapd\-hdb (5),
+and
+.BR slapd\-null (5)
+backends.

 .SH EXAMPLES
 To make a text backup of your SLAPD database and put it in a file called
 .BR ldif ,
 .SH EXAMPLES
 To make a text backup of your SLAPD database and put it in a file called
 .BR ldif ,


@@ -101,7 +187,7 @@ give the command:
 .LP
 .nf
 .ft tt
 .LP
 .nf
 .ft tt

-       SBINDIR/slapcat -l ldif
+       SBINDIR/slapcat \-l ldif

 .ft
 .fi
 .SH "SEE ALSO"
 .ft
 .fi
 .SH "SEE ALSO"


@@ -113,7 +199,4 @@ give the command:
 .LP
 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 .SH ACKNOWLEDGEMENTS
 .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