external/bsd/openldap/man/slapindex.8

   1 .TH SLAPINDEX 8C "2008/07/16" "OpenLDAP 2.4.11"
   2 .\" $OpenLDAP: pkg/ldap/doc/man/man8/slapindex.8,v 1.19.2.10 2008/02/11 23:26:40 kurt Exp $
   3 .\" Copyright 1998-2008 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 slapindex \- Reindex entries in a SLAPD database
   7 .SH SYNOPSIS
   8 .B /usr/sbin/slapindex
   9 .B [\-b suffix]
  10 .B [\-c]
  11 .B [\-d level]
  12 .B [\-f slapd.conf]
  13 .B [\-F confdir]
  14 .B [\-g]
  15 .B [\-n dbnum]
  16 .B [\-o name[=value]]
  17 .B [\-q]
  18 .B [\-t]
  19 .B [\-v]
  20 .B [attr] [...]
  21 .B
  22 .LP
  23 .SH DESCRIPTION
  24 .LP
  25 .B Slapindex
  26 is used to regenerate
  27 .BR slapd (8)
  28 indices based upon the current contents of a database.
  29 It opens the given database determined by the database number or
  30 suffix and updates the indices for all values of all attributes
  31 of all entries. If a list of specific attributes is provided
  32 on the command line, only the indices for those attributes will
  33 be regenerated.
  34 Databases configured as
  35 .B subordinate
  36 of this one are also re-indexed, unless \fB-g\fP is specified.
  37
  38 All files eventually created by
  39 .BR slapindex
  40 will belong to the identity
  41 .BR slapindex
  42 is run as, so make sure you either run
  43 .BR slapindex
  44 with the same identity
  45 .BR slapd (8)
  46 will be run as (see option
  47 .B \-u
  48 in
  49 .BR slapd (8)),
  50 or change file ownership before running
  51 .BR slapd (8).
  52 .SH OPTIONS
  53 .TP
  54 .BI \-b " suffix"
  55 Use the specified \fIsuffix\fR to determine which database to
  56 generate output for.  The \-b cannot be used in conjunction
  57 with the
  58 .B \-n
  59 option.
  60 .TP
  61 .B \-c
  62 enable continue (ignore errors) mode.
  63 .TP
  64 .BI \-d " level"
  65 enable debugging messages as defined by the specified
  66 .IR level ;
  67 see
  68 .BR slapd (8)
  69 for details.
  70 .TP
  71 .BI \-f " slapd.conf"
  72 specify an alternative
  73 .BR slapd.conf (5)
  74 file.
  75 .TP
  76 .BI \-F " confdir"
  77 specify a config directory.
  78 If both
  79 .B -f
  80 and
  81 .B -F
  82 are specified, the config file will be read and converted to
  83 config directory format and written to the specified directory.
  84 If neither option is specified, an attempt to read the
  85 default config directory will be made before trying to use the default
  86 config file. If a valid config directory exists then the
  87 default config file is ignored.
  88 .TP
  89 .B \-g
  90 disable subordinate gluing.  Only the specified database will be
  91 processed, and not its glued subordinates (if any).
  92 .TP
  93 .BI \-n " dbnum"
  94 Generate output for the \fIdbnum\fR\-th database listed in the
  95 configuration file.  The
  96 .B \-n
  97 cannot be used in conjunction with the
  98 .B \-b
  99 option.
 100 .TP
 101 .BI \-o " option[=value]"
 102 Specify an
 103 .BR option
 104 with a(n optional)
 105 .BR value .
 106 Possible generic options/values are:
 107 .LP
 108 .nf
 109               syslog=<subsystems>  (see `\-s' in slapd(8))
 110               syslog-level=<level> (see `\-S' in slapd(8))
 111               syslog-user=<user>   (see `\-l' in slapd(8))
 112
 113 .fi
 114 .TP
 115 .B \-q
 116 enable quick (fewer integrity checks) mode. Performs no consistency checks
 117 when writing the database. Improves indexing time,
 118 .B however
 119 the database will most likely be unusable if any errors or
 120 interruptions occur.
 121 .TP
 122 .B \-t
 123 enable truncate mode. Truncates (empties) an index database before indexing
 124 any entries. May only be used with Quick mode.
 125 .TP
 126 .B \-v
 127 enable verbose mode.
 128 .SH LIMITATIONS
 129 Your
 130 .BR slapd (8)
 131 should not be running (at least, not in read-write
 132 mode) when you do this to ensure consistency of the database.
 133 .LP
 134 This command provides ample opportunity for the user to obtain
 135 and drink their favorite beverage.
 136 .SH EXAMPLES
 137 To reindex your SLAPD database, give the command:
 138 .LP
 139 .nf
 140 .ft tt
 141         /usr/sbin/slapindex
 142 .ft
 143 .fi
 144 To regenerate the index for only a specific attribute, e.g. "uid",
 145 give the command:
 146 .LP
 147 .nf
 148 .ft tt
 149         /usr/sbin/slapindex uid
 150 .ft
 151 .fi
 152 .SH "SEE ALSO"
 153 .BR ldap (3),
 154 .BR ldif (5),
 155 .BR slapadd (8),
 156 .BR ldapadd (1),
 157 .BR slapd (8)
 158 .LP
 159 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 160 .SH ACKNOWLEDGEMENTS
 161 .\" Shared Project Acknowledgement Text
 162 .B "OpenLDAP Software"
 163 is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>.
 164 .B "OpenLDAP Software"
 165 is derived from University of Michigan LDAP 3.3 Release.