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

   1 .TH CENTIPEDE 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 centipede \- LDAP centroid index generation and maintenance program
   7 .SH SYNOPSIS
   8 .B SBINDIR/centipede
   9 .B [\-f filter]
  10 .B [\-F] [\-R]
  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
  15 .SH DESCRIPTION
  16 .LP
  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
  20 .BR slapd (8)
  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
  24 .BR slapd (8)
  25 LDAP server).
  26 .LP
  27 The basic form of the command is as follows
  28 .LP
  29 .nf
  30 .ft tt
  31         SBINDIR/centipede [options]
  32                 -s "ldap://[host/]subtree-to-index-dn"
  33                 -d "ldap://[host/]parent-of-index-entry-dn"
  34                 attributes
  35 .ft
  36 .fi
  37 .LP
  38 where the
  39 .B \-s
  40 option specifies the subtree for which index information is to
  41 be generated, and the
  42 .B \-d
  43 option specifies the parent under which the index information is to
  44 be installed.
  45 .LP
  46 For example, suppose you are running an
  47 LDAP server on the host
  48 .I babs.com
  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
  53 .BR slapd (8)
  54 running on the host
  55 .I vertigo.rs.itd.umich.edu
  56 under the c=US entry.
  57 This way, when an LDAP client connects to the
  58 .BR slapd (8)
  59 on vertigo and does a subtree search of c=US,
  60 .BR slapd (8)
  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
  63 like this:
  64 .LP
  65 .nf
  66 .ft tt
  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"
  71                 cn sn objectclass
  72 .ft
  73 .fi
  74 .LP
  75 Note the
  76 .B \-b
  77 and
  78 .B \-p
  79 options can be used to authenticate as an entity able to read all
  80 the information you want.
  81 .LP
  82 See "The SLAPD and SLURPD Administrator's Guide" for more details on
  83 using this program.
  84 .SH OPTIONS
  85 .TP
  86 .B \-v
  87 Turn on verbose mode. This option can be given multiple times to increase
  88 the level of verbosity.
  89 .TP
  90 .B \-n
  91 Do not actually install index information. Useful in conjunction with
  92 .B -v
  93 for seeing what
  94 .B centipede
  95 is up to.
  96 .TP
  97 .BI \-f " ldapfilter"
  98 Specify a filter used to select the entries for which to generate indexing
  99 information.
 100 .I ldapfilter
 101 should be a string LDAP filter as described by RFC 1588.
 102 .TP
 103 .BI \-F
 104 Generate full, as opposed to relative, index information.
 105 .TP
 106 .BI \-R
 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.
 110 .TP
 111 .BI \-t " directory"
 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.
 115 .TP
 116 .BI \-b " binddn"
 117 Specify the DN to authenticate with when extracting index information.
 118 .TP
 119 .BI \-p " passwd"
 120 Specify the password to use for simple authentication when extracting
 121 index information.
 122 .TP
 123 .BI \-m " authmethod"
 124 Specify the authentication method to use when extracting index information.
 125 .I authmethod
 126 should be either "simple" or "kerberos".
 127 .TP
 128 .BI \-B " binddn"
 129 Specify the DN to authenticate with when installing index information.
 130 .TP
 131 .BI \-P " passwd"
 132 Specify the password to use for simple authentication when installing
 133 index information.
 134 .TP
 135 .BI \-M " authmethod"
 136 Specify the authentication method to use when installing index information.
 137 .I authmethod
 138 should be either "simple" or "kerberos".
 139 .TP
 140 .BI \-c " cachesize"
 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.
 144 .SH NOTES
 145 This is all very experimental at the moment, and is subject to change.
 146 .LP
 147 Currently,
 148 .B centipede
 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.
 153 .SH "SEE ALSO"
 154 .BR ldap (3),
 155 .BR slapd (8)
 156 .LP
 157 "The SLAPD and SLURPD Administrator's Guide"
 158 .SH ACKNOWLEDGEMENTS
 159 .B      OpenLDAP
 160 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 161 .B      OpenLDAP
 162 is derived from University of Michigan LDAP 3.3 Release.