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