summaryrefslogtreecommitdiffabout
authorSergey Poznyakoff <gray@gnu.org.ua>2007-09-06 07:32:12 (GMT)
committer Sergey Poznyakoff <gray@gnu.org.ua>2007-09-06 07:32:12 (GMT)
commita5e06ce6cbbc41a806857055bb689bdce4d39b57 (patch) (side-by-side diff)
treec65de1c957d4778206f9bed940e2ca2161bcc593
parent94fad0d95ab5861c7fab4f30f1584d6fa725af12 (diff)
downloadmailfromd-a5e06ce6cbbc41a806857055bb689bdce4d39b57.tar.gz
mailfromd-a5e06ce6cbbc41a806857055bb689bdce4d39b57.tar.bz2
Update
git-svn-id: file:///svnroot/mailfromd/trunk@1507 7a8a7f39-df28-0410-adc6-e0d955640f24
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--doc/mailfromd.texi98
1 files changed, 49 insertions, 49 deletions
diff --git a/doc/mailfromd.texi b/doc/mailfromd.texi
index 8d72ec4..1043082 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:
@itemize @bullet
@item Input files are preprocessed before compilation.
-@xref{Preprocessor}, for the description.
+@xref{Preprocessor}, for more information.
@item There is a way to discern between a not-supplied optional
parameter, and a supplied one, having null value (@pxref{defined}).
@@ -1053,12 +1053,12 @@ steps:
@item
Change @code{#pragma option mailfrom @var{value}} to
@code{set mailfrom_address @var{value}}. Refer to
-@ref{mailfrom_address}, for the detailed discussion of this variable.
+@ref{mailfrom_address}, for a detailed discussion of this variable.
@item
Change @code{#pragma option ehlo @var{value}} to
@code{set ehlo_domain @var{value}}. Refer to
-@ref{ehlo_domain}, for the detailed discussion of this variable.
+@ref{ehlo_domain}, for a detailed discussion of this variable.
@item
Include @file{status.mfh}. Add the following line to the top of
@@ -1081,7 +1081,7 @@ to the top of your script:
#require dns
@end smallexample
-@xref{Modules}, for the detailed description of the module system.
+@xref{Modules}, for a detailed description of the module system.
@item
Replace all occurrences of @code{next} with @code{pass}.
@@ -1094,7 +1094,7 @@ to the top of your script:
#require match_cidr
@end smallexample
-@xref{Modules}, for the description of @acronym{MFL} module system.
+@xref{Modules}, for a description of @acronym{MFL} module system.
@end enumerate
@@ -1606,7 +1606,7 @@ hostname $client_addr
@noindent
However, such syntax creates several ambiguities, so use it sparingly
if at all. We recommend to always use parentheses when calling a
-function; @xref{Cautions}, for the detailed analysis of of this syntax.
+function; @xref{Cautions}, for a detailed analysis of of this syntax.
When a function does not deliver a result, it should only be called
as a statement.
@@ -1795,7 +1795,7 @@ operation with the remote @acronym{SMTP} server.
@end table
These three timeouts can be set using the following @dfn{pragmatic
-comments}@footnote{@xref{Pragmatic comments}, for the detailed
+comments}@footnote{@xref{Pragmatic comments}, for a detailed
description of pragmatic comments.} in the script file:
@smallexample
@@ -1983,7 +1983,7 @@ declarations as well as outside of them.
variables}, that are visible to all handlers and functions, and
@dfn{automatic variables}, that are available only within the handler
or function where they are declared. For our purpose we need a global
-variable (@xref{Variables, Variable classes}, for the detailed description
+variable (@xref{Variables, Variable classes}, for detailed descriptions
of both kinds of variables).
The following example illustrates the approach that allows to use
@@ -2286,7 +2286,7 @@ to the reader.
together with greylisting. To implement it, @command{mailfromd}
provides the function @code{dbmap}, which takes two mandatory arguments:
@code{dbmap(@var{file}, @var{key})} (it also allows an optional third
-argument, see @ref{dbmap}, for the description of it). The first argument is
+argument, see @ref{dbmap}, for more information on it). The first argument is
the name of the @acronym{DBM} file where to search for the key, the second one
is the key to be searched. Assuming you keep your whitelist database
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
it to the rest of the handlers, since @command{mailfromd} will cache
it. For example, if your filter script contains @samp{envfrom} and
@samp{envrcpt} handlers, export @samp{i} for @samp{envfrom}.
-@xref{Sendmail Configuration}, for the instructions on how to ensure
+@xref{Sendmail Configuration}, for instructions on how to ensure
it.
@xopindex{debug, introduced}
@@ -3042,7 +3042,7 @@ regular expression. For example:
@subheading Uncaught exceptions
Another kind of runtime errors are @dfn{uncaught exceptions},
i.e. exceptional conditions for which no handler was installed
-(@xref{Exceptions}, for the information on exceptions and on how to
+(@xref{Exceptions}, for information on exceptions and on how to
handle them). These errors mean that the programmer (i.e. you), made
no provision for some specific conditions. For example, consider the
following code:
@@ -3607,7 +3607,7 @@ The following options control @acronym{I/O} operations over @acronym{TCP}.
Sets initial connection timeout. If the connection is not
established within this time, the corresponding probing function
returns temporary failure. The default value is
-@value{CONNECT-TIMEOUT}. @xref{SMTP Timeouts}, for the
+@value{CONNECT-TIMEOUT}. @xref{SMTP Timeouts}, for a
detailed description.
@end deffn
@@ -3625,7 +3625,7 @@ the detailed description.
Sets @acronym{I/O} operation timeout in seconds. @command{Mailfromd} will
wait the given amount of time for the success of each @acronym{I/O} operation
with the remote @acronym{MX}. Default timeout is @value{IO-TIMEOUT}.
-@xref{SMTP Timeouts}, for the detailed description.
+@xref{SMTP Timeouts}, for a detailed description.
The form @code{timeout} is retained for backward compatibility and is
considered deprecated.
@@ -3706,7 +3706,7 @@ debugging @command{mailfromd}.
@xprindex{stack-trace}
Enables dumping stack traces on runtime errors. This feature is
useful for locating the source of an error, especially in complex
-scripts. @xref{tracing runtime errors}, for the detailed description.
+scripts. @xref{tracing runtime errors}, for a detailed description.
@end deffn
@noindent
@@ -3715,7 +3715,7 @@ These options control program privileges after startup:
@deffn {pragma option} user @var{string}
@xprindex{user}
Switch to this user's privileges after startup.
-@xref{Starting and Stopping}, for the discussion of
+@xref{Starting and Stopping}, for a discussion of
the privileges @command{mailfromd} runs under and the options that
affect them. See also @code{group} below.
@end deffn
@@ -3824,7 +3824,8 @@ syntax is:
@item #pragma database @var{dbname} expire-interval @var{interval}
Set the expiration interval for the database
-@var{dbname}. (@xref{time interval specification}, for the syntax of @var{interval}).
+@var{dbname}. (@xref{time interval specification}, for more
+information on @var{interval} syntax).
@end table
The parameter @var{dbname} can be one of the following:
@@ -4099,7 +4100,7 @@ our sample string will actually be compiled as:
$f " last connected from " %last_ip ";"
@end smallexample
-@xref{Concatenation}, for the description of this construct. You can
+@xref{Concatenation}, for a description of this construct. You can
easily see how various strings are interpreted by using
@option{--dump-tree} option (@pxref{--dump-tree}). For our sample
string it will produce:
@@ -4133,7 +4134,7 @@ subexpression in the last @command{matches} statement@footnote{The
subexpressions are numbered by the positions of their opening
parentheses, left to right.}. Any back reference occurring within a
double-quoted string is replaced by the value of the corresponding
-subexpression. @xref{Special comparisons}, for the detailed
+subexpression. @xref{Special comparisons}, for a detailed
description of this process. Back reference interpretation is
performed at run time.
@@ -4375,7 +4376,7 @@ preprocessor is used, or to an empty string if it cannot, e.g.:
__preproc__ @result{} "/usr/bin/m4 -s"
@end smallexample
- @xref{Preprocessor}, for the information on preprocessor and its
+ @xref{Preprocessor}, for information on preprocessor and its
features.
@end deftypevr
@@ -6100,8 +6101,8 @@ A mx10.gnu.org: Sun Dec 3 10:56:12 2006 199.232.76.166
and that it expires on Sunday, December 3d, at 10:56:12.
Of course, the rest of database management options are also valid
-for @acronym{DNS} database. @xref{Database Maintenance}, for the detailed
-discussion of these.
+for @acronym{DNS} database. @xref{Database Maintenance}, for more
+information on these.
@node Database functions
@subsubsection Database Functions
@@ -6150,7 +6151,7 @@ database error occurs while attempting to retrieve the record,
@end smallexample
@noindent
-@xref{Modules}, for the description of @acronym{MFL} module system.
+@xref{Modules}, for a description of @acronym{MFL} module system.
@end deftypefn
@deftypefn {Built-in Function} void dbput (string @var{db}, @
@@ -6177,7 +6178,7 @@ the function returns without reporting an error.
@end smallexample
@noindent
-@xref{Modules}, for the description of @acronym{MFL} module system.
+@xref{Modules}, for a description of @acronym{MFL} module system.
@end deftypefn
@deftypefn {Built-in Function} void dbdel (string @var{db}, @
@@ -6364,10 +6365,10 @@ measured in seconds.
to the format specification @var{format}. Ordinary characters placed
in the format string are copied to the output without conversion.
Conversion specifiers are introduced by a @samp{%} character.
-@xref{Time and Date Formats}, for the detailed description of the
+@xref{Time and Date Formats}, for a detailed description of the
conversion specifiers. We recommend using single quotes
around @var{fmt} to prevent @samp{%} specifiers from being interpreted
-as @code{Mailfromd} variables (@xref{Literals}, for the
+as @code{Mailfromd} variables (@xref{Literals}, for a
discussion of quoted literals and variable interpretation within
them).
@@ -6567,7 +6568,7 @@ done
(controlled by @code{#pragma database greylist} pragma, @pxref{database}). The argument @var{interval} gives the greylisting
interval in seconds. The function stores the number of seconds left to the end
of greylisting period in the internal variable
-@code{greylist_seconds_left}. @xref{Greylisting}, for the detailed
+@code{greylist_seconds_left}. @xref{Greylisting}, for a detailed
explanation.
The function @code{greylist} can signal @code{dbfailure} exception.
@@ -6583,7 +6584,7 @@ explanation.
number @var{sample-interval})
Returns the mail sending rate for @var{key} per
-@var{sample-interval}. @xref{Sending Rate}, for the detailed
+@var{sample-interval}. @xref{Sending Rate}, for a detailed
discussion.
@end deftypefn
@@ -7214,10 +7215,9 @@ Normally it is the domain portion of the @code{MAIL FROM} or
Before returning, the @code{check_host} function stores
additional information in the same global variables, as
-@code{spf_check_host}. @xref{spf-globals, the list}, for the
-description of these. In addition, it sets the variable
-@code{spf_cached} to @samp{1} if cached data were used, or to @samp{0}
-otherwise.
+@code{spf_check_host}. @xref{spf-globals, the list}, for details.
+In addition, it sets the variable @code{spf_cached} to @samp{1} if
+cached data were used, or to @samp{0} otherwise.
@end deftypefn
@deftypefn {Library Function} string spf_status_string (number @var{code})
@@ -7400,7 +7400,7 @@ catalog, set for the textual domain @var{domain}.
@xref{Plural forms, Additional functions for plural forms,
Additional functions for plural forms, gettext, GNU gettext
-utilities}, for the detailed discussion of the plural form handling in
+utilities}, for a discussion of the plural form handling in
different languages.
@end deftypefn
@@ -7435,7 +7435,7 @@ catalog, set for the current textual domain.
@xref{Plural forms, Additional functions for plural forms,
Additional functions for plural forms, gettext, GNU gettext
-utilities}, for the detailed discussion of the plural form handling in
+utilities}, for a discussion of the plural form handling in
different languages.
@end deftypefn
@@ -7447,7 +7447,7 @@ piece of code.
@deftypefn {Built-in Function} void debug (string @var{spec})
Enable debugging. The value of @var{spec} sets the debugging level.
-@xref{debugging level specification}, for the description of its format.
+@xref{debugging level specification}, for a description of its format.
@end deftypefn
@deftypefn {Built-in Function} number debug_level ([string @var{srcname}])
@@ -7536,7 +7536,7 @@ simultaneously:
@deftypefn {Built-in Function} void program_trace (string @var{module})
Enable tracing for a set of modules given in @var{module} argument.
-@xref{--trace-program}, for the description of its format.
+@xref{--trace-program}, for a description of its format.
@end deftypefn
@deftypefn {Built-in Function} void cancel_program_trace (string @var{module})
@@ -7859,7 +7859,7 @@ done
@cindex valid_domain, definition
@item @code{valid_domain}@*
-@xref{valid_domain}, for the description of this function. Its
+@xref{valid_domain}, for a description of this function. Its
definition follows:
@smallexample
@@ -8109,7 +8109,7 @@ basic regular expressions, and @samp{(} and @samp{)} for extended
regular expressions. Also make sure you properly escape all special
characters (backslashes in particular) in double-quoted strings, or
use single-quoted strings to avoid having to do so
-(@pxref{singe-vs-double}, for the comparison of the two forms).
+(@pxref{singe-vs-double}, for a comparison of the two forms).
@node Boolean expressions
@subsection Boolean Expressions
@@ -8871,7 +8871,7 @@ when its first argument is not a valid @acronym{IP} address.
@cindex ioerr, exception type
@item ioerr
An error occurred during the input-output operation. @xref{I/O
-functions}, for the description of functions that can signal this
+functions}, for a description of functions that can signal this
exception.
@cindex macroundef, exception type
@@ -9469,7 +9469,7 @@ yields @code{true}
Provides a @code{printf} statement, that formats its optional
parameters in accordance with @var{format} and sends the resulting
string to the current log output (@pxref{Logging and Debugging}).
-@xref{String formatting}, for the description of @var{format}.
+@xref{String formatting}, for a description of @var{format}.
Example usage:
@@ -10064,7 +10064,7 @@ the action to all available databases. @xref{compact cronjob}.
@itemx --domain=@var{string}
Set default @acronym{SMTP} domain. Overrides @samp{#pragma option ehlo}
(@pxref{pragma ehlo}). This option is
-deprecated@footnote{@xref{31x-400}, for the detailed description of
+deprecated@footnote{@xref{31x-400}, for a detailed description of
why it is deprecated.}: use @option{-v ehlo_domain=@var{string}} instead.
@opsummary{ehlo}
@@ -10075,7 +10075,7 @@ Same as @option{--domain}.
@item -e @var{interval}
@itemx --expire-interval=@var{interval}
Set expiration intervals for all databases to the specified interval.
-@xref{time interval specification}, for the description of
+@xref{time interval specification}, for a description of
@var{interval} format. The option overrides @samp{#pragma option
expire-interval} (@pxref{pragma expire-interval}), which you are
advised to use instead.
@@ -10112,7 +10112,7 @@ compaction if any such error is encountered.
@itemx -I @var{dir}
Add the directory @var{dir} to the list of directories to be searched
for header files. This will affect the functioning of @code{#include}
-statement. @xref{include}, for the discussion of file inclusion.
+statement. @xref{include}, for a discussion of file inclusion.
@opsummary{lock-retry-count}
@item --lock-retry-count=@var{number}
@@ -10130,7 +10130,7 @@ lock-retry-count}, for more information about database locking.
This option overrides the value set by @code{#pragma option
lock-retry-timeout} (@pxref{pragma lock-retry-timeout}.
-@xref{time interval specification}, for the description of valid
+@xref{time interval specification}, for a description of valid
@var{interval} formats.
@opsummary{mailer}
@@ -10144,7 +10144,7 @@ Functions}.
Set postmaster email address. Overrides @samp{#pragma option ehlo},
which you are advised to use instead (@pxref{pragma ehlo}). The
default is null return address (@samp{""}). This option is
-deprecated@footnote{@xref{31x-400}, for the detailed
+deprecated@footnote{@xref{31x-400}, for a detailed
description of why it is deprecated.}: use @option{-v
mailfrom_address=@var{string}} instead.
@@ -10221,7 +10221,7 @@ option source}, which you are advised to use instead (@pxref{pragma source}).
@item --time-format=@var{format}
Set format to be used for timestamps in listings, produced by
@option{--list}. The @var{format} is any valid @code{strftime} format
-string, see @ref{Time and Date Formats}, for the detailed description.
+string, see @ref{Time and Date Formats}, for a detailed description.
The default @var{format} is @samp{%c} (@pxref{%c time format}). To
analyze @kbd{mailfromd --list} output using text tools, such as
@code{awk} or @code{grep}, the following format might be useful:
@@ -10240,7 +10240,7 @@ user}). Default user is @samp{@value{DEFAULT-USER}}.
@itemx --variable @var{var}=@var{value}
Assign @var{value} to the global variable @var{var}. The variable
must be declared in your startup script. @xref{overriding initial
-values}, for the detailed discussion of this option.
+values}, for a detailed discussion of this option.
@ignore
-- Not used any more, but supported for backward compatibility
@@ -10253,7 +10253,7 @@ values}, for the detailed discussion of this option.
@node Timeout Control
@subsection Timeout Control
-@xref{time interval specification}, for the format of @var{interval} value.
+@xref{time interval specification}, for information on @var{interval} format.
@table @option
@opsummary{milter-timeout}
@@ -10299,7 +10299,7 @@ rules will be output.
@item --dump-macros
Show Sendmail macros used in the script file. The macro names
are displayed as comma-separated lists, grouped by handler names.
-@xref{Sendmail Configuration}, for the detailed description of this
+@xref{Sendmail Configuration}, for a detailed description of this
option and its usage.
@opsummary{dump-tree}
@@ -10335,7 +10335,7 @@ else but for debugging, as it terribly degrades performance!
Add @acronym{MFL} stack trace information to runtime error output.
Overrides @code{#pragma option stack-trace}, which you are advised to
use instead (@pxref{pragma stack-trace}). @xref{tracing runtime
-errors}, for the detailed description of this feature.
+errors}, for more information on this feature.
@opsummary{gacopyz-log}
@item --gacopyz-log=@var{level}

Return to:

Send suggestions and report system problems to the System administrator.