diff options
Diffstat (limited to 'doc/mailfromd.texi')
-rw-r--r-- | doc/mailfromd.texi | 42 |
1 files changed, 22 insertions, 20 deletions
diff --git a/doc/mailfromd.texi b/doc/mailfromd.texi index 9cf4871e..368f890d 100644 --- a/doc/mailfromd.texi +++ b/doc/mailfromd.texi @@ -338,7 +338,7 @@ Invoke external programs or other mail filters. @unnumberedsec Short history of @command{mailfromd}. The idea of the utility appeared in 2005, and its first version -appeared soon afterwards. Back then it was a simple implementation of +appeared soon afterward. Back then it was a simple implementation of Sender Address Verification (@pxref{SAV}) for @samp{Sendmail} (hence its name -- @command{mailfromd}) with rudimentary tuning possibilities. @@ -381,7 +381,7 @@ Another major feature was the @option{--dump-macros} option and @option{macros} to @command{rc.mailfromd} script, that were intended to facilitate the configuration on @samp{Sendmail} side. - The development of 3.@i{x} (more propery, 3.1.@i{x}) series + The development of 3.@i{x} (more properly, 3.1.@i{x}) series concentrated mainly on bug-fixes, while the main development was done on the next branch. @@ -481,9 +481,11 @@ and helpful comments for various versions of the program: @cindex Brent Spencer @cindex Jeff Ballard @cindex Nacho Gonz@'alez L@'opez +@cindex Phil Miller @cindex Simon Christian +@cindex Thomas Lynch Alan Dobkin, Brent Spencer, Jeff Ballard, Nacho Gonz@'alez L@'opez, -Simon Christian. +Phil Miller, Simon Christian, Thomas Lynch. @node Intro, Building, Preface, Top @chapter Introduction to @command{mailfromd} @@ -1019,10 +1021,10 @@ became @code{e_divzero}, etc. The @code{ioerr} exception code is renamed to @cindex @code{OLD_EXCEPTION_CODES}, preprocessor symbol For consistency, the following most often used codes are available without -the @samp{e_} previx: success, not_found, failure, temp_failure. This -makes most existing user scripts suitable for use with version 4.4 -without any modification. If your script refers to any exception -codes other than these four, you can still use it by defining a +the @samp{e_} prefix: @code{success}, @code{not_found}, @code{failure}, +@code{temp_failure}. This makes most existing user scripts suitable for use +with version 4.4 without any modification. If your script refers to any +exception codes other than these four, you can still use it by defining a preprocessor symbol @code{OLD_EXCEPTION_CODES}, for example: @smallexample @@ -1043,7 +1045,7 @@ on some systems (notably on Solaris), so this release does not enable it by default. The previous meaning of the @option{--enable-syslog-async} configuration option is also restored. Use this option in order to enable asynchronous syslog feature. To set default syslog -implemetation, use @code{DEFAULT_SYSLOG_ASYNC} configuration variable +implementation, use @code{DEFAULT_SYSLOG_ASYNC} configuration variable (@pxref{syslog-async}). @node 410-420 @@ -3456,7 +3458,7 @@ do done @end smallexample -Problems begin when we need tp expand a constant in a +Problems begin when we need to expand a constant in a literal string. The only way to do so is by prefixing its name with a @samp{%}, just as if it were variable, and that produces the ambiguity. @@ -5092,7 +5094,7 @@ None. @item Invocation: This header is called zero or more times, for each piece of the message body obtained from the remote host. -@item Araguments: +@item Arguments: @enumerate 1 @item @code{string}; Piece of body text. See @samp{Notes} below. @item @code{number}; Length of @code{$1}, in bytes. @@ -5210,7 +5212,7 @@ blocks are executed is not defined. It is only warranted that all @samp{begin} blocks are executed at startup and all @samp{end} blocks are executed at shutdown. It is also warranted that all @samp{begin} and @samp{end} blocks defined within a compilation unit (i.e. a single -abstract source file, whith all @code{#include} and +abstract source file, with all @code{#include} and @code{#include_once} statements expanded in place) are executed in order of their appearance in the unit. @@ -5670,7 +5672,7 @@ than the field width, it will be padded with spaces on the left (or right, if the left-adjustment flag has been given). Instead of a decimal digit string one may write @samp{*} or @samp{*@var{m}$} (for some decimal integer @var{m}) to specify that the field width is given -in the next argument, or in the @var{m}-th argument, respectively, +in the next argument, or in the @var{m}th argument, respectively, which must be of numeric type. A negative field width is taken as a @samp{-} flag followed by a positive field width. In no case does a non-existent or small field width cause truncation of a field; if the @@ -5682,7 +5684,7 @@ An optional precision, in the form of a period (@samp{.}) followed by an optional decimal digit string. Instead of a decimal digit string one may write @samp{*} or @samp{*@var{m}$} (for some decimal integer @var{m}) to specify that the precision is given in the next argument, -or in the @var{m}-th argument, respectively, which must be of numeric +or in the @var{m}th argument, respectively, which must be of numeric type. If the precision is given as just @samp{.}, or the precision is negative, the precision is taken to be zero. This gives the minimum number of digits to appear for @samp{d}, @samp{i}, @samp{o}, @samp{u}, @@ -6247,7 +6249,7 @@ type is}: @end multitable If the lookup key is present in the database and its expiration time -is not yet reached, the coresponding answer from the database is +is not yet reached, the corresponding answer from the database is returned. Otherwise, the function performs actual @acronym{DNS} lookup, stores the obtained data in the database and returns it. @@ -7960,8 +7962,8 @@ do Within a function body, optional arguments are referenced exactly the same way as the mandatory ones. Attempt to dereference an -optional argument for which no actual aparameter was supplied, results -in an undefined value, so be sure to chech whether a parameter is +optional argument for which no actual parameter was supplied, results +in an undefined value, so be sure to check whether a parameter is passed before dereferencing it. @cindex return statement, defined @@ -8655,7 +8657,7 @@ This may change in future releases. @item variable -- variable @cindex variable shadowing @cindex shadowing, variable -Defining a variable havinf the same name as an already defined one results +Defining a variable having the same name as an already defined one results in a warning message being displayed. The compilation succeeds. The second variable @dfn{shadows} the first, that is any subsequent references to the variable name will refer to the second variable. @@ -9917,7 +9919,7 @@ compilation error. @cindex m4 Before compiling the script file, @command{mailfromd} preprocesses it. The built-in preprocessor handles only file inclusion -(@pxref{include}), while the rest of traditional facililities, such as +(@pxref{include}), while the rest of traditional facilities, such as macro expansion, are supported via @command{m4}, which is used as an external preprocessor. @@ -9929,14 +9931,14 @@ acquainted with @command{m4} macro processor. @flindex pp-setup The external preprocessor is invoked with @option{-s} flag, instructing -it to include line synchornizattion information in its output, which +it to include line synchronization information in its output, which is subsequently used by @acronym{MFL} compiler for purposes of error reporting. The initial set of macro definitions is supplied in file @file{pp-setup}, located in the library search path@footnote{It is usually located in @file{/usr/local/share/mailfromd/@value{VERSION}/include/pp-setup}.}, which is fed to the preprocessor input before the script file itself. -The default @file{pp-setup} file renames all @command{m4} builtin +The default @file{pp-setup} file renames all @command{m4} built-in macro names so they all start with the prefix @samp{m4_}@footnote{This is similar to GNU m4 @option{--prefix-builtin} options. This approach was chosen to allow for using non-GNU @command{m4} implementations as |