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

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