Update

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

1 files changed, 43 insertions, 34 deletions

diff --git a/doc/mailfromd.texi b/doc/mailfromd.texi
index 54c22030..cafacbef 100644
--- a/doc/mailfromd.texi
+++ b/doc/mailfromd.texi
@@ -719,8 +719,10 @@ Mailfromd configured with the following settings:
 
 DBM version............................... Berkeley DB v. 3
 Default user.............................. mail
-State directory........................... $(localstatedir)/@/$(PACKAGE)
-Socket.................................... unix:@//$(DEFAULT_STATE_DIR)/@/mailfrom
+State directory...........................
+           $(localstatedir)/$(PACKAGE)
+Socket....................................
+           unix:/$(DEFAULT_STATE_DIR)/mailfrom
 Expiration interval....................... 86400
 Negative DNS answer expiration interval... 3600
 Rates expire interval..................... 300
@@ -1100,7 +1102,7 @@ be supplied its own handling procedure.  A missing procedure implies
 called after the names of milter states: @samp{connect}, @samp{helo},
 @samp{envfrom}, @samp{envrcpt}, @samp{header}, @samp{eoh},
 @samp{body}, and @samp{eom}.  Two special handlers are available for
-initialization and cleran-up purposes: @samp{begin} is called before
+initialization and clean-up purposes: @samp{begin} is called before
 the processing starts, and @samp{end} is called after it is finished.
 The diagram below shows the control flow when processing an
 @acronym{SMTP} transaction.  Lines marked with @code{C:} show
@@ -1589,7 +1591,7 @@ infinite loops for outgoing mails.  Indeed, upon sending the outgoing
 mail @command{mailfromd} will start the verification procedure, which
 will initiate an @acronym{SMTP} transaction with the own server.  This
 transaction will in turn trigger execution of @code{on poll}
-statement, etc. ad infinitum.  To avoid this, any properly written
+statement, etc. @i{ad infinitum}.  To avoid this, any properly written
 filter script should not run the verification procedure on the email
 addresses in those domains that are relayed by the server it runs on.
 This can be achieved using @code{relayed} function.  The function returns
@@ -2183,7 +2185,7 @@ explained in the next subsection.
 @dfn{DNS database} caches @acronym{DNS} lookups.  The key consists of the type
 of the lookup and actual lookup key, separated by a single space.  The
 type can be one of @samp{A}, @samp{PTR}, @samp{MX}.  The value is an
-ASCII string built up of one or more fields, separated by a single
+@acronym{ASCII} string built up of one or more fields, separated by a single
 space.  The first field is always the expiration date for this record
 in seconds since the Epoch (00:00:00 UTC, January 1, 1970).  The
 meaning of the rest of the fields depends on the lookup type as
@@ -2583,7 +2585,7 @@ executed during the message verification.  When this option is given,
 any @code{accept}, @code{discard}, @code{continue}, etc. triggered
 during the execution of your filter program will leave their traces in
 the log file.  Here is an example of how it looks like (syslog time
-stamp, tag and PID removed for readability):
+stamp, tag and @acronym{PID} removed for readability):
 
 @smallexample
 @group
@@ -2855,14 +2857,14 @@ the following code (line numbers added for reference):
 @smallexample
 23 func match_cidr(string ipstr, string cidr) returns number
 24 do
-25      number netmask
+25   number netmask
 26
-27      if %cidr matches '^(([0-9]@{1,3@}\.)@{3@}[0-9]@{1,3@})/([0-9][0-9]?)'
-28              return inet_aton(%ipstr) & len_to_netmask(\3) = inet_aton(\1)
-29      else
-30              throw invcidr "invalid CIDR (%cidr)"
-31      fi
-32      return 0
+27   if %cidr matches '^(([0-9]@{1,3@}\.)@{3@}[0-9]@{1,3@})/([0-9][0-9]?)'
+28     return inet_aton(%ipstr) & len_to_netmask(\3) = inet_aton(\1)
+29   else
+30     throw invcidr "invalid CIDR (%cidr)"
+31   fi
+32   return 0
 33 done
 @end smallexample
 
@@ -2897,7 +2899,7 @@ consists of:
 @end enumerate
 
   Thus, the example above can be read as: @samp{the function
-@code{match_cidr} was called by fiunction @code{bar} in file
+@code{match_cidr} was called by function @code{bar} in file
 @file{test.mf} at line 13.  This function was in turn called from
 function @code{foo}, in file @file{mailfromd.rc} at line 18}.
 
@@ -3276,7 +3278,7 @@ corresponding @code{#pragma database} option.
 @code{#pragma database rate expire-interval} instead.
 @end deffn
 
-  The following options control I/O operations over TCP.
+  The following options control @acronym{I/O} operations over @acronym{TCP}.
 
 @deffn {pragma option} source @var{address}
 @xprindex{source}
@@ -3441,12 +3443,12 @@ setting in @command{Milter} notation:
   A named pipe (socket).
 
 @item inet:@var{port}@@@var{address}
-  An IPV4 connection to host @var{address} at port @var{port}.  Port
+  An @acronym{IP}v4 connection to host @var{address} at port @var{port}.  Port
 must be specified either as a decimal number or a string representing
 the port name in @file{/etc/services}.
 
 @item inet6:@var{port}@@@var{address}
-An IPV6 connection to host @var{address} at port @var{port}.  This
+An @acronym{IP}v6 connection to host @var{address} at port @var{port}.  This
 port type is not yet supported.
 @end table
 @end deffn
@@ -3538,7 +3540,7 @@ forms of this statement for @samp{cache} database:
   Set expiration interval for negative (@samp{not_found}) cache entries.
 @end table
 
-  The @acronym{DNS} lookup cache uses @acronym{DNS} TTL as expiration
+  The @acronym{DNS} lookup cache uses @acronym{DNS} @acronym{TTL} as expiration
 interval for records representing positive lookups.  The only value
 that can be altered is negative expiration interval:
 
@@ -3681,10 +3683,10 @@ of two types: numeric and string.
 
   The @dfn{numeric} type is represented internally as a signed long
 integer.  Depending on the machine architecture, its size can vary.
-For example, on machines with Intel-based CPUs it is 32 bits long.
+For example, on machines with Intel-based @acronym{CPU}s it is 32 bits long.
 
   A @dfn{string} is a string of characters of arbitrary length.
-Strings can contain any characters except ASCII NUL (@samp{0}).
+Strings can contain any characters except @acronym{ASCII} @sc{nul} (@samp{0}).
 
 @node Numbers
 @section Numbers
@@ -3743,12 +3745,12 @@ corresponding single characters:
 @caption{Backslash escapes}
 @multitable @columnfractions 0.30 .5
 @item Sequence @tab Replaced with
-@item \a @tab Audible bell character (ASCII 7)
-@item \b @tab Backspace character (ASCII 8)
-@item \f @tab Form-feed character (ASCII 12)
-@item \n @tab Newline character (ASCII 10)
-@item \r @tab Carriage return character (ASCII 13)
-@item \t @tab Horizontal tabulation character (ASCII 9)
+@item \a @tab Audible bell character (@acronym{ASCII} 7)
+@item \b @tab Backspace character (@acronym{ASCII} 8)
+@item \f @tab Form-feed character (@acronym{ASCII} 12)
+@item \n @tab Newline character (@acronym{ASCII} 10)
+@item \r @tab Carriage return character (@acronym{ASCII} 13)
+@item \t @tab Horizontal tabulation character (@acronym{ASCII} 9)
 @end multitable
 @end float
 
@@ -3764,7 +3766,7 @@ effect as @samp{\n}, for example:
 @end smallexample
 
 Any escape sequence of the form @samp{\x@var{hh}}, where @var{h}
-denotes any hex digit is replaced with the character whose ASCII value
+denotes any hex digit is replaced with the character whose @acronym{ASCII} value
 is @var{hh}.  For example: 
 
 @smallexample
@@ -3772,7 +3774,7 @@ is @var{hh}.  For example:
 @end smallexample
 
   Similarly, an escape sequence of the form @samp{\0@var{ooo}}, where
-@var{o} is an octal digit, is replaced with the character whose ASCII
+@var{o} is an octal digit, is replaced with the character whose @acronym{ASCII}
 value is @var{ooo}.  
 
 @cindex Variable interpretation
@@ -4405,7 +4407,7 @@ definitions for the address families.  Supported families are:
 @cindex FAMILY_STDIO
 @cindex FAMILY_UNIX
 @cindex FAMILY_INET
-@multitable @columnfractions 0.20 .10 0.70
+@multitable @columnfractions 0.20 .10 0.45
 @headitem Constant @tab Value @tab Meaning
 @item FAMILY_STDIO @tab  0    @tab Standard input/output (the @acronym{MTA} is
 run with @option{-bs} option) 
@@ -4561,8 +4563,8 @@ Called once for each header line received after @acronym{SMTP} @code{DATA} comma
 @item @code{string}; Header field name.
 @item @code{string}; Header field value. The content of the header may
 include folded white space, i.e., multiple lines with following white
-space where lines are separated by LF (ASCII 10). The trailing line
-terminator (CR/LF) is removed.
+space where lines are separated by @sc{lf} (@acronym{ASCII} 10). The
+trailing line terminator (@sc{cr/lf}) is removed.
 @end enumerate
 @end deffn
 
@@ -6846,7 +6848,12 @@ When called without argument, @code{debug_spec} will return full
 debugging level specification, as shown in the example below:
 
 @smallexample
-debug_spec() @result{} "20,@/debug=0,@/cache=0,@/dnscache=0,@/db=30,@/dns=0,@/dnsbase=0,@/engine=8,@/gram=0,@/lex=0,@/main=0,@/mf-status=0,@/mu_dbm=0,@/optab=0,@/prog=0,@/spf=50,@/stack=0,@/symtab=0,@/rate=0,@/bi_db=0,@/bi_dns=98,@/bi_io=0,@/bi_ipaddr=0,@/bi_mail=0,@/bi_poll=0,@/bi_sa=0,@/bi_spf=0,@/bi_string=7,@/bi_system=0,@/bi_other=0,@/bi_vars=0"
+debug_spec()
+@result{} "20,debug=0,cache=0,dnscache=0,db=30,dns=0,dnsbase=0,engine=8,
+gram=0,lex=0,main=0,mf-status=0,mu_dbm=0,optab=0,prog=0,
+spf=50,stack=0,symtab=0,rate=0,bi_db=0,bi_dns=98,bi_io=0,
+bi_ipaddr=0,bi_mail=0,bi_poll=0,bi_sa=0,bi_spf=0,bi_string=7,
+bi_system=0,bi_other=0,bi_vars=0"
 @end smallexample
 @end deftypefn
 
@@ -9358,8 +9365,10 @@ messages on each subprocess startup and termination, which look like
 that:
 
 @smallexample
-Apr 28 09:00:11 host mailfromd[9411]: connect from 192.168.10.1:50398
-Apr 28 09:00:11 host mailfromd[9411]: finishing connection
+Apr 28 09:00:11 host mailfromd[9411]: connect from
+    192.168.10.1:50398
+Apr 28 09:00:11 host mailfromd[9411]: finishing
+    connection
 @end smallexample
 
 This level can be useful for debugging your scripts.