]> git.sur5r.net Git - openldap/blob - doc/man/man8/slapindex.8
document new tools
[openldap] / doc / man / man8 / slapindex.8
1 .TH SLAPINDEX 8C "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" $OpenLDAP$
3 .\" Copyright 1998-2004 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 [\-d level]
12 .B [\-b suffix]
13 .B [\-n dbnum]
14 .B [\-f slapd.conf]
15 .B 
16 .LP
17 .SH DESCRIPTION
18 .LP
19 .B Slapindex
20 is used to regenerate
21 .BR slapd (8)
22 indices based upon the current contents of a database.
23 It opens the given database determined by the database number or
24 suffix and updates the indices for all values of all attributes
25 of all entries.
26 .SH OPTIONS
27 .TP
28 .B \-v
29 enable verbose mode.
30 .TP
31 .B \-c
32 enable continue (ignore errors) mode.
33 .TP
34 .BI \-d " level"
35 enable debugging messages as defined by the specified
36 .IR level .
37 .TP
38 .BI \-b " suffix" 
39 Use the specified \fIsuffix\fR to determine which database to
40 generate output for.  The \-b cannot be used in conjunction
41 with the
42 .B \-n
43 option.
44 .TP
45 .BI \-n " dbnum"
46 Generate output for the \fIdbnum\fR\-th database listed in the
47 configuration file.  The
48 .B \-n
49 cannot be used in conjunction with the
50 .B \-b
51 option.
52 .TP
53 .BI \-f " slapd.conf"
54 specify an alternative
55 .BR slapd.conf (5)
56 file.
57 .SH LIMITATIONS
58 Your
59 .BR slapd (8)
60 should not be running (at least, not in read-write
61 mode) when you do this to ensure consistency of the database.
62 .LP
63 This command provides ample opportunity for the user to obtain
64 and drink their favorite beverage.
65 .SH EXAMPLES
66 To reindex your SLAPD database, give the command:
67 .LP
68 .nf
69 .ft tt
70         SBINDIR/slapindex
71 .ft
72 .fi
73 .SH "SEE ALSO"
74 .BR ldap (3),
75 .BR ldif (5),
76 .BR slapadd (8),
77 .BR ldapadd (1),
78 .BR slapd (8)
79 .LP
80 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
81 .SH ACKNOWLEDGEMENTS
82 .B OpenLDAP
83 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
84 .B OpenLDAP
85 is derived from University of Michigan LDAP 3.3 Release.