From cd16a93244e42f754fa845b78b43601326a6f24d Mon Sep 17 00:00:00 2001 From: Jong Hyuk Choi Date: Sun, 21 Dec 2003 16:32:00 +0000 Subject: [PATCH] update syncrepl and session log info --- doc/man/man5/slapd-bdb.5 | 19 ++++++++++----- doc/man/man8/slapadd.8 | 50 +++++++++++++++++++++++----------------- doc/man/man8/slapcat.8 | 20 ++++++++++++---- doc/man/man8/slapd.8 | 23 +++++++++--------- 4 files changed, 69 insertions(+), 43 deletions(-) diff --git a/doc/man/man5/slapd-bdb.5 b/doc/man/man5/slapd-bdb.5 index d24bd0cff4..4342574c7f 100644 --- a/doc/man/man5/slapd-bdb.5 +++ b/doc/man/man5/slapd-bdb.5 @@ -133,12 +133,19 @@ region that will house the environment. .TP .B sessionlog Specify a session log store for the syncrepl replication provider -site which contains information on the entries that have been scoped -out of the content of the replication session identified by {{EX:}}. -The number of entries in the session log store is limited -by {{EX:}}. Excessive entries are removed from the store -in the FIFO order. Both {{EX:}} and {{EX:}} are -non-negative integers. {{EX:}} has no more than three digits. +server. The session log store contains information on the entries that +have been scoped out of the provider replication content identified by +.B . +The number of entries in the session log store is limited by +.B . +Excessive entries are removed from the store in the FIFO order. +Both +.B +and +.B +are non-negative integers. +.B +has no more than three decimal digits. Refer to the "OpenLDAP Administrator's Guide" for detailed information on setting up a replicated slapd directory service using the syncrepl replication engine and the session log store. diff --git a/doc/man/man8/slapadd.8 b/doc/man/man8/slapadd.8 index 2f4a4ec174..a71696faaa 100644 --- a/doc/man/man8/slapadd.8 +++ b/doc/man/man8/slapadd.8 @@ -9,9 +9,13 @@ slapadd \- Add entries to a SLAPD database .B [\-v] .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 [\-l ldif-file] .B @@ -47,6 +51,26 @@ enable continue (ignore errors) mode. .B \-u enable dry-run (don't write to backend) mode. .TP +.BI \-p +If the LDIF input represents a syncrepl consumer replica, +promote it to the syncrepl provider's content after adding +the entries. +.TP +.BI \-r +If the LDIF input represents a syncrepl provider replica, +demote it to the syncrepl consumer replica after adding +the entries. +.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. +.TP .BI \-d " level" enable debugging messages as defined by the specified .IR level . @@ -66,6 +90,11 @@ 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. +.TP .BI \-f " slapd.conf" specify an alternative .BR slapd.conf (5) @@ -73,27 +102,6 @@ file. .TP .BI \-l " ldif-file" Read LDIF from the specified file instead of standard input. -.TP -.BI \-p -If the LDIF input represents a syncrepl consumer replica, -promote it to the syncrepl provider replica after adding -the entries. -.TP -.BI \-r -If the LDIF input represents a syncrepl provider replica, -demote it to the syncrepl consumer replica after adding -the entries. -.TP -.BI \-w -When used with \-p or \-r, rebuild a new syncrepl -information from the contents of the added entries. -The syncrepl information contained in the LDIF input -file is ignored. -.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. .SH LIMITATIONS Your .BR slapd (8) diff --git a/doc/man/man8/slapcat.8 b/doc/man/man8/slapcat.8 index e53faf497c..ae9e561963 100644 --- a/doc/man/man8/slapcat.8 +++ b/doc/man/man8/slapcat.8 @@ -8,6 +8,8 @@ slapcat \- SLAPD database to LDIF utility .B SBINDIR/slapcat .B [\-v] .B [\-c] +.B [\-k] +.B [\-m] .B [\-d level] .B [\-b suffix] .B [\-n dbnum] @@ -36,13 +38,23 @@ without first being reordered. .SH OPTIONS .TP .B \-v -enable verbose mode. +Enable verbose mode. .TP .B \-c -enable continue (ignore errors) mode. +Enable continue (ignore errors) mode. +.TP +.B \-k +Include +.B syncConsumerSubentry +of the syncrepl consumer in the generated LDIF output. +.TP +.B \-m +Include +.B syncProviderSubentry +of the syncrepl provider in the generated LDIF output. .TP .BI \-d " level" -enable debugging messages as defined by the specified +Enable debugging messages as defined by the specified .IR level . .TP .BI \-b " suffix" @@ -69,7 +81,7 @@ or option is given. .TP .BI \-f " slapd.conf" -specify an alternative +Specify an alternative .BR slapd.conf (5) file. .TP diff --git a/doc/man/man8/slapd.8 b/doc/man/man8/slapd.8 index 38cfc4b977..2d5d8585b0 100644 --- a/doc/man/man8/slapd.8 +++ b/doc/man/man8/slapd.8 @@ -13,6 +13,7 @@ slapd \- Stand-alone LDAP Daemon .B [\-n service\-name] [\-s syslog\-level] [\-l syslog\-local\-user] .B [\-r directory] .B [\-u user] [\-g group] [\-t] +.B [\-c cookie] .B .SH DESCRIPTION .LP @@ -172,7 +173,7 @@ will read the configuration file (the default if none is given with the or database. .TP .BI \-c " cookie" -This option provides a cookie for a syncrepl replication consumer. +This option provides a cookie for the syncrepl replication consumer. The cookie is a comma separated list of name=value pairs. Currently supported syncrepl cookie fields are .B csn, @@ -180,20 +181,18 @@ Currently supported syncrepl cookie fields are and .B rid. .B csn -is the commit sequence number of the master content at the provider site -and represents the state of the content to which the replica content -was synchronized most recently. +is the commit sequence number received by a previous synchronization +and represents the state of the consumer replica content which the +syncrepl engine will synchronize to the current provider content. .B sid -is the identity of the session which this replication thread belongs to. -The replication provider site may maintain a session history store -for each replication session to reduce synchronization traffic. +is the identity of the per-scope session log with which the +provider server can process this syncrepl request to reduce +synchronization traffic. .B rid -identifies a replication thread within a replication consumer site -and is used to find the replication thread specification of +identifies a replication thread within the consumer server +and is used to find the syncrepl specification in .BR slapd.conf (5) -having the same -.B rid -value as the cookie. +having the matching replication identifier in its definition. .SH EXAMPLES To start .I slapd -- 2.39.5