]> git.sur5r.net Git - openldap/blob - doc/man/man8/edb2ldif.8
bcfcadbe4f6dbc786e0684883bed0d6f4f3c3fc7
[openldap] / doc / man / man8 / edb2ldif.8
1 .TH EDB2LDIF 8C "22 September 1998" "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 edb2ldif \- QUIPU EDB file to LDIF conversion tool
7 .SH SYNOPSIS
8 .B SBINDIR/edb2ldif
9 .B [\-d] [\-v] [\-r] [\-o] [\-b basedn]
10 .B [\-a addvalsfile] [\-f fileattrdir]
11 .B [\-i ignoreattr...] [edbfile...]
12 .B 
13 .SH DESCRIPTION
14 .LP
15 Data that is held in a QUIPU DSA (available as part of the ISODE package)
16 is stored in or can be easily converted to the EDB file format.  The
17 .I edb2ldif
18 tool is used to convert directory data from EDB file format to the
19 LDAP Directory Interchange Format (LDIF) used by
20 .BR slapd (8)
21 and associated utilities.  The
22 .BR slapadd (8)
23 program can be used to convert the resulting LDIF data into a database
24 that is compatible with
25 .BR slapd (8).
26 .LP
27 .I edb2ldif
28 writes LDIF formatted data to standard output.  If you specify a particular
29 .I edbfile
30 (or files) to read data from, they are converted.  If no
31 .I edbfile
32 is specified, the files named
33 .BR EDB.root
34 (if it exists) and
35 .BR EDB
36 in the current directory are converted. An entire EDB hierarchy
37 can be converted using the
38 .B \-r
39 option.
40 .LP
41 When
42 .I edb2ldif
43 is invoked, it will also look for files named
44 .BR .add
45 in the directories
46 where EDB files are found and append the contents of the
47 .BR .add
48 file to each entry in the corresponding EDB file. 
49 Typically, this feature is used to include inherited
50 attribute values (e.g., objectClass) that do not appear in the EDB files.
51 .LP
52 See "The SLAPD and SLURPD Administrator's Guide" for more details on
53 using
54 .I edb2ldif,
55 including step-by-step conversion instructions.
56 .SH OPTIONS
57 .TP
58 .B \-d
59 Turn on some extra debugging which is written to standard error.
60 .TP
61 .B \-v
62 Enable verbose mode that writes status information to standard error, such
63 as which EDB file is being processed, how many entries have been
64 converted so far, etc.
65 .TP
66 .B \-r
67 Recurse through child directories, processing all EDB files found.
68 .TP
69 .B \-o
70 Cause local
71 .B .add
72 file definitions to override the global addfile (see the
73 .B \-a
74 option below)
75 .TP
76 .BI \-b " basedn"
77 Specify the Distinguished Name that all EDB file entries appear below.
78 .TP
79 .B \-a " addvalsfile"
80 The LDIF information contained in this file will be appended to each entry.
81 (See the
82 .B \-o
83 option above.)
84 .TP
85 .BI \-f " fileattrdir"
86 Specify a single directory where all file-based attributes (typically sounds
87 and images) can be found.  If this option is not given, file attributes are
88 assumed to be located in the same directory as the EDB file that refers to
89 them.
90 .TP
91 .BI \-i " ignoreattr"
92 Specify an attribute that should not be converted.  You can include as many
93 \- i flags as necessary.
94 .SH "SEE ALSO"
95 .BR ldap (3),
96 .BR ldif (5),
97 .BR slapd (8),
98 .BR slapadd (8)
99 .LP
100 "The SLAPD and SLURPD Administrator's Guide"
101 .LP
102 Volume 5 of The ISODE Manual
103 .SH ACKNOWLEDGEMENTS
104 .B      OpenLDAP
105 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
106 .B      OpenLDAP
107 is derived from University of Michigan LDAP 3.3 Release.