aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2008-11-28 10:47:48 +0000
committerSergey Poznyakoff <gray@gnu.org.ua>2008-11-28 10:47:48 +0000
commited4935d2c5fb3319f835e860a45f40d1251c00bd (patch)
tree04af1c3479e454abd246d70d1d7c2d8a958d4224 /doc
parentec9ba2360d297d3f233c410b1507a1dadc7a57a0 (diff)
downloadmailfromd-ed4935d2c5fb3319f835e860a45f40d1251c00bd.tar.gz
mailfromd-ed4935d2c5fb3319f835e860a45f40d1251c00bd.tar.bz2
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
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am15
-rw-r--r--doc/mailfromd.texi27
-rw-r--r--doc/pies.texi2
-rw-r--r--doc/rendition.texi11
-rw-r--r--doc/smap.texi2
5 files changed, 50 insertions, 7 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index ef581dd5..d50843ba 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -115,8 +115,19 @@ check-fixmes:
rm -f $@-t; \
fi
+check-writeme:
+ @grep -Hn @WRITEME $(info_TEXINFOS) $(mailfromd_TEXINFOS) > $@-t; \
+ if [ -s $@-t ]; then \
+ echo "Empty nodes:"; \
+ cat $@-t; \
+ rm $@-t; \
+ false;\
+ else \
+ rm $@-t; \
+ fi
+
check-unrevised:
- @grep -Hn @UNREVISED $(info_TEXINFOS) > $@-t; \
+ @grep -Hn @UNREVISED $(info_TEXINFOS) $(mailfromd_TEXINFOS) > $@-t; \
if [ -s $@-t ]; then \
echo "Unrevised nodes:"; \
cat $@-t; \
@@ -126,7 +137,7 @@ check-unrevised:
rm $@-t; \
fi
-all-check-docs: check-format check-options check-pragmas check-builtins check-mflib check-exceptions check-refs check-fixmes check-unrevised
+all-check-docs: check-format check-options check-pragmas check-builtins check-mflib check-exceptions check-refs check-fixmes check-writeme check-unrevised
check-docs:
$(MAKE) -k all-check-docs
diff --git a/doc/mailfromd.texi b/doc/mailfromd.texi
index 51ec2ced..250f66ce 100644
--- a/doc/mailfromd.texi
+++ b/doc/mailfromd.texi
@@ -237,6 +237,7 @@ Built-in and Library Functions
* Character Type::
* Envelope modification functions::
* Header modification functions::
+* Body Modification Functions::
* Mail header functions::
* Mail body functions::
* Mailbox functions::
@@ -2610,7 +2611,7 @@ For more information about @code{dbmap} function, see @ref{dbmap}.
@section Examining mail contents
@cindex Examining mail contents
@cindex mail contents, examining
-@UNREVISED{}
+@WRITEME{}
@node Databases
@section Databases
@@ -5935,6 +5936,7 @@ in version @value{VERSION}.
* Character Type::
* Envelope modification functions::
* Header modification functions::
+* Body Modification Functions::
* Mail header functions::
* Mail body functions::
* Mailbox functions::
@@ -6551,6 +6553,27 @@ instance to replace.
@end enumerate
@end deftypefn
+@node Body Modification Functions
+@subsubsection Body Modification Functions
+
+Body modification is an experimental feature of @acronym{MFL}.
+Version @value{VERSION} provides only one function for that purpose.
+
+@deftypefn {Built-in Function} void replbody (string @var{text})
+Replace the body of the message with @var{text}. Notice, that
+@var{text} must not contain RFC 822 headers. See previous section if
+you want to manipulate message headers.
+
+Example:
+
+@smallexample
+ replbody("Body of this message has been removed by the mail filter.")
+@end smallexample
+
+No restrictions are imposed on the format of @var{text}.
+@end deftypefn
+
+
@node Mail header functions
@subsubsection Mail Header Functions
@@ -12639,7 +12662,7 @@ f, @{client_addr@}
@node MeTA1, mtasim, Sendmail, Top
@chapter Using @command{mailfromd} with MeTA1.
-@UNREVISED{}
+@WRITEME{}
@node mtasim, smap, MeTA1, Top
@chapter @command{mtasim} --- a testing tool
diff --git a/doc/pies.texi b/doc/pies.texi
index d0de0ff3..136f8a93 100644
--- a/doc/pies.texi
+++ b/doc/pies.texi
@@ -2,4 +2,4 @@
@c Copyright (C) 2008 Sergey Poznyakoff
@c See file mailfromd.texi for copying conditions.
@c *******************************************************************
-@UNREVISED{}
+@WRITEME{}
diff --git a/doc/rendition.texi b/doc/rendition.texi
index 016583da..45ac0687 100644
--- a/doc/rendition.texi
+++ b/doc/rendition.texi
@@ -39,10 +39,19 @@
@c Output marks for nodes needing revision, but not in PUBLISH rendition.
+@macro WRITEME
+@ifclear PUBLISH
+@quotation
+@emph{This node is to be written.}
+@end quotation
+@end ifclear
+@end macro
+
@macro UNREVISED
@ifclear PUBLISH
@quotation
-@emph{(This message will disappear, once this node revised.)}
+(@emph{The information in this node may be obsolete or otherwise inaccurate.}
+This message will disappear, once this node revised.)
@end quotation
@end ifclear
@end macro
diff --git a/doc/smap.texi b/doc/smap.texi
index d0de0ff3..136f8a93 100644
--- a/doc/smap.texi
+++ b/doc/smap.texi
@@ -2,4 +2,4 @@
@c Copyright (C) 2008 Sergey Poznyakoff
@c See file mailfromd.texi for copying conditions.
@c *******************************************************************
-@UNREVISED{}
+@WRITEME{}

Return to:

Send suggestions and report system problems to the System administrator.