diff options
-rw-r--r-- | doc/mailfromd.texi | 98 |
1 files changed, 49 insertions, 49 deletions
diff --git a/doc/mailfromd.texi b/doc/mailfromd.texi index 8d72ec45..1043082f 100644 --- a/doc/mailfromd.texi +++ b/doc/mailfromd.texi | |||
@@ -986,7 +986,7 @@ Notice only the following major differences between 4.1 and 4.0: | |||
986 | 986 | ||
987 | @itemize @bullet | 987 | @itemize @bullet |
988 | @item Input files are preprocessed before compilation. | 988 | @item Input files are preprocessed before compilation. |
989 | @xref{Preprocessor}, for the description. | 989 | @xref{Preprocessor}, for more information. |
990 | 990 | ||
991 | @item There is a way to discern between a not-supplied optional | 991 | @item There is a way to discern between a not-supplied optional |
992 | parameter, and a supplied one, having null value (@pxref{defined}). | 992 | parameter, and a supplied one, having null value (@pxref{defined}). |
@@ -1053,12 +1053,12 @@ steps: | |||
1053 | @item | 1053 | @item |
1054 | Change @code{#pragma option mailfrom @var{value}} to | 1054 | Change @code{#pragma option mailfrom @var{value}} to |
1055 | @code{set mailfrom_address @var{value}}. Refer to | 1055 | @code{set mailfrom_address @var{value}}. Refer to |
1056 | @ref{mailfrom_address}, for the detailed discussion of this variable. | 1056 | @ref{mailfrom_address}, for a detailed discussion of this variable. |
1057 | 1057 | ||
1058 | @item | 1058 | @item |
1059 | Change @code{#pragma option ehlo @var{value}} to | 1059 | Change @code{#pragma option ehlo @var{value}} to |
1060 | @code{set ehlo_domain @var{value}}. Refer to | 1060 | @code{set ehlo_domain @var{value}}. Refer to |
1061 | @ref{ehlo_domain}, for the detailed discussion of this variable. | 1061 | @ref{ehlo_domain}, for a detailed discussion of this variable. |
1062 | 1062 | ||
1063 | @item | 1063 | @item |
1064 | Include @file{status.mfh}. Add the following line to the top of | 1064 | Include @file{status.mfh}. Add the following line to the top of |
@@ -1081,7 +1081,7 @@ to the top of your script: | |||
1081 | #require dns | 1081 | #require dns |
1082 | @end smallexample | 1082 | @end smallexample |
1083 | 1083 | ||
1084 | @xref{Modules}, for the detailed description of the module system. | 1084 | @xref{Modules}, for a detailed description of the module system. |
1085 | 1085 | ||
1086 | @item | 1086 | @item |
1087 | Replace all occurrences of @code{next} with @code{pass}. | 1087 | Replace all occurrences of @code{next} with @code{pass}. |
@@ -1094,7 +1094,7 @@ to the top of your script: | |||
1094 | #require match_cidr | 1094 | #require match_cidr |
1095 | @end smallexample | 1095 | @end smallexample |
1096 | 1096 | ||
1097 | @xref{Modules}, for the description of @acronym{MFL} module system. | 1097 | @xref{Modules}, for a description of @acronym{MFL} module system. |
1098 | 1098 | ||
1099 | @end enumerate | 1099 | @end enumerate |
1100 | 1100 | ||
@@ -1606,7 +1606,7 @@ hostname $client_addr | |||
1606 | @noindent | 1606 | @noindent |
1607 | However, such syntax creates several ambiguities, so use it sparingly | 1607 | However, such syntax creates several ambiguities, so use it sparingly |
1608 | if at all. We recommend to always use parentheses when calling a | 1608 | if at all. We recommend to always use parentheses when calling a |
1609 | function; @xref{Cautions}, for the detailed analysis of of this syntax. | 1609 | function; @xref{Cautions}, for a detailed analysis of of this syntax. |
1610 | 1610 | ||
1611 | When a function does not deliver a result, it should only be called | 1611 | When a function does not deliver a result, it should only be called |
1612 | as a statement. | 1612 | as a statement. |
@@ -1795,7 +1795,7 @@ operation with the remote @acronym{SMTP} server. | |||
1795 | @end table | 1795 | @end table |
1796 | 1796 | ||
1797 | These three timeouts can be set using the following @dfn{pragmatic | 1797 | These three timeouts can be set using the following @dfn{pragmatic |
1798 | comments}@footnote{@xref{Pragmatic comments}, for the detailed | 1798 | comments}@footnote{@xref{Pragmatic comments}, for a detailed |
1799 | description of pragmatic comments.} in the script file: | 1799 | description of pragmatic comments.} in the script file: |
1800 | 1800 | ||
1801 | @smallexample | 1801 | @smallexample |
@@ -1983,7 +1983,7 @@ declarations as well as outside of them. | |||
1983 | variables}, that are visible to all handlers and functions, and | 1983 | variables}, that are visible to all handlers and functions, and |
1984 | @dfn{automatic variables}, that are available only within the handler | 1984 | @dfn{automatic variables}, that are available only within the handler |
1985 | or function where they are declared. For our purpose we need a global | 1985 | or function where they are declared. For our purpose we need a global |
1986 | variable (@xref{Variables, Variable classes}, for the detailed description | 1986 | variable (@xref{Variables, Variable classes}, for detailed descriptions |
1987 | of both kinds of variables). | 1987 | of both kinds of variables). |
1988 | 1988 | ||
1989 | The following example illustrates the approach that allows to use | 1989 | The following example illustrates the approach that allows to use |
@@ -2286,7 +2286,7 @@ to the reader. | |||
2286 | together with greylisting. To implement it, @command{mailfromd} | 2286 | together with greylisting. To implement it, @command{mailfromd} |
2287 | provides the function @code{dbmap}, which takes two mandatory arguments: | 2287 | provides the function @code{dbmap}, which takes two mandatory arguments: |
2288 | @code{dbmap(@var{file}, @var{key})} (it also allows an optional third | 2288 | @code{dbmap(@var{file}, @var{key})} (it also allows an optional third |
2289 | argument, see @ref{dbmap}, for the description of it). The first argument is | 2289 | argument, see @ref{dbmap}, for more information on it). The first argument is |
2290 | the name of the @acronym{DBM} file where to search for the key, the second one | 2290 | the name of the @acronym{DBM} file where to search for the key, the second one |
2291 | is the key to be searched. Assuming you keep your whitelist database | 2291 | is the key to be searched. Assuming you keep your whitelist database |
2292 | in file @file{/var/run/whitelist.db}, a more practical example will be: | 2292 | in file @file{/var/run/whitelist.db}, a more practical example will be: |
@@ -2873,7 +2873,7 @@ handler @command{mailfromd} executes. It is not necessary to export | |||
2873 | it to the rest of the handlers, since @command{mailfromd} will cache | 2873 | it to the rest of the handlers, since @command{mailfromd} will cache |
2874 | it. For example, if your filter script contains @samp{envfrom} and | 2874 | it. For example, if your filter script contains @samp{envfrom} and |
2875 | @samp{envrcpt} handlers, export @samp{i} for @samp{envfrom}. | 2875 | @samp{envrcpt} handlers, export @samp{i} for @samp{envfrom}. |
2876 | @xref{Sendmail Configuration}, for the instructions on how to ensure | 2876 | @xref{Sendmail Configuration}, for instructions on how to ensure |
2877 | it. | 2877 | it. |
2878 | 2878 | ||
2879 | @xopindex{debug, introduced} | 2879 | @xopindex{debug, introduced} |
@@ -3042,7 +3042,7 @@ regular expression. For example: | |||
3042 | @subheading Uncaught exceptions | 3042 | @subheading Uncaught exceptions |
3043 | Another kind of runtime errors are @dfn{uncaught exceptions}, | 3043 | Another kind of runtime errors are @dfn{uncaught exceptions}, |
3044 | i.e. exceptional conditions for which no handler was installed | 3044 | i.e. exceptional conditions for which no handler was installed |
3045 | (@xref{Exceptions}, for the information on exceptions and on how to | 3045 | (@xref{Exceptions}, for information on exceptions and on how to |
3046 | handle them). These errors mean that the programmer (i.e. you), made | 3046 | handle them). These errors mean that the programmer (i.e. you), made |
3047 | no provision for some specific conditions. For example, consider the | 3047 | no provision for some specific conditions. For example, consider the |
3048 | following code: | 3048 | following code: |
@@ -3607,7 +3607,7 @@ The following options control @acronym{I/O} operations over @acronym{TCP}. | |||
3607 | Sets initial connection timeout. If the connection is not | 3607 | Sets initial connection timeout. If the connection is not |
3608 | established within this time, the corresponding probing function | 3608 | established within this time, the corresponding probing function |
3609 | returns temporary failure. The default value is | 3609 | returns temporary failure. The default value is |
3610 | @value{CONNECT-TIMEOUT}. @xref{SMTP Timeouts}, for the | 3610 | @value{CONNECT-TIMEOUT}. @xref{SMTP Timeouts}, for a |
3611 | detailed description. | 3611 | detailed description. |
3612 | @end deffn | 3612 | @end deffn |
3613 | 3613 | ||
@@ -3625,7 +3625,7 @@ the detailed description. | |||
3625 | Sets @acronym{I/O} operation timeout in seconds. @command{Mailfromd} will | 3625 | Sets @acronym{I/O} operation timeout in seconds. @command{Mailfromd} will |
3626 | wait the given amount of time for the success of each @acronym{I/O} operation | 3626 | wait the given amount of time for the success of each @acronym{I/O} operation |
3627 | with the remote @acronym{MX}. Default timeout is @value{IO-TIMEOUT}. | 3627 | with the remote @acronym{MX}. Default timeout is @value{IO-TIMEOUT}. |
3628 | @xref{SMTP Timeouts}, for the detailed description. | 3628 | @xref{SMTP Timeouts}, for a detailed description. |
3629 | 3629 | ||
3630 | The form @code{timeout} is retained for backward compatibility and is | 3630 | The form @code{timeout} is retained for backward compatibility and is |
3631 | considered deprecated. | 3631 | considered deprecated. |
@@ -3706,7 +3706,7 @@ debugging @command{mailfromd}. | |||
3706 | @xprindex{stack-trace} | 3706 | @xprindex{stack-trace} |
3707 | Enables dumping stack traces on runtime errors. This feature is | 3707 | Enables dumping stack traces on runtime errors. This feature is |
3708 | useful for locating the source of an error, especially in complex | 3708 | useful for locating the source of an error, especially in complex |
3709 | scripts. @xref{tracing runtime errors}, for the detailed description. | 3709 | scripts. @xref{tracing runtime errors}, for a detailed description. |
3710 | @end deffn | 3710 | @end deffn |
3711 | 3711 | ||
3712 | @noindent | 3712 | @noindent |
@@ -3715,7 +3715,7 @@ These options control program privileges after startup: | |||
3715 | @deffn {pragma option} user @var{string} | 3715 | @deffn {pragma option} user @var{string} |
3716 | @xprindex{user} | 3716 | @xprindex{user} |
3717 | Switch to this user's privileges after startup. | 3717 | Switch to this user's privileges after startup. |
3718 | @xref{Starting and Stopping}, for the discussion of | 3718 | @xref{Starting and Stopping}, for a discussion of |
3719 | the privileges @command{mailfromd} runs under and the options that | 3719 | the privileges @command{mailfromd} runs under and the options that |
3720 | affect them. See also @code{group} below. | 3720 | affect them. See also @code{group} below. |
3721 | @end deffn | 3721 | @end deffn |
@@ -3824,7 +3824,8 @@ syntax is: | |||
3824 | 3824 | ||
3825 | @item #pragma database @var{dbname} expire-interval @var{interval} | 3825 | @item #pragma database @var{dbname} expire-interval @var{interval} |
3826 | Set the expiration interval for the database | 3826 | Set the expiration interval for the database |
3827 | @var{dbname}. (@xref{time interval specification}, for the syntax of @var{interval}). | 3827 | @var{dbname}. (@xref{time interval specification}, for more |
3828 | information on @var{interval} syntax). | ||
3828 | @end table | 3829 | @end table |
3829 | 3830 | ||
3830 | The parameter @var{dbname} can be one of the following: | 3831 | The parameter @var{dbname} can be one of the following: |
@@ -4099,7 +4100,7 @@ our sample string will actually be compiled as: | |||
4099 | $f " last connected from " %last_ip ";" | 4100 | $f " last connected from " %last_ip ";" |
4100 | @end smallexample | 4101 | @end smallexample |
4101 | 4102 | ||
4102 | @xref{Concatenation}, for the description of this construct. You can | 4103 | @xref{Concatenation}, for a description of this construct. You can |
4103 | easily see how various strings are interpreted by using | 4104 | easily see how various strings are interpreted by using |
4104 | @option{--dump-tree} option (@pxref{--dump-tree}). For our sample | 4105 | @option{--dump-tree} option (@pxref{--dump-tree}). For our sample |
4105 | string it will produce: | 4106 | string it will produce: |
@@ -4133,7 +4134,7 @@ subexpression in the last @command{matches} statement@footnote{The | |||
4133 | subexpressions are numbered by the positions of their opening | 4134 | subexpressions are numbered by the positions of their opening |
4134 | parentheses, left to right.}. Any back reference occurring within a | 4135 | parentheses, left to right.}. Any back reference occurring within a |
4135 | double-quoted string is replaced by the value of the corresponding | 4136 | double-quoted string is replaced by the value of the corresponding |
4136 | subexpression. @xref{Special comparisons}, for the detailed | 4137 | subexpression. @xref{Special comparisons}, for a detailed |
4137 | description of this process. Back reference interpretation is | 4138 | description of this process. Back reference interpretation is |
4138 | performed at run time. | 4139 | performed at run time. |
4139 | 4140 | ||
@@ -4375,7 +4376,7 @@ preprocessor is used, or to an empty string if it cannot, e.g.: | |||
4375 | __preproc__ @result{} "/usr/bin/m4 -s" | 4376 | __preproc__ @result{} "/usr/bin/m4 -s" |
4376 | @end smallexample | 4377 | @end smallexample |
4377 | 4378 | ||
4378 | @xref{Preprocessor}, for the information on preprocessor and its | 4379 | @xref{Preprocessor}, for information on preprocessor and its |
4379 | features. | 4380 | features. |
4380 | @end deftypevr | 4381 | @end deftypevr |
4381 | 4382 | ||
@@ -6100,8 +6101,8 @@ A mx10.gnu.org: Sun Dec 3 10:56:12 2006 199.232.76.166 | |||
6100 | and that it expires on Sunday, December 3d, at 10:56:12. | 6101 | and that it expires on Sunday, December 3d, at 10:56:12. |