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

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