]> git.sur5r.net Git - openldap/blob - doc/man/man8/ldbmcat.8
Update misleading statement about ldap_init(). It use is actually
[openldap] / doc / man / man8 / ldbmcat.8
1 .TH LDBMCAT 8C "22 September 1998" "OpenLDAP LDVERSION"
2 .SH NAME
3 ldbmcat \- LDBM to LDIF database format conversion utility
4 .SH SYNOPSIS
5 .B SBINDIR/ldbmcat [\-n] id2entry\-file
6 .LP
7 .SH DESCRIPTION
8 .LP
9 This program is used to convert a
10 .BR slapd (8)
11 LDBM database to the text LDAP Directory Interchange Format (LDIF).
12 It opens the given
13 .I id2entry\-file
14 and writes the corresponding LDIF output to standard output.
15 .LP
16 See "The SLAPD and SLURPD Administrator's Guide" for more details on
17 using this program.
18 .SH OPTIONS
19 .TP
20 .B \-n
21 This option specifies that
22 .B ldbmcat
23 should not print entry IDs when it dumps out the database. Note
24 that the printing of entry IDs is essential if you are going to
25 use the LDIF format produced as input to
26 .B ldif2index,
27 for example, to create a new index file for use with an existing
28 database.
29 .SH EXAMPLES
30 To make a text backup of your LDBM database and put it in a file called
31 .BR ldif ,
32 give the command:
33 .LP
34 .nf
35 .ft tt
36         SBINDIR/ldbmcat -n id2entry.dbb > ldif
37 .ft
38 .fi
39 .LP
40 To create a new index for the
41 .B mail
42 attribute, give these commands:
43 .LP
44 .nf
45 .ft tt
46         SBINDIR/ldbmcat id2entry.dbb > ldif
47         SBINDIR/ldif2index -i ldif -f slapd-config-file mail
48 .ft
49 .fi
50 .LP
51 Note that your
52 .B slapd (8)
53 should not be running (at least, not in read-write
54 mode) when you do this to ensure consistency of the database.
55 .SH "SEE ALSO"
56 .BR ldap (3),
57 .BR ldif (5),
58 .BR ldif2ldbm (8),
59 .BR slapd (8)
60 .LP
61 "The SLAPD and SLURPD Administrator's Guide"
62 .SH ACKNOWLEDGEMENTS
63 .B      OpenLDAP
64 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
65 .B      OpenLDAP
66 is derived from University of Michigan LDAP 3.3 Release.