git.sur5r.net Git - openldap/blob - doc/man/man8/slapcat.8

   1 .TH SLAPCAT 8C "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2004 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 slapcat \- SLAPD database to LDIF utility
   7 .SH SYNOPSIS
   8 .B SBINDIR/slapcat
   9 .B [\-v]
  10 .B [\-c]
  11 .B [\-k]
  12 .B [\-m]
  13 .B [\-d level]
  14 .B [\-b suffix]
  15 .B [\-n dbnum]
  16 .B [\-s subtree-dn]
  17 .B [\-f slapd.conf]
  18 .B [\-l ldif-file]
  19 .B
  20 .LP
  21 .SH DESCRIPTION
  22 .LP
  23 .B Slapcat
  24 is used to generate an LDAP Directory Interchange Format
  25 (LDIF) output based upon the contents of a
  26 .BR slapd (8)
  27 database.
  28 It opens the given database determined by the database number or
  29 suffix and writes the corresponding LDIF to standard output or
  30 the specified file.
  31 .LP
  32 The LDIF generated by this tool is suitable for use with
  33 .BR slapadd (8).
  34 As the entries are in database order, not superior first order,
  35 they cannot be loaded with
  36 .BR ldapadd (1)
  37 without first being reordered.
  38 .SH OPTIONS
  39 .TP
  40 .B \-v
  41 Enable verbose mode.
  42 .TP
  43 .B \-c
  44 Enable continue (ignore errors) mode.
  45 .TP
  46 .B \-k
  47 Include
  48 .B syncConsumerSubentry
  49 of the syncrepl consumer in the generated LDIF output.
  50 .TP
  51 .B \-m
  52 Include
  53 .B syncProviderSubentry
  54 of the syncrepl provider in the generated LDIF output.
  55 .TP
  56 .BI \-d " level"
  57 Enable debugging messages as defined by the specified
  58 .IR level .
  59 .TP
  60 .BI \-b " suffix"
  61 Use the specified \fIsuffix\fR to determine which database to
  62 generate output for.  The \-b cannot be used in conjunction
  63 with the
  64 .B \-n
  65 option.
  66 .TP
  67 .BI \-n " dbnum"
  68 Generate output for the \fIdbnum\fR\-th database listed in the
  69 configuration file.  The
  70 .B \-n
  71 cannot be used in conjunction with the
  72 .B \-b
  73 option.
  74 .TP
  75 .BI \-s " subtree-dn"
  76 Only dump entries in the subtree specified by this DN.
  77 Implies `-b subtree-dn' if no
  78 .B \-b
  79 or
  80 .B \-n
  81 option is given.
  82 .TP
  83 .BI \-f " slapd.conf"
  84 Specify an alternative
  85 .BR slapd.conf (5)
  86 file.
  87 .TP
  88 .BI \-l " ldif-file"
  89 Write LDIF to specified file instead of standard output.
  90 .SH Limitations
  91 Your
  92 .BR slapd (8)
  93 should not be running (at least, not in read-write
  94 mode) when you do this to ensure consistency of the database.
  95 .SH EXAMPLES
  96 To make a text backup of your SLAPD database and put it in a file called
  97 .BR ldif ,
  98 give the command:
  99 .LP
 100 .nf
 101 .ft tt
 102         SBINDIR/slapcat -l ldif
 103 .ft
 104 .fi
 105 .SH "SEE ALSO"
 106 .BR ldap (3),
 107 .BR ldif (5),
 108 .BR slapadd (8),
 109 .BR ldapadd (1),
 110 .BR slapd (8)
 111 .LP
 112 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 113 .SH ACKNOWLEDGEMENTS
 114 .B OpenLDAP
 115 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 116 .B OpenLDAP
 117 is derived from University of Michigan LDAP 3.3 Release.