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

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