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