Docs: bug notes

[exim.git] / doc / doc-docbook / spec.xfpt

diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt
index 3b90820317e5260a831d3a78e8d1a95dd7dcbc08..588afe1d248d7865ab97b8af85d14756e32789ba 100644 (file)
--- a/doc/doc-docbook/spec.xfpt
+++ b/doc/doc-docbook/spec.xfpt
@@ -219,6 +219,8 @@
 . at the top level, so we have to put the .chapter directive first.
 
 . These do not turn up in the HTML output, unfortunately.  The PDF does get them.
 . at the top level, so we have to put the .chapter directive first.
 
 . These do not turn up in the HTML output, unfortunately.  The PDF does get them.

+. - Worse - they introduce bugus index entries in the HTML, under the
+.  "primary term", a link to the Introduction chapter.

 . /////////////////////////////////////////////////////////////////////////////
 
 .chapter "Introduction" "CHID1"
 . /////////////////////////////////////////////////////////////////////////////
 
 .chapter "Introduction" "CHID1"


@@ -348,6 +350,10 @@
   <primary>headers</primary>
   <see><emphasis>header lines</emphasis></see>
 </indexterm>
   <primary>headers</primary>
   <see><emphasis>header lines</emphasis></see>
 </indexterm>

+. <indexterm role="concept">
+.   <primary>de-tainting</primary>
+.   <see><emphasis>tainted data</emphasis></see>
+. </indexterm>

 
 .literal off
 
 
 .literal off
 


@@ -2913,6 +2919,12 @@ defined and macros will be expanded.
 Because macros in the config file are often used for secrets, those are only
 available to admin users.
 
 Because macros in the config file are often used for secrets, those are only
 available to admin users.
 

+.new
+The word &"set"& at the start of a line, followed by a single space,
+is recognised specially as defining a value for a variable.
+The syntax is otherwise the same as the ACL modifier &"set ="&.
+.wen
+

 .vitem &%-bem%&&~<&'filename'&>
 .oindex "&%-bem%&"
 .cindex "testing" "string expansion"
 .vitem &%-bem%&&~<&'filename'&>
 .oindex "&%-bem%&"
 .cindex "testing" "string expansion"


@@ -32256,7 +32268,7 @@ different variants of this condition to describe briefly here. See sections
 .cindex "domain" "ACL checking"
 .cindex "&ACL;" "testing a recipient domain"
 .vindex "&$domain_data$&"
 .cindex "domain" "ACL checking"
 .cindex "&ACL;" "testing a recipient domain"
 .vindex "&$domain_data$&"

-This condition is relevant only after a RCPT command. It checks that the domain
+This condition is relevant only in a RCPT ACL. It checks that the domain

 of the recipient address is in the domain list. If percent-hack processing is
 enabled, it is done before this test is done. If the check succeeds with a
 lookup, the result of the lookup is placed in &$domain_data$& until the next
 of the recipient address is in the domain list. If percent-hack processing is
 enabled, it is done before this test is done. If the check succeeds with a
 lookup, the result of the lookup is placed in &$domain_data$& until the next


@@ -32324,7 +32336,7 @@ which gives a custom error message for each denied host.
 .cindex "local part" "ACL checking"
 .cindex "&ACL;" "testing a local part"
 .vindex "&$local_part_data$&"
 .cindex "local part" "ACL checking"
 .cindex "&ACL;" "testing a local part"
 .vindex "&$local_part_data$&"

-This condition is relevant only after a RCPT command. It checks that the local
+This condition is relevant only in a RCPT ACL. It checks that the local

 part of the recipient address is in the list. If percent-hack processing is
 enabled, it is done before this test. If the check succeeds with a lookup, the
 result of the lookup is placed in &$local_part_data$&, which remains set until
 part of the recipient address is in the list. If percent-hack processing is
 enabled, it is done before this test. If the check succeeds with a lookup, the
 result of the lookup is placed in &$local_part_data$&, which remains set until


@@ -32358,7 +32370,7 @@ messages. Details are given in section &<<SECTratelimiting>>&.
 .cindex "&%recipients%& ACL condition"
 .cindex "recipient" "ACL checking"
 .cindex "&ACL;" "testing a recipient"
 .cindex "&%recipients%& ACL condition"
 .cindex "recipient" "ACL checking"
 .cindex "&ACL;" "testing a recipient"

-This condition is relevant only after a RCPT command. It checks the entire
+This condition is relevant only in a RCPT ACL. It checks the entire

 recipient address against a list of recipients.
 
 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
 recipient address against a list of recipients.
 
 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>


@@ -32370,7 +32382,7 @@ non-SMTP ACLs. It causes the incoming message to be scanned for a match with
 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
 
 .vitem &*seen&~=&~*&<&'parameters'&>
 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
 
 .vitem &*seen&~=&~*&<&'parameters'&>

-.cindex "&%sseen%& ACL condition"
+.cindex "&%seen%& ACL condition"

 This condition can be used to test if a situation has been previously met,
 for example for greylisting.
 Details are given in section &<<SECTseen>>&.
 This condition can be used to test if a situation has been previously met,
 for example for greylisting.
 Details are given in section &<<SECTseen>>&.


@@ -33099,7 +33111,7 @@ address you should specify alternate list separators for both the outer
 
 
 .section "Previously seen user and hosts" "SECTseen"
 
 
 .section "Previously seen user and hosts" "SECTseen"

-.cindex "&%sseen%& ACL condition"
+.cindex "&%een%& ACL condition"

 .cindex greylisting
 The &%seen%& ACL condition can be used to test whether a
 situation has been previously met.
 .cindex greylisting
 The &%seen%& ACL condition can be used to test whether a
 situation has been previously met.


@@ -33595,7 +33607,7 @@ clients when the SMTP PIPELINING extension is in use. The flushing can be
 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
 
 .cindex "tainted data" "de-tainting"
 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
 
 .cindex "tainted data" "de-tainting"

-.cindex "de-tainting" "using receipient verify"
+.cindex "de-tainting" "using recipient verify"

 A recipient callout which gets a 2&'xx'& code
 will assign untainted values to the
 &$domain_data$& and &$local_part_data$& variables,
 A recipient callout which gets a 2&'xx'& code
 will assign untainted values to the
 &$domain_data$& and &$local_part_data$& variables,