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

   1 .TH CENTIPEDE 8C "22 September 1998" "OpenLDAP LDVERSION"
   2 .SH NAME
   3 centipede \- LDAP centroid index generation and maintenance program
   4 .SH SYNOPSIS
   5 .B SBINDIR/centipede
   6 .B [\-f filter]
   7 .B [\-F] [\-R]
   8 .B [\-f filter] [\-t directory]
   9 .B [\-m authmethod] [\-b binddn]
  10 .B [\-p passwd] [\-c cachesize]
  11 .B \-s sourceurl \-d desturl attributes
  12 .SH DESCRIPTION
  13 .LP
  14 The centipede program is used to extract centroid or other index
  15 information from one LDAP server and install it in another. Although
  16 index information can be extracted from any LDAP server, only a
  17 .BR slapd (8)
  18 LDAP server will understand the information and thus be capable of
  19 making use of it as indexing information (i.e., you should only
  20 install index information in a
  21 .BR slapd (8)
  22 LDAP server).
  23 .LP
  24 The basic form of the command is as follows
  25 .LP
  26 .nf
  27 .ft tt
  28         SBINDIR/centipede [options]
  29                 -s "ldap://[host/]subtree-to-index-dn"
  30                 -d "ldap://[host/]parent-of-index-entry-dn"
  31                 attributes
  32 .ft
  33 .fi
  34 .LP
  35 where the
  36 .B \-s
  37 option specifies the subtree for which index information is to
  38 be generated, and the
  39 .B \-d
  40 option specifies the parent under which the index information is to
  41 be installed.
  42 .LP
  43 For example, suppose you are running an
  44 LDAP server on the host
  45 .I babs.com
  46 for an organization called "BabsCo" based in the US, and you want to
  47 generate index information for the cn, sn and objectclass attributes of
  48 all the people entries in your subtree. You want to install the index
  49 informatioin in the indexing
  50 .BR slapd (8)
  51 running on the host
  52 .I vertigo.rs.itd.umich.edu
  53 under the c=US entry.
  54 This way, when an LDAP client connects to the
  55 .BR slapd (8)
  56 on vertigo and does a subtree search of c=US,
  57 .BR slapd (8)
  58 can consult the index information to tell whether it should refer the
  59 client to your server or not. You could accomplish this with a command
  60 like this:
  61 .LP
  62 .nf
  63 .ft tt
  64         SBINDIR/centipede -f '(objectclass=person)'
  65                 -m simple -b your-rootdn -p your-rootdnpw
  66                 -s "ldap://babs.com/o=BabsCo, c=US"
  67                 -d "ldap://vertigo.rs.itd.umich.edu/c=US"
  68                 cn sn objectclass
  69 .ft
  70 .fi
  71 .LP
  72 Note the
  73 .B \-b
  74 and
  75 .B \-p
  76 options can be used to authenticate as an entity able to read all
  77 the information you want.
  78 .LP
  79 See "The SLAPD and SLURPD Administrator's Guide" for more details on
  80 using this program.
  81 .SH OPTIONS
  82 .TP
  83 .B \-v
  84 Turn on verbose mode. This option can be given multiple times to increase
  85 the level of verbosity.
  86 .TP
  87 .B \-n
  88 Do not actually install index information. Useful in conjunction with
  89 .B -v
  90 for seeing what
  91 .B centipede
  92 is up to.
  93 .TP
  94 .BI \-f " ldapfilter"
  95 Specify a filter used to select the entries for which to generate indexing
  96 information.
  97 .I ldapfilter
  98 should be a string LDAP filter as described by RFC 1588.
  99 .TP
 100 .BI \-F
 101 Generate full, as opposed to relative, index information.
 102 .TP
 103 .BI \-R
 104 Generate relative, as opposed to full, index information. Full information
 105 is still generated if there is no previous information available from
 106 which to generate the relative information. This is the default.
 107 .TP
 108 .BI \-t " directory"
 109 Specify the directory in which to create temporary files, find existing
 110 index information, and put new index information. The default is
 111 whatever is used by tempnam.
 112 .TP
 113 .BI \-b " binddn"
 114 Specify the DN to authenticate with when extracting index information.
 115 .TP
 116 .BI \-p " passwd"
 117 Specify the password to use for simple authentication when extracting
 118 index information.
 119 .TP
 120 .BI \-m " authmethod"
 121 Specify the authentication method to use when extracting index information.
 122 .I authmethod
 123 should be either "simple" or "kerberos".
 124 .TP
 125 .BI \-B " binddn"
 126 Specify the DN to authenticate with when installing index information.
 127 .TP
 128 .BI \-P " passwd"
 129 Specify the password to use for simple authentication when installing
 130 index information.
 131 .TP
 132 .BI \-M " authmethod"
 133 Specify the authentication method to use when installing index information.
 134 .I authmethod
 135 should be either "simple" or "kerberos".
 136 .TP
 137 .BI \-c " cachesize"
 138 Specify the size in bytes of the cache used when building the new
 139 index information. Upping this number can cause a big performance boost,
 140 if you've got the memory for it.
 141 .SH NOTES
 142 This is all very experimental at the moment, and is subject to change.
 143 .LP
 144 Currently,
 145 .B centipede
 146 only handles value-based index information. A future version of centipede
 147 will allow other types of index information to be manipulated (e.g.,
 148 word-based indexes, substring indexes, phonetic indexes, hash indexes,
 149 etc.). A future version may also allow weights to be generated.
 150 .SH "SEE ALSO"
 151 .BR ldap (3),
 152 .BR slapd (8)
 153 .LP
 154 "The SLAPD and SLURPD Administrator's Guide"
 155 .SH ACKNOWLEDGEMENTS
 156 .B      OpenLDAP
 157 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 158 .B      OpenLDAP
 159 is derived from University of Michigan LDAP 3.3 Release.