Added some index entries for the "hide" option (or option prefix). Closes: bug 524.
[exim.git] / doc / doc-docbook / spec.xfpt
index b3d2111c421dd1ca264d81415aa8e9e9c0168e6b..9091e60ec14a3d2547828e3fa078e7ec5168f806 100644 (file)
@@ -1,4 +1,4 @@
-. $Cambridge: exim/doc/doc-docbook/spec.xfpt,v 1.17 2007/04/12 10:56:02 ph10 Exp $
+. $Cambridge: exim/doc/doc-docbook/spec.xfpt,v 1.23 2007/08/25 12:33:01 magnus Exp $
 .
 . /////////////////////////////////////////////////////////////////////////////
 . This is the primary source of the Exim Manual. It is an xfpt document that is
@@ -2938,6 +2938,7 @@ arguments, for example:
 .code
 exim -bP qualify_domain hold_domains
 .endd
+.oindex "&%hide%&"
 However, any option setting that is preceded by the word &"hide"& in the
 configuration file is not shown in full, except to an admin user. For other
 users, the output is as in this example:
@@ -4749,6 +4750,9 @@ space) and then the value. For example:
 .code
 qualify_domain = mydomain.example.com
 .endd
+.oindex "&%hide%&"
+.cindex "configuration file" "hiding sensitive data"
+.cindex "options" "hiding from extraction"
 Some option settings may contain sensitive data, for example, passwords for
 accessing databases. To stop non-admin users from using the &%-bP%& command
 line option to read these values, you can precede the option settings with the
@@ -10681,7 +10685,7 @@ lookup.
 
 .vitem &$load_average$&
 .vindex "&$load_average$&"
-This variable contains the system load average, multiplied by 1000 to that it
+This variable contains the system load average, multiplied by 1000 so that it
 is an integer. For example, if the load average is 0.21, the value of the
 variable is 210. The value is recomputed every time the variable is referenced.
 
@@ -12949,7 +12953,7 @@ removed at the time the message is received, to avoid any problems that might
 occur when a delivered message is subsequently sent on to some other recipient.
 
 .new
-.option disable_fnync main boolean false
+.option disable_fsync main boolean false
 .cindex "&[fsync()]&, disabling"
 This option is available only if Exim was built with the compile-time option
 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
@@ -15327,10 +15331,9 @@ lookups (though Exim does cache lookups).
 
 The &%address_data%& facility is also useful as a means of passing information
 from one router to another, and from a router to a transport. In addition, if
-
 .vindex "&$sender_address_data$&"
 .vindex "&$address_data$&"
-When &$address_data$& is set by a router when verifying a recipient address
+&$address_data$& is set by a router when verifying a recipient address
 from an ACL, it remains available for use in the rest of the ACL statement.
 After verifying a sender, the value is transferred to &$sender_address_data$&.
 
@@ -23685,13 +23688,13 @@ dovecot_plain:
   driver = dovecot
   public_name = PLAIN
   server_socket = /var/run/dovecot/auth-client
-  server_setid = $auth1
+  server_set_id = $auth1
 
 dovecot_ntlm:
   driver = dovecot
   public_name = NTLM
   server_socket = /var/run/dovecot/auth-client
-  server_setid = $auth1
+  server_set_id = $auth1
 .endd
 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
 &$received_ip_address$& (that is, the connection is local), the &"secured"&
@@ -25171,7 +25174,7 @@ log entry.
 If you want to apply a control unconditionally, you can use it with a
 &%require%& verb. For example:
 .code
-    require  control = no_multiline_response
+    require  control = no_multiline_responses
 .endd
 .endlist
 
@@ -25535,7 +25538,7 @@ only to the current message, not to any subsequent ones that may be received in
 the same SMTP connection. It is provided for debugging purposes and is unlikely
 to be useful in production.
 
-.vitem &*control&~=&~no_multiline_response*&
+.vitem &*control&~=&~no_multiline_responses*&
 .cindex "multiline responses, suppressing"
 This control is permitted for any ACL except the one for non-SMTP messages.
 It seems that there are broken clients in use that cannot handle multiline