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