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

   1 .TH SLAPINDEX 8C "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 slapindex \- SLAPD index to LDIF utility
   7 .SH SYNOPSIS
   8 .B SBINDIR/slapindex
   9 .B [\-v]
  10 .B [\-c]
  11 .B [\-g]
  12 .B [\-q]
  13 .B [\-d level]
  14 .B [\-b suffix]
  15 .B [\-n dbnum]
  16 .B [\-f slapd.conf]
  17 .B [\-F confdir]
  18 .B
  19 .LP
  20 .SH DESCRIPTION
  21 .LP
  22 .B Slapindex
  23 is used to regenerate
  24 .BR slapd (8)
  25 indices based upon the current contents of a database.
  26 It opens the given database determined by the database number or
  27 suffix and updates the indices for all values of all attributes
  28 of all entries.
  29 Databases configured as
  30 .B subordinate
  31 of this one are also re-indexed, unless \fB-g\fP is specified.
  32 .SH OPTIONS
  33 .TP
  34 .B \-v
  35 enable verbose mode.
  36 .TP
  37 .B \-c
  38 enable continue (ignore errors) mode.
  39 .TP
  40 .B \-g
  41 disable subordinate gluing.  Only the specified database will be
  42 processed, and not its glued subordinates (if any).
  43 .TP
  44 .B \-q
  45 enable quick (fewer integrity checks) mode. Performs no consistency checks
  46 when writing the database. Improves indexing time,
  47 .B however
  48 the database will most likely be unusable if any errors or
  49 interruptions occur.
  50 .TP
  51 .BI \-d " level"
  52 enable debugging messages as defined by the specified
  53 .IR level .
  54 .TP
  55 .BI \-b " suffix"
  56 Use the specified \fIsuffix\fR to determine which database to
  57 generate output for.  The \-b cannot be used in conjunction
  58 with the
  59 .B \-n
  60 option.
  61 .TP
  62 .BI \-n " dbnum"
  63 Generate output for the \fIdbnum\fR\-th database listed in the
  64 configuration file.  The
  65 .B \-n
  66 cannot be used in conjunction with the
  67 .B \-b
  68 option.
  69 .TP
  70 .BI \-f " slapd.conf"
  71 specify an alternative
  72 .BR slapd.conf (5)
  73 file.
  74 .TP
  75 .BI \-F " confdir"
  76 specify a config directory.
  77 If both
  78 .B -f
  79 and
  80 .B -F
  81 are specified, the config file will be read and converted to
  82 config directory format and written to the specified directory.
  83 If neither option is specified, an attempt to read the
  84 default config directory will be made before trying to use the default
  85 config file. If a valid config directory exists then the
  86 default config file is ignored.
  87 .SH LIMITATIONS
  88 Your
  89 .BR slapd (8)
  90 should not be running (at least, not in read-write
  91 mode) when you do this to ensure consistency of the database.
  92 .LP
  93 This command provides ample opportunity for the user to obtain
  94 and drink their favorite beverage.
  95 .SH EXAMPLES
  96 To reindex your SLAPD database, give the command:
  97 .LP
  98 .nf
  99 .ft tt
 100         SBINDIR/slapindex
 101 .ft
 102 .fi
 103 .SH "SEE ALSO"
 104 .BR ldap (3),
 105 .BR ldif (5),
 106 .BR slapadd (8),
 107 .BR ldapadd (1),
 108 .BR slapd (8)
 109 .LP
 110 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 111 .SH ACKNOWLEDGEMENTS
 112 .B OpenLDAP
 113 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 114 .B OpenLDAP
 115 is derived from University of Michigan LDAP 3.3 Release.