X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=doc%2Fman%2Fman8%2Fslapadd.8;h=e7717b9a8c4f873bd7929993ab05c038fe33fbba;hb=c216e1809971ac6c5b2b973501e0e8a766b77287;hp=d150e5d744027504985cec311d5a0e6e673546b0;hpb=f2af052a67946cb9e0b9074969ae3b481a25a622;p=openldap

diff --git a/doc/man/man8/slapadd.8 b/doc/man/man8/slapadd.8
index d150e5d744..e7717b9a8c 100644
--- a/doc/man/man8/slapadd.8
+++ b/doc/man/man8/slapadd.8
@@ -1,27 +1,43 @@
 .TH SLAPADD 8C "RELEASEDATE" "OpenLDAP LDVERSION"
-.\" $OpenLDAP$
-.\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2013 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
+.\" $OpenLDAP$
 .SH NAME
 slapadd \- Add entries to a SLAPD database
 .SH SYNOPSIS
 .B SBINDIR/slapadd
-.B [\-b suffix]
-.B [\-c]
-.B [\-d level]
-.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]
+[\c
+.BI \-b \ suffix\fR]
+[\c
+.BR \-c ]
+[\c
+.BI \-d \ debug-level\fR]
+[\c
+.BI \-f \ slapd.conf\fR]
+[\c
+.BI \-F \ confdir\fR]
+[\c
+.BR \-g ]
+[\c
+.BI \-j \ lineno\fR]
+[\c
+.BI \-l \ ldif-file\fR]
+[\c
+.BI \-n \ dbnum\fR]
+[\c
+.BI \-o \ option\fR[ = value\fR]]
+[\c
+.BR \-q ]
+[\c
+.BR \-s ]
+[\c
+.BI \-S \ SID\fR]
+[\c
+.BR \-u ]
+[\c
+.BR \-v ]
+[\c
+.BR \-w ]
 .SH DESCRIPTION
 .LP
 .B Slapadd
@@ -34,7 +50,7 @@ suffix and adds entries corresponding to the provided LDIF to
 the database.
 Databases configured as
 .B subordinate
-of this one are also updated, unless \fB-g\fP is specified.
+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
@@ -51,11 +67,15 @@ in
 .BR slapd (8)),
 or change file ownership before running
 .BR slapd (8).
+
+Note: slapadd will also perform the relevant indexing whilst adding the database if
+any are configured. For specfic details, please see 
+.BR slapindex (8).
 .SH OPTIONS
 .TP
-.BI \-b " suffix" 
+.BI \-b \ suffix 
 Use the specified \fIsuffix\fR to determine which database to
-add entries to.  The \-b cannot be used in conjunction
+add entries to.  The \fB\-b\fP cannot be used in conjunction
 with the
 .B \-n
 option.
@@ -63,65 +83,77 @@ option.
 .B \-c
 enable continue (ignore errors) mode.
 .TP
-.BI \-d " level"
+.BI \-d \ debug-level
 enable debugging messages as defined by the specified
-.IR level ;
+.IR debug-level ;
 see
 .BR slapd (8)
 for details.
 .TP
-.BI \-f " slapd.conf"
+.BI \-f \ slapd.conf
 specify an alternative
 .BR slapd.conf (5)
 file.
 .TP
-.BI \-F " confdir"
+.BI \-F \ confdir
 specify a config directory.
 If both
-.B -f
+.B \-f
 and
-.B -F
+.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,
+default config file is ignored. If dry-run mode is also specified,
 no conversion will occur.
 .TP
 .B \-g
 disable subordinate gluing.  Only the specified database will be
 processed, and not its glued subordinates (if any).
 .TP
-.BI \-j " lineno"
+.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 \-l " ldif-file"
+.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
+.BI \-n \ dbnum
+Add entries to the \fIdbnum\fR-th database listed in the
 configuration file.  The
 .B \-n
 cannot be used in conjunction with the
 .B \-b
 option.
-.TP
-.BI \-o " option[=value]"
+To populate the config database
+.BR slapd\-config (5),
+use 
+.B \-n 0
+as it is always the first database. It must physically exist
+on the filesystem prior to this, however.
+.TP
+.BI \-o \ option\fR[ = value\fR]
 Specify an
-.BR option
+.I option
 with a(n optional)
-.BR value .
+.IR 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))
+              syslog\-level=<level> (see `\-S' in slapd(8))
+              syslog\-user=<user>   (see `\-l' in slapd(8))
 
-.fi
+              schema-check={yes|no}
+              value-check={yes|no}
+
+.in
+The \fIschema\-check\fR option toggles schema checking (default on);
+the \fIvalue\-check\fR option toggles value checking (default off).
+The latter is incompatible with \fB-q\fR.
 .TP
 .B \-q
 enable quick (fewer integrity checks) mode.  Does fewer consistency checks
@@ -129,15 +161,15 @@ 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
-.B -s
+.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
-.B \-S " SID"
+.BI \-S \ SID
 Server ID to use in generated entryCSN.  Also used for contextCSN
-if `\-w' is set as well.  Defaults to 0.
+if \fB\-w\fP is set as well.  Defaults to \fB0\fP.
 .TP
 .B \-u
 enable dry-run (don't write to backend) mode.
@@ -169,13 +201,14 @@ database give the command:
 .LP
 .nf
 .ft tt
-	SBINDIR/slapadd -l ldif
+	SBINDIR/slapadd \-l ldif
 .ft
 .fi
 .SH "SEE ALSO"
 .BR ldap (3),
 .BR ldif (5),
 .BR slapcat (8),
+.BR slapindex (8),
 .BR ldapadd (1),
 .BR slapd (8)
 .LP