1 .TH CENTIPEDE 8C "22 September 1998" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 centipede \- LDAP centroid index generation and maintenance program
11 .B [\-f filter] [\-t directory]
12 .B [\-m authmethod] [\-b binddn]
13 .B [\-p passwd] [\-c cachesize]
14 .B \-s sourceurl \-d desturl attributes
17 The centipede program is used to extract centroid or other index
18 information from one LDAP server and install it in another. Although
19 index information can be extracted from any LDAP server, only a
21 LDAP server will understand the information and thus be capable of
22 making use of it as indexing information (i.e., you should only
23 install index information in a
27 The basic form of the command is as follows
31 SBINDIR/centipede [options]
32 -s "ldap://[host/]subtree-to-index-dn"
33 -d "ldap://[host/]parent-of-index-entry-dn"
40 option specifies the subtree for which index information is to
43 option specifies the parent under which the index information is to
46 For example, suppose you are running an
47 LDAP server on the host
49 for an organization called "BabsCo" based in the US, and you want to
50 generate index information for the cn, sn and objectclass attributes of
51 all the people entries in your subtree. You want to install the index
52 informatioin in the indexing
55 .I vertigo.rs.itd.umich.edu
57 This way, when an LDAP client connects to the
59 on vertigo and does a subtree search of c=US,
61 can consult the index information to tell whether it should refer the
62 client to your server or not. You could accomplish this with a command
67 SBINDIR/centipede -f '(objectclass=person)'
68 -m simple -b your-rootdn -p your-rootdnpw
69 -s "ldap://babs.com/o=BabsCo, c=US"
70 -d "ldap://vertigo.rs.itd.umich.edu/c=US"
79 options can be used to authenticate as an entity able to read all
80 the information you want.
82 See "The SLAPD and SLURPD Administrator's Guide" for more details on
87 Turn on verbose mode. This option can be given multiple times to increase
88 the level of verbosity.
91 Do not actually install index information. Useful in conjunction with
98 Specify a filter used to select the entries for which to generate indexing
101 should be a string LDAP filter as described by RFC 1588.
104 Generate full, as opposed to relative, index information.
107 Generate relative, as opposed to full, index information. Full information
108 is still generated if there is no previous information available from
109 which to generate the relative information. This is the default.
112 Specify the directory in which to create temporary files, find existing
113 index information, and put new index information. The default is
114 whatever is used by tempnam.
117 Specify the DN to authenticate with when extracting index information.
120 Specify the password to use for simple authentication when extracting
123 .BI \-m " authmethod"
124 Specify the authentication method to use when extracting index information.
126 should be either "simple" or "kerberos".
129 Specify the DN to authenticate with when installing index information.
132 Specify the password to use for simple authentication when installing
135 .BI \-M " authmethod"
136 Specify the authentication method to use when installing index information.
138 should be either "simple" or "kerberos".
141 Specify the size in bytes of the cache used when building the new
142 index information. Upping this number can cause a big performance boost,
143 if you've got the memory for it.
145 This is all very experimental at the moment, and is subject to change.
149 only handles value-based index information. A future version of centipede
150 will allow other types of index information to be manipulated (e.g.,
151 word-based indexes, substring indexes, phonetic indexes, hash indexes,
152 etc.). A future version may also allow weights to be generated.
157 "The SLAPD and SLURPD Administrator's Guide"
160 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
162 is derived from University of Michigan LDAP 3.3 Release.