Add documentation for new $authenticated_fail_id

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

diff --git a/doc/doc-docbook/filter.xfpt b/doc/doc-docbook/filter.xfpt
index d5e3937b738bde82a655722a0d77b9b336ef6590..b40e4e259162639e4f15e3aaeffc5a684822a39f 100644 (file)
--- a/doc/doc-docbook/filter.xfpt
+++ b/doc/doc-docbook/filter.xfpt
@@ -1,5 +1,3 @@
-. $Cambridge: exim/doc/doc-docbook/filter.xfpt,v 1.6 2007/04/17 13:06:09 ph10 Exp $
-

 . /////////////////////////////////////////////////////////////////////////////
 . This is the primary source of the document that describes Exim's filtering
 . facilities. It is an xfpt document that is converted into DocBook XML for
 . /////////////////////////////////////////////////////////////////////////////
 . This is the primary source of the document that describes Exim's filtering
 . facilities. It is an xfpt document that is converted into DocBook XML for


@@ -10,6 +8,7 @@
 
 .include stdflags
 .include stdmacs
 
 .include stdflags
 .include stdmacs

+.include ./local_params

 .docbook
 
 . /////////////////////////////////////////////////////////////////////////////
 .docbook
 
 . /////////////////////////////////////////////////////////////////////////////


@@ -23,7 +22,7 @@
 <?sdop
   foot_right_recto="&chaptertitle;"
   foot_right_verso="&chaptertitle;"
 <?sdop
   foot_right_recto="&chaptertitle;"
   foot_right_verso="&chaptertitle;"

-  table_warn_soft_overflow="no"
+  table_warn_overflow="overprint"

   toc_chapter_blanks="yes,yes"
   toc_title="Exim's interfaces to mail filtering"
 ?>
   toc_chapter_blanks="yes,yes"
   toc_title="Exim's interfaces to mail filtering"
 ?>


@@ -46,6 +45,13 @@
 .endmacro
 . ===========================================================================
 
 .endmacro
 . ===========================================================================
 

+. Copyright year.  Update this (only) when changing content.
+
+.macro copyyear
+2010
+.endmacro
+
+. ===========================================================================

 
 . /////////////////////////////////////////////////////////////////////////////
 . /////////////////////////////////////////////////////////////////////////////
 
 . /////////////////////////////////////////////////////////////////////////////
 . /////////////////////////////////////////////////////////////////////////////


@@ -61,15 +67,23 @@
 <bookinfo>
 <title>Exim's interfaces to mail filtering</title>
 <titleabbrev>Exim filtering</titleabbrev>
 <bookinfo>
 <title>Exim's interfaces to mail filtering</title>
 <titleabbrev>Exim filtering</titleabbrev>

-<date>17 April 2007</date>
+<date>
+.fulldate
+</date>

 <author><firstname>Philip</firstname><surname>Hazel</surname></author>
 <authorinitials>PH</authorinitials>
 <revhistory><revision>
 <author><firstname>Philip</firstname><surname>Hazel</surname></author>
 <authorinitials>PH</authorinitials>
 <revhistory><revision>

-  <revnumber>4.67</revnumber>
-  <date>17 April 2007</date>
+  <revnumber>
+.version
+  </revnumber>
+  <date>
+.fulldate
+  </date>

   <authorinitials>PH</authorinitials>
 </revision></revhistory>
   <authorinitials>PH</authorinitials>
 </revision></revhistory>

-<copyright><year>2007</year><holder>University of Cambridge</holder></copyright>
+<copyright><year>
+.copyyear
+           </year><holder>University of Cambridge</holder></copyright>

 </bookinfo>
 .literal off
 
 </bookinfo>
 .literal off
 


@@ -79,8 +93,8 @@
 
 .chapter "Forwarding and filtering in Exim" "CHAPforandfilt"
 This document describes the user interfaces to Exim's in-built mail filtering
 
 .chapter "Forwarding and filtering in Exim" "CHAPforandfilt"
 This document describes the user interfaces to Exim's in-built mail filtering

-facilities, and is copyright &copy; University of Cambridge 2007. It
-corresponds to Exim version 4.67.
+facilities, and is copyright &copy; University of Cambridge &copyyear(). It
+corresponds to Exim version &version().

 
 
 
 
 
 


@@ -273,14 +287,12 @@ this context as &"the specific implementation of Sieve for Exim"&.
 This chapter does not contain a description of Sieve, since that can be found
 in RFC 3028, which should be read in conjunction with these notes.
 
 This chapter does not contain a description of Sieve, since that can be found
 in RFC 3028, which should be read in conjunction with these notes.
 

-.new

 The Exim Sieve implementation offers the core as defined by RFC 3028,
 comparison tests, the subaddress parameter, the &*copy*&, &*envelope*&,
 &*fileinto*&, &*notify*&, and &*vacation*& extensions, but not the &*reject*&
 extension. Exim does not support message delivery notifications (MDNs), so
 adding it just to the Sieve filter (as required for &*reject*&) makes little
 sense.
 The Exim Sieve implementation offers the core as defined by RFC 3028,
 comparison tests, the subaddress parameter, the &*copy*&, &*envelope*&,
 &*fileinto*&, &*notify*&, and &*vacation*& extensions, but not the &*reject*&
 extension. Exim does not support message delivery notifications (MDNs), so
 adding it just to the Sieve filter (as required for &*reject*&) makes little
 sense.

-.wen

 
 In order for Sieve to work properly in Exim, the system administrator needs to
 make some adjustments to the Exim configuration. These are described in the
 
 In order for Sieve to work properly in Exim, the system administrator needs to
 make some adjustments to the Exim configuration. These are described in the


@@ -1044,7 +1056,6 @@ mail-sending command is
 &`     [log `&<&'log file name'&>&`]`&
 &`     [once `&<&'note file name'&>&`]`&
 &`     [once_repeat `&<&'time interval'&>&`]`&
 &`     [log `&<&'log file name'&>&`]`&
 &`     [once `&<&'note file name'&>&`]`&
 &`     [once_repeat `&<&'time interval'&>&`]`&

-

 &`e.g. mail text "Your message about $h_subject: has been received"`&
 .endd
 Each <&'address-list'&> can contain a number of addresses, separated by commas,
 &`e.g. mail text "Your message about $h_subject: has been received"`&
 .endd
 Each <&'address-list'&> can contain a number of addresses, separated by commas,


@@ -1557,7 +1568,7 @@ $message_headers does not contain "\nList-Post:" and
 $message_headers does not contain "\nList-Owner:" and
 $message_headers does not contain "\nList-Archive:" and
 (
 $message_headers does not contain "\nList-Owner:" and
 $message_headers does not contain "\nList-Archive:" and
 (

-"${if def h_auto-submitted:{present}{absent}}" is "absent" or
+"${if def:h_auto-submitted:{present}{absent}}" is "absent" or

 $header_auto-submitted: is "no"
 ) and
 $header_precedence: does not contain "bulk" and
 $header_auto-submitted: is "no"
 ) and
 $header_precedence: does not contain "bulk" and