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 [\-q]
  12 .B [\-d level]
  13 .B [\-b suffix]
  14 .B [\-n dbnum]
  15 .B [\-f slapd.conf]
  16 .B
  17 .LP
  18 .SH DESCRIPTION
  19 .LP
  20 .B Slapindex
  21 is used to regenerate
  22 .BR slapd (8)
  23 indices based upon the current contents of a database.
  24 It opens the given database determined by the database number or
  25 suffix and updates the indices for all values of all attributes
  26 of all entries.
  27 Subordinate databases glued with
  28 .BR slapo-glue (5)
  29 are also re-indexed.
  30 .SH OPTIONS
  31 .TP
  32 .B \-v
  33 enable verbose mode.
  34 .TP
  35 .B \-c
  36 enable continue (ignore errors) mode.
  37 .TP
  38 .B \-q
  39 enable quick (fewer integrity checks) mode. Performs no consistency checks
  40 when writing the database. Improves indexing time, but if any errors or
  41 interruptions occur the database will most likely be unusable.
  42 .TP
  43 .BI \-d " level"
  44 enable debugging messages as defined by the specified
  45 .IR level .
  46 .TP
  47 .BI \-b " suffix"
  48 Use the specified \fIsuffix\fR to determine which database to
  49 generate output for.  The \-b cannot be used in conjunction
  50 with the
  51 .B \-n
  52 option.
  53 .TP
  54 .BI \-n " dbnum"
  55 Generate output for the \fIdbnum\fR\-th database listed in the
  56 configuration file.  The
  57 .B \-n
  58 cannot be used in conjunction with the
  59 .B \-b
  60 option.
  61 .TP
  62 .BI \-f " slapd.conf"
  63 specify an alternative
  64 .BR slapd.conf (5)
  65 file.
  66 .SH LIMITATIONS
  67 Your
  68 .BR slapd (8)
  69 should not be running (at least, not in read-write
  70 mode) when you do this to ensure consistency of the database.
  71 .LP
  72 This command provides ample opportunity for the user to obtain
  73 and drink their favorite beverage.
  74 .SH EXAMPLES
  75 To reindex your SLAPD database, give the command:
  76 .LP
  77 .nf
  78 .ft tt
  79         SBINDIR/slapindex
  80 .ft
  81 .fi
  82 .SH "SEE ALSO"
  83 .BR ldap (3),
  84 .BR ldif (5),
  85 .BR slapadd (8),
  86 .BR ldapadd (1),
  87 .BR slapd (8)
  88 .LP
  89 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
  90 .SH ACKNOWLEDGEMENTS
  91 .B OpenLDAP
  92 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
  93 .B OpenLDAP
  94 is derived from University of Michigan LDAP 3.3 Release.