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

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