]> git.sur5r.net Git - openldap/blobdiff - doc/man/man8/slapadd.8
add clarification related to ITS#5166
[openldap] / doc / man / man8 / slapadd.8
index 55256c6bf7247c5fb27e1572c40fd5d1bda00ddf..2c4e08088f7c7a42525335f570ce576865dc9518 100644 (file)
@@ -1,23 +1,27 @@
 .TH SLAPADD 8C "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
-.\" Copyright 1998-2005 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
 .SH SYNOPSIS
 .B SBINDIR/slapadd
-.B [\-v]
+.B [\-b suffix]
 .B [\-c]
-.B [\-u]
-.B [\-p]
-.B [\-r]
-.B [\-w]
 .B [\-d level]
-.B [\-b suffix]
-.B [\-n dbnum]
-.B [\-i rid1,rid2,...]
 .B [\-f slapd.conf]
+.B [\-F confdir]
+.B [\-g]
+.B [\-j lineno]
 .B [\-l ldif-file]
+.B [\-n dbnum]
+.B [\-o name[=value]
+.B [\-q]
+.B [\-s]
+.B [\-S SID]
+.B [\-u]
+.B [\-v]
+.B [\-w]
 .SH DESCRIPTION
 .LP
 .B Slapadd
@@ -27,57 +31,75 @@ 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.
-.LP
-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). 
+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.
+
+All files eventually created by
+.BR slapadd (8)
+will belong to the identity
+.BR slapadd (8)
+is run as, so make sure you either run
+.BR slapadd (8)
+with the same identity
+.BR slapd (8)
+will be run as (see option
+.B \-u
+in
+.BR slapd (8)),
+or change file ownership before running
+.BR slapd (8).
 .SH OPTIONS
 .TP
-.B \-v
-enable verbose mode.
+.BI \-b " suffix" 
+Use the specified \fIsuffix\fR to determine which database to
+add entries to.  The \-b cannot be used in conjunction
+with the
+.B \-n
+option.
 .TP
 .B \-c
 enable continue (ignore errors) mode.
 .TP
-.B \-u
-enable dry-run (don't write to backend) mode.
+.BI \-d " level"
+enable debugging messages as defined by the specified
+.IR level ;
+see
+.BR slapd (8)
+for details.
 .TP
-.BI \-p
-If the LDIF input represents a syncrepl consumer replica,
-promote it to the syncrepl provider's content after adding
-the entries.
+.BI \-f " slapd.conf"
+specify an alternative
+.BR slapd.conf (5)
+file.
 .TP
-.BI \-r
-If  the  LDIF  input represents a  syncrepl  provider, demote 
-it  to  the syncrepl consumer replica after adding the entries.
+.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 \-w
-When used with either 
-.B \-p
-or
-.B \-r,
-rebuild the new syncrepl
-information from the contents of the added entries.
-The syncrepl information contained in the LDIF input
-file is ignored.
+.B \-g
+disable subordinate gluing.  Only the specified database will be
+processed, and not its glued subordinates (if any).
 .TP
-.BI \-d " level"
-enable debugging messages as defined by the specified
-.IR level .
+.BI \-j " lineno"
+Jump to the specified line number in the LDIF file before processing
+any entries. This allows a load that was aborted due to errors in the
+input LDIF to be resumed after the errors are corrected.
 .TP
-.BI \-b " suffix" 
-Use the specified \fIsuffix\fR to determine which database to
-add entries to.  The \-b cannot be used in conjunction
-with the
-.B \-n
-option.
+.BI \-l " ldif-file"
+Read LDIF from the specified file instead of standard input.
 .TP
 .BI \-n " dbnum"
 Add entries to the \fIdbnum\fR\-th database listed in the
@@ -87,18 +109,46 @@ cannot be used in conjunction with the
 .B \-b
 option.
 .TP
-.BI \-i " rid1,rid2,..."
-Specify the replication ids for one or more syncrepl consumer
-replicas contained in the LDIF input. If omitted, 0 is used
-as the replication id.
+.BI \-o " option[=value]"
+Specify an
+.BR option
+with a(n optional)
+.BR value .
+Possible generic options/values are:
+.LP
+.nf
+              syslog=<subsystems>  (see `\-s' in slapd(8))
+              syslog-level=<level> (see `\-S' in slapd(8))
+              syslog-user=<user>   (see `\-l' in slapd(8))
+
+.fi
+.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 \-f " slapd.conf"
-specify an alternative
-.BR slapd.conf (5)
-file.
+.B -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 \-l " ldif-file"
-Read LDIF from the specified file instead of standard input.
+.B \-S " SID"
+Server ID to use in generated entryCSN.  Also used for contextCSN
+if `\-w' is set as well.  Defaults to 0.
+.TP
+.B \-u
+enable dry-run (don't write to backend) mode.
+.TP
+.B \-v
+enable verbose mode.
+.TP
+.BI \-w
+write syncrepl context information.
+After all entries are added, the contextCSN
+will be updated with the greatest CSN in the database.
 .SH LIMITATIONS
 Your
 .BR slapd (8)
@@ -131,7 +181,4 @@ database give the command:
 .LP
 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 .SH ACKNOWLEDGEMENTS
-.B OpenLDAP
-is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
-.B OpenLDAP
-is derived from University of Michigan LDAP 3.3 Release.  
+.so ../Project