Tidying: massage to project coding style
[exim.git] / doc / doc-docbook / spec.xfpt
index 04f2387cfb4e94371fa7eb655c82f952bb0dabb2..b3c9abb8719181dc2d5455c3078b8b8469e20961 100644 (file)
@@ -4020,7 +4020,7 @@ user.
 This option requests Exim to give up trying to deliver the listed messages,
 including any that are frozen. However, if any of the messages are active,
 their status is not altered. For non-bounce messages, a delivery error message
-is sent to the sender, containing the text &"cancelled by administrator"&.
+is sent to the sender.
 Bounce messages are just discarded. This option can be used only by an admin
 user.
 
@@ -8234,7 +8234,7 @@ daemon as in the other SQL databases.
 .oindex &%sqlite_dbfile%&
 There are two ways of
 specifying the file.
-The first is is by using the &%sqlite_dbfile%& main option.
+The first is by using the &%sqlite_dbfile%& main option.
 The second, which allows separate files for each query,
 is to use an option appended, comma-separated, to the &"sqlite"&
 lookup type word.  The option is the word &"file"&, then an equals,
@@ -12088,6 +12088,10 @@ Exim was built with the EXPAND_LISTMATCH_RHS option.
 
 Consult section &<<SECThoslispatip>>& for further details of these patterns.
 
+The variable &$value$& will be set for a successful match and can be
+used in the success clause of an &%if%& expansion item using the condition.
+Any previous &$value$& is restored after the if.
+
 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
 .cindex "domain list" "in expansion condition"
 .cindex "address list" "in expansion condition"
@@ -19181,12 +19185,25 @@ This applies to all of the SRV, MX, AAAA, A lookup sequence.
 .cindex "router" "restricting to specific domains"
 .vindex "&$domain_data$&"
 If this option is set, the router is skipped unless the current domain matches
-the list. If the match is achieved by means of a file lookup, the data that the
-lookup returned for the domain is placed in &$domain_data$& for use in string
+the list.
+The data returned by the list check
+is placed in &$domain_data$& for use in string
 expansions of the driver's private options and in the transport.
 See section &<<SECTrouprecon>>& for
 a list of the order in which preconditions are evaluated.
 
+A complex example, using a file like:
+.code
+alice@dom1
+bill@dom1
+maggie@dom1
+.endd
+and checking both domain and local_part
+.code
+domains =         ${domain:${lookup {$local_part@$domain} lseach,ret=key {/path/to/accountsfile}}}
+local_parts = ${local_part:${lookup {$local_part@$domain} lseach,ret=key {/path/to/accountsfile}}}
+.endd
+
 
 
 .option driver routers string unset
@@ -19550,7 +19567,7 @@ example:
 local_parts = dbm;/usr/local/specials/$domain_data
 .endd
 .vindex "&$local_part_data$&"
-If the match is achieved by a lookup, the data that the lookup returned
+the data returned by the list check
 for the local part is placed in the variable &$local_part_data$& for use in
 expansions of the router's private options or in the transport.
 You might use this option, for
@@ -29229,8 +29246,7 @@ When using OpenSSL, this option is ignored.
 (If an API is found to let OpenSSL be configured in this way,
 let the Exim Maintainers know and we'll likely use it).
 .next
-With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
-main option, it must be ordered to match the &%tls_certificate%& list.
+With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option, it must be ordered to match the &%tls_certificate%& list.
 .next
 Some other recently added features may only be available in one or the other.
 This should be documented with the feature.  If the documentation does not
@@ -30324,7 +30340,7 @@ DNSSEC.
 .next
 Add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
 .next
-Offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
+Offer a server certificate, or certificate chain, in TLS connections which is anchored by one of the TLSA records.
 .endlist
 
 There are no changes to Exim specific to server-side operation of DANE.
@@ -42010,7 +42026,7 @@ option.
 
 .endlist
 
-In addition, two ACL conditions are provided:
+In addition, two ACL conditions are provided, usable only in a DKIM ACL:
 
 .vlist
 .vitem &%dkim_signers%&
@@ -42278,18 +42294,30 @@ encoding operation.
 If this value is empty the the expansion result will be empty.
 The third argument should be the recipient domain of the message when
 it arrived at this system.
+All arguments are expanded before use.
+
+The result of the expansion is the replacement envelope-from (return path)
+to be used.
 .endlist
 
 .cindex SRS decoding
 To decode an address use this expansion condition:
 .vlist
 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
-The first argument should be the recipient local prt as is was received.
+The first argument should be the recipient local part as it was received.
 The second argument is the site secret.
+Both arguments are expanded before use.
 
 If the messages is not for an SRS-encoded recipient the condition will
-return false.  If it is, the condition will return true and the variable
+return false.
+If it is, the condition will return true and the variable
 &$srs_recipient$& will be set to the decoded (original) value.
+
+.new
+If the second argument is empty then the condition returns true if
+the first argument is in valid SRS formet, else false.
+The variable &$srs_recipient$& is not set for this case.
+.wen
 .endlist
 
 Example usage:
@@ -42988,8 +43016,8 @@ All other message types ignore the result string, and
 no other use is made of it.
 
 For a tcp:connect event, if the connection is being made to a proxy
-then the address and port variables will be that of the proxy and not
-the target system.
+then the &$host_address$& and &$host_port$& variables
+will be that of the proxy and not the target system.
 
 For tls:cert events, if GnuTLS is in use this will trigger only per
 chain element received on the connection.