Docs: tidying
[exim.git] / doc / doc-docbook / spec.xfpt
index 8055daebeb5f9c0b170649f3edb8f427655fe29b..b8173a1b836773090bd95e8649d903e91d62c959 100644 (file)
@@ -444,10 +444,11 @@ Please do not ask for configuration help in the bug-tracker.
 The following Exim mailing lists exist:
 
 .table2 140pt
-.row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
-.row &'exim-users@exim.org'&      "General discussion list"
-.row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
-.row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
+.row &'exim-announce@lists.exim.org'&   "Moderated, low volume announcements list"
+.row &'exim-users@lists.exim.org'&      "General discussion list"
+.row &'exim-users-de@lists.exim.org'&   "General discussion list in German language"
+.row &'exim-dev@lists.exim.org'&        "Discussion of bugs, enhancements, etc."
+.row &'exim-cvs@lists.exim.org'&        "Automated commit messages from the VCS"
 .endtable
 
 You can subscribe to these lists, change your existing subscriptions, and view
@@ -952,7 +953,7 @@ User filters are run as part of the routing process, described below.
 .cindex "exim_msgdate"
 Every message handled by Exim is given a &'message id'& which is sixteen
 characters long. It is divided into three parts, separated by hyphens, for
-example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
+example &`16VDhn-000000001bo-D342`&. Each part is a sequence of letters and digits,
 normally encoding numbers in base 62. However, in the Darwin operating
 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
 (avoiding the use of lower case letters) is used instead, because the message
@@ -973,21 +974,29 @@ started to be received, to a granularity of one second. That is, this field
 contains the number of seconds since the start of the epoch (the normal Unix
 way of representing the date and time of day).
 .next
-After the first hyphen, the next six characters are the id of the process that
-received the message.
+After the first hyphen, the next
+.new
+eleven
+.wen
+characters are the id of the process that received the message.
 .next
-There are two different possibilities for the final two characters:
+.new
+There are two different possibilities for the final four characters:
 .olist
 .oindex "&%localhost_number%&"
 If &%localhost_number%& is not set, this value is the fractional part of the
-time of reception, normally in units of 1/2000 of a second, but for systems
+time of reception, normally in units of
+microseconds.
+but for systems
 that must use base 36 instead of base 62 (because of case-insensitive file
-systems), the units are 1/1000 of a second.
+systems), the units are
+2 us.
 .next
-If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
-the fractional part of the time, which in this case is in units of 1/200
-(1/100) of a second.
+If &%localhost_number%& is set, it is multiplied by
+500000 (250000) and added to
+the fractional part of the time, which in this case is in units of 2 us (4 us).
 .endlist
+.wen
 .endlist
 
 After a message has been received, Exim waits for the clock to tick at the
@@ -6723,6 +6732,12 @@ version of the lookup key.
 The &'query-style'& type accepts a generalized database query. No particular
 key value is assumed by Exim for query-style lookups. You can use whichever
 Exim variables you need to construct the database query.
+
+For the string-expansion kind of lookups, the query is given in the first
+bracketed argument of the &${lookup ...}$& expansion.
+For the list-argument kind of lookup the quury is given by the remainder of the
+list item after the first semicolon.
+
 .cindex "tainted data" "quoting for lookups"
 If tainted data is used in the query then it should be quuted by
 using the &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*& expansion operator
@@ -7363,10 +7378,15 @@ of the following form is provided:
 .code
 ${quote_<lookup-type>:<string>}
 .endd
-For example, the safest way to write the NIS+ query is
+For example, the way to write the NIS+ query is
 .code
 [name="${quote_nisplus:$local_part}"]
 .endd
+.cindex "tainted data" "in lookups"
+.new
+&*All*& tainted data used in a quoery-style lookup must be quoted
+using a mechanism appropriate for the lookup type.
+.wen
 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
 operator can be used for all lookup types, but has no effect for single-key
 lookups, since no quoting is ever needed in their key strings.
@@ -10587,12 +10607,13 @@ expansion items.
 This item inserts &"raw"& header lines. It is described with the &%header%&
 expansion item in section &<<SECTexpansionitems>>& above.
 
-.vitem "&*${run <&'options'&> {*&<&'command&~arg&~list'&>&*}{*&<&'string1'&>&*}&&&
+.vitem "&*${run<&'options'&> {*&<&'command&~arg&~list'&>&*}{*&<&'string1'&>&*}&&&
         {*&<&'string2'&>&*}}*&"
 .cindex "expansion" "running a command"
 .cindex "&%run%& expansion item"
 This item runs an external command, as a subprocess.
-One option is supported after the word &'run'&, comma-separated.
+One option is supported after the word &'run'&, comma-separated
+and without whitespace.
 
 If the option &'preexpand'& is not used,
 the command string is split into individual arguments by spaces
@@ -13742,6 +13763,11 @@ there actually are, because many other connections may come and go while a
 single connection is being processed. When a child process terminates, the
 daemon decrements its copy of the variable.
 
+.vitem &$smtp_notquit_reason$&
+.vindex "&$smtp_notquit_reason$&"
+When the not-QUIT ACL is running, this variable is set to a string
+that indicates the reason for the termination of the SMTP connection.
+
 .vitem "&$sn0$& &-- &$sn9$&"
 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
 that were current at the end of the system filter file. This allows a system
@@ -16038,6 +16064,7 @@ search the file multiple times for non-existent users, and also cause delay.
 
 .option freeze_tell main "string list, comma separated" unset
 .cindex "freezing messages" "sending a message when freezing"
+.cindex "frozen messages" "sending a message when freezing"
 On encountering certain errors, or when configured to do so in a system filter,
 ACL, or special router, Exim freezes a message. This means that no further
 delivery attempts take place until an administrator thaws the message, or the
@@ -26160,7 +26187,8 @@ This option give a list of hosts for which,
 while verifying the server certificate,
 checks will be included on the host name
 (note that this will generally be the result of a DNS MX lookup)
-versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
+versus the Subject-Alternate-Name (or, if none, Subject-Name) fields.
+Wildcard names are permitted,
 limited to being the initial component of a 3-or-more component FQDN.
 
 There is no equivalent checking on client certificates.
@@ -28978,9 +29006,10 @@ for which it must have been requested via the
 (see &<<CHAPTLS>>&).
 
 If an authenticator of this type is configured it is
-run before any SMTP-level communication is done,
+run immediately after a TLS connection being negotiated
+(due to either STARTTLS or TLS-on-connect)
 and can authenticate the connection.
-If it does, SMTP authentication is not offered.
+If it does, SMTP authentication is not subsequently offered.
 
 A maximum of one authenticator of this type may be present.
 
@@ -31540,8 +31569,11 @@ the message modifier cannot override the 221 response code.
 
 The text in a &%message%& modifier is literal; any quotes are taken as
 literals, but because the string is expanded, backslash escapes are processed
-anyway. If the message contains newlines, this gives rise to a multi-line SMTP
+anyway.
+If the message contains newlines, this gives rise to a multi-line SMTP
 response.
+A long message line will also be split into multi-line SMTP responses,
+on word boundaries if possible.
 
 .vindex "&$acl_verify_message$&"
 While the text is being expanded, the &$acl_verify_message$& variable
@@ -31835,6 +31867,7 @@ work with.
 .vitem &*control&~=&~fakedefer/*&<&'message'&>
 .cindex "fake defer"
 .cindex "defer, fake"
+.cindex fakedefer
 This control works in exactly the same way as &%fakereject%& (described below)
 except that it causes an SMTP 450 response after the message data instead of a
 550 response. You must take care when using &%fakedefer%& because it causes the
@@ -31844,6 +31877,7 @@ use &%fakedefer%& if the message is to be delivered normally.
 .vitem &*control&~=&~fakereject/*&<&'message'&>
 .cindex "fake rejection"
 .cindex "rejection, fake"
+.cindex fakereject
 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
 words, only when an SMTP message is being received. If Exim accepts the
 message, instead the final 250 response, a 550 rejection message is sent.
@@ -39010,7 +39044,7 @@ logging and the message has a DKIM signature header.
 .section "Reducing or increasing what is logged" "SECTlogselector"
 .cindex "log" "selectors"
 By setting the &%log_selector%& global option, you can disable some of Exim's
-default logging, or you can request additional logging. The value of
+default logging to the main log, or you can request additional logging. The value of
 &%log_selector%& is made up of names preceded by plus or minus characters. For
 example:
 .code
@@ -40049,6 +40083,8 @@ Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
 .next
 Limiting the concurrency of specific transports (when &%max_parallel%& is set
 in a transport)
+.next
+Recording EHLO-time facilities advertised by hosts
 .endlist