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] [\-n database#] [\-s sbindir]
   9 .LP
  10 .B SBINDIR/ldif2index
  11 .B \-i ldif\-input\-file
  12 .B [\-d debug\-level] [\-f slapd\-config\-file] [\-n database#]
  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] [\-n database#]
  18 .LP
  19 .B SBINDIR/ldif2id2children
  20 .B \-i ldif\-input\-file
  21 .B [\-d debug\-level] [\-f slapd\-config\-file] [\-n database#]
  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 specifies the
  61 .B slapd
  62 configuration file. The default is
  63 .BR ETCDIR/slapd.conf .
  64 .TP
  65 .BI \-n " database#"
  66 This option specifies the database number within
  67 .B slapd
  68 configuration file to build. The default is the 1, the first.
  69 .TP
  70 .BI \-s " sbindir"
  71 This option specifies the location of dependent tools.  The
  72 default is SBINDIR.
  73 .TP
  74 .BI \-j " number\-of\-jobs"
  75 This option only applies to the
  76 .B ldif2ldbm
  77 program. It specifies the level of parallelism to use when doing the
  78 conversion.
  79 .B ldif2ldbm
  80 invokes several other programs during the conversion process,
  81 most notably one invocation of
  82 .B ldif2index
  83 for each indexed attribute that appears in the LDIF input file. The -j
  84 option tells
  85 .B ldif2ldbm
  86 how many of these other programs it should run in parallel. This can
  87 speed up the conversion, but beware of starting too many processes
  88 in parallel, all competing for disk, memory, and cpu resources. The
  89 default is one.
  90 .SH EXAMPLES
  91 To convert the file
  92 .BR ldif.input
  93 into an LDBM database with indexes as described in the
  94 .I slapd
  95 config file
  96 .BR ETCDIR/slapd.conf ,
  97 give the command:
  98 .LP
  99 .nf
 100 .ft tt
 101         SBINDIR/ldif2index -i ldif.input -f ETCDIR/slapd.conf
 102 .ft
 103 .fi
 104 .LP
 105 To build the second database listed in
 106 .BR ETCDIR/slapd.conf ,
 107 and to use three conversion sub-processes at a time,
 108 give this command:
 109 .LP
 110 .nf
 111 .ft tt
 112         SBINDIR/ldif2index -i ldif.input -f ETCDIR/slapd.conf -n 2 -j 3
 113 .ft
 114 .fi
 115 .LP
 116 .SH "SEE ALSO"
 117 .BR ldap (3),
 118 .BR ldif (5),
 119 .BR slapd.conf (5),
 120 .BR ldbmcat (8),
 121 .BR edb2ldif (8)
 122 .LP
 123 "The SLAPD and SLURPD Administrator's Guide"
 124 .SH ACKNOWLEDGEMENTS
 125 .B      OpenLDAP
 126 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 127 .B      OpenLDAP
 128 is derived from University of Michigan LDAP 3.3 Release.