.TH SLAPCAT 8C "RELEASEDATE" "OpenLDAP LDVERSION"
.\" $OpenLDAP$
.\" Copyright 1998-2004 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 [\-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 
.LP
.SH DESCRIPTION
.LP
.B Slapcat
is used to generate an LDAP Directory Interchange Format
(LDIF) output based upon the contents of a
.BR slapd (8)
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.
.LP
The LDIF generated by this tool is suitable for use with
.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.
.TP
.B \-c
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
.IR level .
.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.
.TP
.BI \-n " dbnum"
Generate output for the \fIdbnum\fR\-th database listed in the
configuration file.  The
.B \-n
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
.BR slapd.conf (5)
file.
.TP
.BI \-l " ldif-file"
Write LDIF to specified file instead of standard output.
.SH Limitations
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.
.SH EXAMPLES
To make a text backup of your SLAPD database and put it in a file called
.BR ldif ,
give the command:
.LP
.nf
.ft tt
	SBINDIR/slapcat -l ldif
.ft
.fi
.SH "SEE ALSO"
.BR ldap (3),
.BR ldif (5),
.BR slapadd (8),
.BR ldapadd (1),
.BR slapd (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.