]> git.sur5r.net Git - openldap/blob - doc/man/man8/slapadd.8
Document -s option
[openldap] / doc / man / man8 / slapadd.8
1 .TH SLAPADD 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 slapadd \- Add entries to a SLAPD database
7 .SH SYNOPSIS
8 .B SBINDIR/slapadd
9 .B [\-v]
10 .B [\-c]
11 .B [\-g]
12 .B [\-u]
13 .B [\-q]
14 .B [\-w]
15 .B [\-s]
16 .B [\-d level]
17 .B [\-b suffix]
18 .B [\-n dbnum]
19 .B [\-f slapd.conf]
20 .B [\-F confdir]
21 .B [\-l ldif-file]
22 .SH DESCRIPTION
23 .LP
24 .B Slapadd
25 is used to add entries specified in LDAP Directory Interchange Format
26 (LDIF) to a
27 .BR slapd (8)
28 database.
29 It opens the given database determined by the database number or
30 suffix and adds entries corresponding to the provided LDIF to
31 the database.
32 Databases configured as
33 .B subordinate
34 of this one are also updated, unless \fB-g\fP is specified.
35 The LDIF input is read from standard input or the specified file.
36 .LP
37 As
38 .B slapadd
39 is designed to accept LDIF in database order, as produced by
40 .BR slapcat (8),
41 it does not verify that superior entries exist before
42 adding an entry, does not perform all user and system
43 schema checks, and does not maintain operational
44 attributes (such as createTimeStamp and modifiersName). 
45 .SH OPTIONS
46 .TP
47 .B \-v
48 enable verbose mode.
49 .TP
50 .B \-c
51 enable continue (ignore errors) mode.
52 .TP
53 .B \-g
54 disable subordinate gluing.  Only the specified database will be
55 processed, and not its glued subordinates (if any).
56 .TP
57 .B \-u
58 enable dry-run (don't write to backend) mode.
59 .TP
60 .B \-q
61 enable quick (fewer integrity checks) mode.  Does fewer consistency checks
62 on the input data, and no consistency checks when writing the database.
63 Improves the load time but if any errors or interruptions occur the resulting
64 database will be unusable.
65 .TP
66 .BI \-w
67 write syncrepl context information.
68 After all entries are added, the contextCSN
69 will be updated with the greatest CSN in the database.
70 .TP
71 .BI \-s
72 disable schema checking.  This option is intended to be used when loading
73 databases containing special objects, such as fractional objects on a
74 partial replica.  Loading normal objects which do not conform to
75 schema may result in unexpected and ill behavior.
76 .TP
77 .BI \-d " level"
78 enable debugging messages as defined by the specified
79 .IR level .
80 .TP
81 .BI \-b " suffix" 
82 Use the specified \fIsuffix\fR to determine which database to
83 add entries to.  The \-b cannot be used in conjunction
84 with the
85 .B \-n
86 option.
87 .TP
88 .BI \-n " dbnum"
89 Add entries to the \fIdbnum\fR\-th database listed in the
90 configuration file.  The
91 .B \-n
92 cannot be used in conjunction with the
93 .B \-b
94 option.
95 .TP
96 .BI \-f " slapd.conf"
97 specify an alternative
98 .BR slapd.conf (5)
99 file.
100 .TP
101 .BI \-F " confdir"
102 specify a config directory.
103 If both
104 .B -f
105 and
106 .B -F
107 are specified, the config file will be read and converted to
108 config directory format and written to the specified directory.
109 If neither option is specified, an attempt to read the
110 default config directory will be made before trying to use the default
111 config file. If a valid config directory exists then the
112 default config file is ignored. If dryrun mode is also specified,
113 no conversion will occur.
114 .TP
115 .BI \-l " ldif-file"
116 Read LDIF from the specified file instead of standard input.
117 .SH LIMITATIONS
118 Your
119 .BR slapd (8)
120 should not be running 
121 when you do this to ensure consistency of the database.
122 .LP
123 .B slapadd 
124 may not provide naming or schema checks.  It is advisable to
125 use
126 .BR ldapadd (1)
127 when adding new entries into an existing directory.
128 .SH EXAMPLES
129 To import the entries specified in file
130 .B ldif
131 into your
132 .BR slapd (8)
133 database give the command:
134 .LP
135 .nf
136 .ft tt
137         SBINDIR/slapadd -l ldif
138 .ft
139 .fi
140 .SH "SEE ALSO"
141 .BR ldap (3),
142 .BR ldif (5),
143 .BR slapcat (8),
144 .BR ldapadd (1),
145 .BR slapd (8)
146 .LP
147 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
148 .SH ACKNOWLEDGEMENTS
149 .B OpenLDAP
150 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
151 .B OpenLDAP
152 is derived from University of Michigan LDAP 3.3 Release.