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