]> git.sur5r.net Git - openldap/blobdiff - doc/man/man8/slapadd.8
Document -s option
[openldap] / doc / man / man8 / slapadd.8
index 9359ab0d9f892ecb023034393fc7967db1e57daf..86b2e21e11476898117aeac6148d789f56688230 100644 (file)
@@ -1,6 +1,6 @@
-.TH SLAPADD 8C "13 August 2000" "OpenLDAP LDVERSION"
+.TH SLAPADD 8C "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
-.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 slapadd \- Add entries to a SLAPD database
@@ -8,14 +8,17 @@ slapadd \- Add entries to a SLAPD database
 .B SBINDIR/slapadd
 .B [\-v]
 .B [\-c]
+.B [\-g]
+.B [\-u]
+.B [\-q]
+.B [\-w]
 .B [\-s]
 .B [\-d level]
 .B [\-b suffix]
 .B [\-n dbnum]
 .B [\-f slapd.conf]
+.B [\-F confdir]
 .B [\-l ldif-file]
-.B 
-.LP
 .SH DESCRIPTION
 .LP
 .B Slapadd
@@ -25,11 +28,20 @@ is used to add entries specified in LDAP Directory Interchange Format
 database.
 It opens the given database determined by the database number or
 suffix and adds entries corresponding to the provided LDIF to
-the database.  The LDIF input is read from standard input or
-the specified file.
+the database.
+Databases configured as
+.B subordinate
+of this one are also updated, unless \fB-g\fP is specified.
+The LDIF input is read from standard input or the specified file.
 .LP
-The LDIF generated by this tool is suitable for use with
-.BR slapcat (8).
+As
+.B slapadd
+is designed to accept LDIF in database order, as produced by
+.BR slapcat (8),
+it does not verify that superior entries exist before
+adding an entry, does not perform all user and system
+schema checks, and does not maintain operational
+attributes (such as createTimeStamp and modifiersName). 
 .SH OPTIONS
 .TP
 .B \-v
@@ -38,8 +50,29 @@ enable verbose mode.
 .B \-c
 enable continue (ignore errors) mode.
 .TP
-.B \-s
-disable schema and other checks.
+.B \-g
+disable subordinate gluing.  Only the specified database will be
+processed, and not its glued subordinates (if any).
+.TP
+.B \-u
+enable dry-run (don't write to backend) mode.
+.TP
+.B \-q
+enable quick (fewer integrity checks) mode.  Does fewer consistency checks
+on the input data, and no consistency checks when writing the database.
+Improves the load time but if any errors or interruptions occur the resulting
+database will be unusable.
+.TP
+.BI \-w
+write syncrepl context information.
+After all entries are added, the contextCSN
+will be updated with the greatest CSN in the database.
+.TP
+.BI \-s
+disable schema checking.  This option is intended to be used when loading
+databases containing special objects, such as fractional objects on a
+partial replica.  Loading normal objects which do not conform to
+schema may result in unexpected and ill behavior.
 .TP
 .BI \-d " level"
 enable debugging messages as defined by the specified
@@ -65,6 +98,20 @@ specify an alternative
 .BR slapd.conf (5)
 file.
 .TP
+.BI \-F " confdir"
+specify a config directory.
+If both
+.B -f
+and
+.B -F
+are specified, the config file will be read and converted to
+config directory format and written to the specified directory.
+If neither option is specified, an attempt to read the
+default config directory will be made before trying to use the default
+config file. If a valid config directory exists then the
+default config file is ignored. If dryrun mode is also specified,
+no conversion will occur.
+.TP
 .BI \-l " ldif-file"
 Read LDIF from the specified file instead of standard input.
 .SH LIMITATIONS
@@ -79,7 +126,7 @@ use
 .BR ldapadd (1)
 when adding new entries into an existing directory.
 .SH EXAMPLES
-To import a entries specified in file
+To import the entries specified in file
 .B ldif
 into your
 .BR slapd (8)
@@ -97,9 +144,9 @@ database give the command:
 .BR ldapadd (1),
 .BR slapd (8)
 .LP
-"OpenLDAP Administrator's Guide"
+"OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 .SH ACKNOWLEDGEMENTS
-.B     OpenLDAP
+.B OpenLDAP
 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
-.B     OpenLDAP
+.B OpenLDAP
 is derived from University of Michigan LDAP 3.3 Release.