diff options
Diffstat (limited to 'doc/mailfromd.texi')
| -rw-r--r-- | doc/mailfromd.texi | 75 |
1 files changed, 47 insertions, 28 deletions
diff --git a/doc/mailfromd.texi b/doc/mailfromd.texi index d8ff6046..10f16615 100644 --- a/doc/mailfromd.texi +++ b/doc/mailfromd.texi @@ -2596,20 +2596,23 @@ user: mail statedir: /var/run/mailfromd socket: unix:/var/run/mailfromd/mailfrom pidfile: /var/run/mailfromd/mailfromd.pid -database format: Berkeley DB 2.x +default syslog: blocking +supported databases: gdbm, bdb +default database type: bdb +optional features: GeoIP +greylist database: /var/run/mailfromd/greylist.db +greylist expiration: 86400 tbf database: /var/run/mailfromd/tbf.db tbf expiration: 86400 +rate database: /var/run/mailfromd/rates.db +rate expiration: 86400 cache database: /var/run/mailfromd/mailfromd.db cache positive expiration: 86400 cache negative expiration: 43200 -greylist database: /var/run/mailfromd/greylist.db -greylist expiration: 86400 -rate database: /var/run/mailfromd/rates.db -rate expiration: 86400 @end group @end smallexample - The text below @samp{database format} line describes the available + The text below @samp{optional features} line describes the available built-in databases. Notice that the @samp{cache} database, in contrast to the rest of databases, has two expiration periods associated with it. This is explained in the next subsection. @@ -3104,7 +3107,7 @@ often make it impossible to pass additional arguments to following line would most probably fail to be executed properly: @example -#! /usr/sbin/mailfromd --no-user-conf --run +#! /usr/sbin/mailfromd --no-config --run @end example @cindex @samp{#! ... !#} initial comment @@ -3128,7 +3131,7 @@ invoking the interpreter itself. For example: @example #!/bin/sh -exec /usr/sbin/mailfromd --no-user-conf --run $0 $@@ +exec /usr/sbin/mailfromd --no-config --run $0 $@@ !# func main(...) @@ -3601,7 +3604,7 @@ internal structure to use this form of the @option{--debug} option. @anchor{SMTP transcript} @xopindex{transcript, mailfromd, introduced} To control the execution of the sender verification functions -(@pxref{Polling functions}), you may use +(@pxref{SMTP Callout functions}), you may use @option{--transcript} (@option{-X}) command line option which enables transcripts of @acronym{SMTP} sessions in the logs. Here is an example of the output produced running @kbd{mailfromd --transcript}: @@ -4991,7 +4994,7 @@ This variable is set by @code{stdpoll} and @code{strictpoll} built-ins (and, consequently, by the @code{on poll} statement). Its value is @samp{1} if the function used the cached data instead of directly polling the host, and @samp{0} if the polling took place. -@xref{Polling functions}. +@xref{SMTP Callout functions}. @anchor{cache_used example} @cindex @code{cache_used} variable, usage example @@ -5050,34 +5053,35 @@ qualified domain name of the host where @command{mailfromd} is run. @end deftypevr @deftypevar {Predefined Variable} string last_poll_greeting -Polling functions (@pxref{Polling functions}) set this variable before +Callout functions (@pxref{SMTP Callout functions}) set this variable before returning. It contains the initial SMTP reply from the last polled host. @end deftypevar @deftypevar {Predefined Variable} string last_poll_helo -Polling functions (@pxref{Polling functions}) set this variable before +Callout functions (@pxref{SMTP Callout functions}) set this variable before returning. It contains the reply to the @code{HELO} (@code{EHLO}) command, received from the last polled host. @end deftypevar @deftypevar {Predefined Variable} string last_poll_host -Polling functions (@pxref{Polling functions}) set this variable before -returning. It contains the host name or @acronym{IP} address of the last polled host. +Callout functions (@pxref{SMTP Callout functions}) set this variable before +returning. It contains the host name or @acronym{IP} address of the +last polled host. @end deftypevar @deftypevar {Predefined Variable} string last_poll_recv -Polling functions (@pxref{Polling functions}) set this variable before +Callout functions (@pxref{SMTP Callout functions}) set this variable before returning. It contains the last @acronym{SMTP} reply received from the remote host. In case of multi-line replies, only the first line is stored. If nothing was received the variable contains the string @samp{nothing}. @end deftypevar -@deftypevar {Predefined Variable} string last_poll_send -Polling functions (@pxref{Polling functions}) set this variable before +@deftypevar {Predefined Variable} string last_poll_sent +Callout functions (@pxref{SMTP Callout functions}) set this variable before returning. It contains the last @acronym{SMTP} command sent to the -polled host. If nothing was sent, @code{last_poll_send} contains the string +polled host. If nothing was sent, @code{last_poll_sent} contains the string @samp{nothing}. @end deftypevar @@ -7768,7 +7772,7 @@ previously using a @code{dclex} statement). @cindex sender verification, writing tests The filter script language provides a wide variety of functions for sender address verification or @dfn{polling}, for short. These -functions, which were described in @ref{Polling functions}, can be +functions, which were described in @ref{SMTP Callout functions}, can be used to implement any sender verification method. The additional data that can be needed is normally supplied by two global variables: @code{ehlo_domain}, keeping the default domain for the @code{EHLO} @@ -9024,6 +9028,7 @@ server @var{type} @{ single-process @var{bool}; reuseaddr @var{bool}; default @var{bool}; + callout @var{url}; acl @{ @dots{} @} @} @end group @@ -9101,7 +9106,8 @@ for all milter servers declared in the configuration. if the server @var{type} is @samp{milter}, you can use the following statement to query a remote callout server: - + +@anchor{configuring default callout server} @deffn {server} callout url Use a callout server at @var{url} (@pxref{milter port specification}). @end deffn @@ -9682,8 +9688,8 @@ overrides the settings of @code{state-directory} configuration statement, described in @ref{conf-base, state-directory}. @opsummary{source-ip, mailfromd} -@item -S -@itemx --source-ip +@item -S @var{ip} +@itemx --source-ip=@var{ip} Set source address for @acronym{TCP} connections. Overrides the @samp{source-ip} configuration statement, which you are advised to use instead (@pxref{conf-base, source-ip}). @@ -9769,8 +9775,11 @@ configuration file statement, which you are advised to use instead @table @option @opsummary{location-column, mailfromd} +@item --location-column +@itemx --no-location-column Mention column number in error messages. @xref{Testing Filter -Scripts,, location-column}. +Scripts,, location-column}. Use @option{--no-location-column} to +disable @opsummary{debug, mailfromd} @item -d @var{string} @@ -9831,9 +9840,11 @@ else but for debugging, as it terribly degrades performance! @opsummary{stack-trace, mailfromd} @item --stack-trace +@itemx --no-stack-trace Add @acronym{MFL} stack trace information to runtime error output. -Overrides @code{stack-trace} configuration statement, which you are -advised to use instead (@pxref{conf-debug, stack-trace}). +Overrides @code{stack-trace} configuration statement. Use the +@option{--no-stack-trace} to disable trace information. + @xref{tracing runtime errors}, for more information on this feature. @anchor{gacopyz-log option} @@ -9904,10 +9915,14 @@ Tag syslog entries with the given @var{string}, instead of the program name. @opsummary{source-info, mailfromd} @item --source-info +@itemx --no-source-info Include @sc{c} source information in debugging messages. This is similar to setting @code{line-info yes} in the @code{debug} configuration block (@FIXME-pxref{debug configuration}). +The @option{--no-source-info} can be used to cancel the effect of the +@code{line-info yes} configuration statement. + You do not need this option, unless you are developing or debugging @command{mailfromd}. @@ -9917,8 +9932,10 @@ Synonym for @option{--lint}. @opsummary{trace, mailfromd} @item --trace -Enable action tracing. With this option @command{mailfromd} will log -all executed actions. @xref{Logging and Debugging}. +@item --no-trace +Enable or disable action tracing. If @option{--trace} is given, +@command{mailfromd} will log all executed actions. @xref{Logging and +Debugging}. @opsummary{trace-program, mailfromd} @item --trace-program[=@var{string}] @@ -9936,7 +9953,8 @@ advised to use otherwise, since it is very time-costly. @opsummary{transcript, mailfromd} @item -X @itemx --transcript -Enable transcript of the @acronym{SMTP} sessions to the log +@itemx --no-transcript +Enable or disable transcript of the @acronym{SMTP} sessions to the log channel. @xref{Logging and Debugging}. @opsummary{syslog, mailfromd} @@ -9944,6 +9962,7 @@ channel. @xref{Logging and Debugging}. Selects default syslog mechanism for diagnostic output. @opsummary{stderr, mailfromd} +@item --stderr Directs all logging to standard output. Similar to @option{--logger=stderr}. @opsummary{xref, mailfromd} |