Bugfixes/improvements.

* doc/mailfromd.texi: Document replbody. Use @WRITEME where appropriate.
* doc/rendition.texi (WRITEME): New macro.
(UNREVISED): Reword.
* doc/pies.texi, doc/smap.texi: Use @WRITEME
* doc/Makefile.am (check-writeme): New rule.
(all-check-docs): Depend on check-writeme.
* mfd/bi_body.m4 (replbody): Can be used in any handler.
* NEWS: Rearrange material.

git-svn-id: file:///svnroot/mailfromd/trunk@1764 7a8a7f39-df28-0410-adc6-e0d955640f24

1 files changed, 85 insertions, 75 deletions

diff --git a/NEWS b/NEWS
index 204d0a0d..df82db75 100644
--- a/NEWS
+++ b/NEWS
@@ -1,4 +1,4 @@
-Mailfromd NEWS -- history of user-visible changes. 2008-11-16
+Mailfromd NEWS -- history of user-visible changes. 2008-11-28
 Copyright (C) 2005, 2006, 2007, 2008 Sergey Poznyakoff
 See the end of file for copying conditions.
 
@@ -59,6 +59,58 @@ list to the second argument of `getopt'.
 
 * New MFL functions
 
+** rcpt_add(string rcpt)
+
+Adds a recipient to the message envelope.
+
+** rcpt_delete(string rcpt)
+
+Removes the given recipient from the envelope.
+
+** header_add(string hdr, string value [, number index])
+
+Adds a header "hdr: value" to the message.  This function differs from the
+`add' action in two regards:
+
+  1. It allows to construct the header name, whereas `add' requires it to
+     be a literal string;
+  2. Optional `index' argument specifies the location in the header
+     list where this header should be inserted.
+     
+** header_insert(string hdr, string value, number index)
+
+Equivalent to header_add(hdr, value, index).
+
+** header_delete(string hdr [, number index])
+
+Delete header `hdr' from the envelope.  This function differs from the
+`delete' action in two regards:
+
+  1. It allows to construct the header name, whereas `delete' requires it to
+     be a literal string;
+  2. Optional `index' argument allows to select a particular header
+     instance to delete.
+
+** header_replace(string hdr, string value [, number index])
+
+Replace the value of the header `hdr' with `value'.  Optional argument
+`index' specifies the number of `hdr' instance to replace (1-based).
+     
+This function differs from the `replace' action in two regards:
+
+  1. It allows to construct the header name, whereas `replace' requires it
+     to be a literal string;
+  2. Optional `index' argument allows to select a particular header
+     instance to replace.
+
+**  quarantine(string reason)
+
+Quarantines the message using the given reason.
+
+** replbody(string text)
+
+Replaces the body of the message with the given `text'
+
 ** body_string
 
   string body_string(pointer text, number length)
@@ -145,8 +197,6 @@ Return true if Sendmail macro `name' is defined.
 
 ** System functions: umask
 
-* New MFL functions
-
 ** string verp_extract_user(string email, string domain)
 
 If `email' is a valid VERP-style email address for `domain', this
@@ -209,6 +259,16 @@ start searching, e.g.:
   index("string of rings", "ring")    => 2
   index("string of rings", "ring", 3) => 10
   
+* New global variables.
+
+** last_poll_greeting
+
+Keeps the initial SMTP reply from the last poll.
+
+** last_poll_helo
+
+Keeps the reply to HELO (EHLO) command from the last poll.
+
 * New operation mode.
 
 When given `--run' command line option, mailfromd looks for a function
@@ -244,20 +304,6 @@ Additionally, maximum stack size may be given as third argument:
 
   #pragma stacksize 10m twice 200m
 
-* New programs:
-
-** smap.
-
-Smap is a general-purpose remote map for MeTA1.
-
-** pmult
-
-Pmult is a pmilter to milter multiplexer.
-
-** pies
-
-Pies is a process invocation and execution supervisor.
-
 * Milter `ports' can be specified using URL notation, e.g.:
 
   inet://127.0.0.1:1234  instead of inet:1234@127.0.0.1
@@ -267,75 +313,39 @@ Pies is a process invocation and execution supervisor.
 
 FIXME
   
-* New functions
-
-** rcpt_add(string rcpt)
-
-Adds a recipient to the message envelope.
-
-** rcpt_delete(string rcpt)
-
-Removes the given recipient from the envelope.
-
-** header_add(string hdr, string value [, number index])
-
-Adds a header "hdr: value" to the message.  This function differs from the
-`add' action in two regards:
-
-  1. It allows to construct the header name, whereas `add' requires it to
-     be a literal string;
-  2. Optional `index' argument specifies the location in the header
-     list where this header should be inserted.
-     
-** header_insert(string hdr, string value, number index)
-
-Equivalent to header_add(hdr, value, index).
-
-** header_delete(string hdr [, number index])
-
-Delete header `hdr' from the envelope.  This function differs from the
-`delete' action in two regards:
-
-  1. It allows to construct the header name, whereas `delete' requires it to
-     be a literal string;
-  2. Optional `index' argument allows to select a particular header
-     instance to delete.
-
-** header_replace(string hdr, string value [, number index])
-
-Replace the value of the header `hdr' with `value'.  Optional argument
-`index' specifies the number of `hdr' instance to replace (1-based).
-     
-This function differs from the `replace' action in two regards:
-
-  1. It allows to construct the header name, whereas `replace' requires it
-     to be a literal string;
-  2. Optional `index' argument allows to select a particular header
-     instance to replace.
+* Removed depecated features:
 
-**  quarantine(string reason)
+ 1. Command line options --ehlo, --postmaster-email, and --mailfrom
 
-Quarantines the message using the given reason.
+* mtasim
 
-* New global variables.
+New command line options `--user' and `--group' allow to specify user
+name and a list of additional groups when the program is run with
+`root' privileges.
 
-** last_poll_greeting
+* New programs:
 
-Keeps the initial SMTP reply from the last poll.
+** smap.
 
-** last_poll_helo
+Smap is a general-purpose remote map for MeTA1.
 
-Keeps the reply to HELO (EHLO) command from the last poll.
+** pmult
 
-* Removed depecated features:
+Pmult is a pmilter to milter multiplexer.  Pmilter is a new filter
+protocol implemented in MeTA1, an MTA which should in future replace
+Sendmail.  Pmult listens for Pmilter commands from the server,
+translates them into equivalent Milter commands and passes the
+translated requests to a preconfigured set of Milter filters.  When
+the filters reply, the reverse operation is performed: Milter
+responses are translated into their Pmilter equivalents and 
+are sent back to the server.
 
- 1. Command line options --ehlo, --postmaster-email, and --mailfrom
+Pmult allows to use existing milters with MeTA1 without any
+modifications. 
 
-* mtasim
+** pies
 
-New command line options `--user' and `--group' allow to specify user
-name and a list of additional groups when the program is run with
-`root' privileges.
+Pies is a process invocation and execution supervisor.
 
 * GNU Emacs MFL Mode is improved