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

   1 .TH LDIF2LDBM 8C "22 September 1998" "OpenLDAP LDVERSION"
   2 .SH NAME
   3 ldif2ldbm, ldif2index, ldif2id2entry, ldif2id2children \- LDIF to LDBM database format conversion utilities
   4 .SH SYNOPSIS
   5 .B SBINDIR/ldif2ldbm
   6 .B \-i ldif\-input\-file
   7 .B [\-d debug\-level] [\-f slapd\-config\-file]
   8 .B [\-j number\-of\-jobs]
   9 .LP
  10 .B SBINDIR/ldif2index
  11 .B \-i ldif\-input\-file
  12 .B [\-d debug\-level] [\-f slapd\-config\-file]
  13 .B attribute\-name
  14 .LP
  15 .B SBINDIR/ldif2id2entry
  16 .B \-i ldif\-input\-file
  17 .B [\-d debug\-level] [\-f slapd\-config\-file]
  18 .LP
  19 .B SBINDIR/ldif2id2children
  20 .B \-i ldif\-input\-file
  21 .B [\-d debug\-level] [\-f slapd\-config\-file]
  22 .LP
  23 .SH DESCRIPTION
  24 .LP
  25 These programs are used to convert a database in text LDIF LDAP
  26 Directory Interchange Format (LDIF) to an LDBM database suitable
  27 for use by
  28 .BR slapd (8).
  29 Normally, only
  30 .B ldif2ldbm
  31 is invoked by you. It will invoke the other programs as necessary.
  32 Occasionally, it may be necessary to invoke them by hand. For
  33 example, to create a new index file for an existing database, the
  34 .B ldif2index
  35 program can be invoked. The
  36 .BR ldbmcat (8)
  37 program is used to do the reverse conversion.
  38 .LP
  39 See "The SLAPD and SLURPD Administrator's Guide" for more details on
  40 using these programs.
  41 .SH OPTIONS
  42 The first three options apply to all four programs. The -j option is
  43 only for the
  44 .B ldif2ldbm
  45 program.
  46 .TP
  47 .BI \-i " ldif\-input\-file"
  48 This option specifies the location of the LDIF input file containing
  49 the database to convert. It is required.
  50 .TP
  51 .BI \-d " debug\-level"
  52 Turn on debugging as defined by
  53 .B debug\-level.
  54 Some general operation and status messages are printed for any value of
  55 \fIdebug\-level\fP.  \fIdebug\-level\fP is taken as a bit string, with
  56 each bit corresponding to a different kind of debugging information.
  57 See <ldap.h> for details.
  58 .TP
  59 .BI \-f " slapd\-config\-file"
  60 This option
  61 Specifies the
  62 .B slapd
  63 configuration file. The default is
  64 .BR ETCDIR/slapd.conf .
  65 .TP
  66 .BI \-j " number\-of\-jobs"
  67 This option only applies to the
  68 .B ldif2ldbm
  69 program. It specifies the level of parallelism to use when doing the
  70 conversion.
  71 .B ldif2ldbm
  72 invokes several other programs during the conversion process,
  73 most notably one invocation of
  74 .B ldif2index
  75 for each indexed attribute that appears in the LDIF input file. The -j
  76 option tells
  77 .B ldif2ldbm
  78 how many of these other programs it should run in parallel. This can
  79 speed up the conversion, but beware of starting too many processes
  80 in parallel, all competing for disk, memory, and cpu resources. The
  81 default is one.
  82 .SH EXAMPLES
  83 To convert the file
  84 .BR ldif.input
  85 into an LDBM database with indexes as described in the
  86 .I slapd
  87 config file
  88 .BR ETCDIR/slapd.conf ,
  89 give the command:
  90 .LP
  91 .nf
  92 .ft tt
  93         SBINDIR/ldif2index -i ldif.input -f ETCDIR/slapd.conf
  94 .ft
  95 .fi
  96 .LP
  97 To do the same, but running two conversion sub-processes at a time,
  98 give this command:
  99 .LP
 100 .nf
 101 .ft tt
 102         SBINDIR/ldif2index -i ldif.input -f ETCDIR/slapd.conf -j 2
 103 .ft
 104 .fi
 105 .LP
 106 .SH "SEE ALSO"
 107 .BR ldap (3),
 108 .BR ldif (5),
 109 .BR slapd.conf (5),
 110 .BR ldbmcat (8),
 111 .BR edb2ldif (8)
 112 .LP
 113 "The SLAPD and SLURPD Administrator's Guide"
 114 .SH ACKNOWLEDGEMENTS
 115 .B      OpenLDAP
 116 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 117 .B      OpenLDAP
 118 is derived from University of Michigan LDAP 3.3 Release.