ITS#8544 - Grammar and escaping fixes

[openldap] / doc / man / man5 / slapd-config.5

diff --git a/doc/man/man5/slapd-config.5 b/doc/man/man5/slapd-config.5
index c5bf06f7a6c8a5450d0be2e73252870dab1164e8..fcb06dcbba6f54f65177c777ad37ac2bba75ed7e 100644 (file)
--- a/doc/man/man5/slapd-config.5
+++ b/doc/man/man5/slapd-config.5
@@ -1,5 +1,5 @@
 .TH SLAPD-CONFIG 5 "RELEASEDATE" "OpenLDAP LDVERSION"
-.\" Copyright 1998-2014 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2017 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .\" $OpenLDAP$
 .SH NAME
@@ -89,7 +89,7 @@ child entries corresponding
 to any overlays configured on the database. The olcDatabase and
 olcOverlay entries may also have miscellaneous child entries for
 other settings as needed. There are two special database entries
-that are predefined - one is an entry for the config database itself,
+that are predefined \- one is an entry for the config database itself,
 and the other is for the "frontend" database. Settings in the
 frontend database are inherited by the other databases, unless
 they are explicitly overridden in a specific database.
@@ -452,7 +452,7 @@ A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
 will stop listening for new connections, but will not close the
 connections to the current clients.  Future write operations return
 unwilling-to-perform, though.  Slapd terminates when all clients
-have closed their connections (if they ever do), or - as before -
+have closed their connections (if they ever do), or \- as before \-
 if it receives a SIGTERM signal.  This can be useful if you wish to
 terminate the server and start a new
 .B slapd
@@ -888,9 +888,9 @@ token name first, followed by a colon:
 .nf
        olcTLSCertificateFile: my hardware device:Server-Cert
 .fi
-Use certutil -L to list the certificates by name:
+Use certutil \-L to list the certificates by name:
 .nf
-       certutil -d /path/to/certdbdir -L
+       certutil \-d /path/to/certdbdir \-L
 .fi
 .TP
 .B olcTLSCertificateKeyFile: <filename>
@@ -911,7 +911,7 @@ protection for the cert/key database.  For example, if olcTLSCACertificatePath
 specifes /etc/openldap/certdb as the location of the cert/key database, use
 modutil to change the password to the empty string:
 .nf
-       modutil -dbdir /etc/openldap/certdb -changepw 'NSS Certificate DB'
+       modutil \-dbdir /etc/openldap/certdb \-changepw 'NSS Certificate DB'
 .fi
 You must have the old password, if any.  Ignore the WARNING about the running
 browser.  Press 'Enter' for the new password.
@@ -1303,7 +1303,7 @@ is equivalent to
 (see above).
 The 
 .B extended
-keyword allows to indicate the OID of the specific operation
+keyword allows one to indicate the OID of the specific operation
 to be restricted.
 .TP
 .B olcSchemaDN: <dn>
@@ -1618,8 +1618,8 @@ The keyword
 indicates that no limit is applied to the pagedResults control page size.
 The syntax
 .B size.prtotal={<integer>|unlimited|disabled}
-allows to set a limit on the total number of entries that a pagedResults
-control allows to return.
+allows one to set a limit on the total number of entries that the pagedResults
+control will return.
 By default it is set to the 
 .B hard
 limit.
@@ -1794,13 +1794,14 @@ FALSE, meaning the contextCSN is stored in the context entry.
 .B [tls_cacert=<file>]
 .B [tls_cacertdir=<path>]
 .B [tls_reqcert=never|allow|try|demand]
-.B [tls_ciphersuite=<ciphers>]
+.B [tls_cipher_suite=<ciphers>]
 .B [tls_crlcheck=none|peer|all]
 .B [tls_protocol_min=<major>[.<minor>]]
 .B [suffixmassage=<real DN>]
 .B [logbase=<base DN>]
 .B [logfilter=<filter str>]
 .B [syncdata=default|accesslog|changelog]
+.B [lazycommit]
 .RS
 Specify the current database as a replica which is kept up-to-date with the 
 master content by establishing the current
@@ -1868,7 +1869,11 @@ operation, a synchronization search remains persistent in the provider slapd.
 Further updates to the master replica will generate
 .B searchResultEntry
 to the consumer slapd as the search responses to the persistent
-synchronization search.
+synchronization search. If the initial search fails due to an error, the
+next synchronization search operation is periodically rescheduled at an
+interval time (specified by
+.B interval
+parameter; 1 day by default)
 
 If an error occurs during replication, the consumer will attempt to
 reconnect according to the
@@ -1980,6 +1985,12 @@ to the obsolete \fIchangelog\fP format. If the
 .B syncdata
 parameter is omitted or set to "default" then the log parameters are
 ignored.
+
+The
+.B lazycommit
+parameter tells the underlying database that it can store changes without
+performing a full flush after each change. This may improve performance
+for the consumer, while sacrificing safety or durability.
 .RE
 .TP
 .B olcUpdateDN: <dn>