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