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