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

   1 .TH SLAPINDEX 8C "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2005 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, but if any errors or
  47 interruptions occur the database will most likely be unusable.
  48 .TP
  49 .BI \-d " level"
  50 enable debugging messages as defined by the specified
  51 .IR level .
  52 .TP
  53 .BI \-b " suffix"
  54 Use the specified \fIsuffix\fR to determine which database to
  55 generate output for.  The \-b cannot be used in conjunction
  56 with the
  57 .B \-n
  58 option.
  59 .TP
  60 .BI \-n " dbnum"
  61 Generate output for the \fIdbnum\fR\-th database listed in the
  62 configuration file.  The
  63 .B \-n
  64 cannot be used in conjunction with the
  65 .B \-b
  66 option.
  67 .TP
  68 .BI \-f " slapd.conf"
  69 specify an alternative
  70 .BR slapd.conf (5)
  71 file.
  72 .TP
  73 .BI \-F " confdir"
  74 specify a config directory.
  75 If both
  76 .B -f
  77 and
  78 .B -F
  79 are specified, the config file will be read and converted to
  80 config directory format and written to the specified directory.
  81 If neither option is specified, an attempt to read the
  82 default config directory wll be made before trying to use the default
  83 config file. If a valid config directory exists then the
  84 default config file is ignored.
  85 .SH LIMITATIONS
  86 Your
  87 .BR slapd (8)
  88 should not be running (at least, not in read-write
  89 mode) when you do this to ensure consistency of the database.
  90 .LP
  91 This command provides ample opportunity for the user to obtain
  92 and drink their favorite beverage.
  93 .SH EXAMPLES
  94 To reindex your SLAPD database, give the command:
  95 .LP
  96 .nf
  97 .ft tt
  98         SBINDIR/slapindex
  99 .ft
 100 .fi
 101 .SH "SEE ALSO"
 102 .BR ldap (3),
 103 .BR ldif (5),
 104 .BR slapadd (8),
 105 .BR ldapadd (1),
 106 .BR slapd (8)
 107 .LP
 108 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 109 .SH ACKNOWLEDGEMENTS
 110 .B OpenLDAP
 111 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 112 .B OpenLDAP
 113 is derived from University of Michigan LDAP 3.3 Release.