diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2007-05-11 14:53:23 +0000 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2007-05-11 14:53:23 +0000 |
commit | 9f0e5dee4a53772da7446706e789f3a96385011b (patch) | |
tree | f6e3d49b603da70586aac607afb9e01f559ed41c /doc | |
parent | d700d19138fa098a2f83eff45301ccfaed0d928f (diff) | |
download | mailfromd-9f0e5dee4a53772da7446706e789f3a96385011b.tar.gz mailfromd-9f0e5dee4a53772da7446706e789f3a96385011b.tar.bz2 |
start cindexes with a lower case letter
git-svn-id: file:///svnroot/mailfromd/trunk@1421 7a8a7f39-df28-0410-adc6-e0d955640f24
Diffstat (limited to 'doc')
-rw-r--r-- | doc/mailfromd.texi | 96 |
1 files changed, 51 insertions, 45 deletions
diff --git a/doc/mailfromd.texi b/doc/mailfromd.texi index 272a3dfe..d8aa4da5 100644 --- a/doc/mailfromd.texi +++ b/doc/mailfromd.texi @@ -975,7 +975,7 @@ the corresponding section below. @node 31x-400 @section Upgrading from 3.1.x to 4.0 -@cindex Upgrading from 3.1.x to 4.0 +@cindex upgrading from 3.1.x to 4.0 Before building this version, please re-read the chapter @xref{Building}, especially the section @xref{syslog-async, Using @@ -1427,7 +1427,7 @@ installs a handler for @samp{envfrom} state, which always approves the message for delivery, without any further interaction with @command{mailfromd}. -@cindex Actions, introduced +@cindex actions, introduced The word @code{accept} in the above example is an @dfn{action}. @dfn{Action} is a special language statement that causes the execution of the program to stop and to return a response code to @@ -1735,7 +1735,7 @@ such delays are due to low network bandwidth, but sometimes remote sites impose them willingly, as a spam-fighting measure@footnote{My private opinion is that such practice is completely lame.} -@cindex Timeouts, defined +@cindex timeouts, defined @command{Mailfromd} polling functions implement three distinct @dfn{timeout} values: @@ -1917,7 +1917,7 @@ handler, you will have to store it in a @dfn{variable} in the @code{helo} handler and then use this variable value in the other handler. This brings us to the concept of variables in @command{mailfromd} scripts. -@cindex Variables, introduced +@cindex variables, introduced @cindex variable declaration A variable is declared using the following syntax: @@ -2248,7 +2248,7 @@ techniques described in previous sections and is left as an exercise to the reader. @anchor{whitelisting} -@cindex Whitelisting +@cindex whitelisting One special case is @dfn{whitelisting}, which is often used together with greylisting. To implement it, @command{mailfromd} provides the function @code{dbmap}, which takes two mandatory arguments: @@ -3245,7 +3245,7 @@ used as a literal, or to require the corresponding module @node MFL, Mailfromd Configuration, Tutorial, Top @chapter Mail Filtering Language @cindex MFL -@cindex Mail filtering language +@cindex mail filtering language The @dfn{mail filtering language}, or @acronym{MFL}, is a special language designed for writing filter scripts. It has a simple syntax, @@ -3284,7 +3284,7 @@ amount of white-space characters (i.e. spaces, tabulations or newlines). @node Comments @section Comments -@cindex Comments +@cindex comments Two types of comments are allowed: @sc{c}-style, enclosed between @samp{/*} and @samp{*/}, and shell-style, starting with @samp{#} character and extending up to the end of line: @@ -3403,7 +3403,7 @@ statement is similar to @code{#include_once}. @xref{Modules}. @anchor{Pragmatic comments} -@cindex Pragmatic comments +@cindex pragmatic comments @cindex #pragma statement @kwindex #pragma If @samp{#} is immediately followed by word @samp{pragma} (with @@ -3463,7 +3463,7 @@ false value. name. @item interval -@cindex Time Interval Specification +@cindex time Interval Specification @anchor{time interval specification} The @dfn{time interval specification} is a string that defines an interval, much the same way we do this in English: it consists of one @@ -3947,7 +3947,7 @@ or @samp{A} through @samp{F}), for example: @code{0x3ef1}. @node Literals @section Literals -@cindex Literals +@cindex literals A literal is any sequence of alpha-numeric characters that is not a reserved word (@pxref{Reserved Words}), or any sequence of characters enclosed in double or single quotation marks. @@ -3979,7 +3979,7 @@ groups separated by dots represent an extended reply code as per @dfn{macro expansion}, @dfn{variable interpretation} and @dfn{back reference interpretation}. -@cindex Backslash interpretation +@cindex backslash interpretation @dfn{Backslash interpretation} is performed at compilation time. It consists in replacing the following @dfn{escape sequences} with the corresponding single characters: @@ -4020,8 +4020,8 @@ is @var{hh}. For example: @var{o} is an octal digit, is replaced with the character whose @acronym{ASCII} value is @var{ooo}. -@cindex Variable interpretation -@cindex Macro expansion +@cindex variable interpretation +@cindex macro expansion Macro expansion and variable interpretation occur at run-time. During these phases all Sendmail macros (@pxref{Sendmail Macros}), @command{mailfromd} variables (@pxref{Variables}), and constants @@ -4065,7 +4065,7 @@ will be expanded to "postmaster@@gnu.org.ua last connected from 127.0.0.1;" @end smallexample -@cindex Back reference interpretation +@cindex back reference interpretation A @dfn{back reference} is a sequence @samp{\@var{d}}, where @var{d} is a decimal number. It refers to the @var{d}th parenthesized subexpression in the last @command{matches} statement@footnote{The @@ -4104,8 +4104,8 @@ make discovering real syntax errors difficult. @xref{Cautions}. Therefore @node Here Documents @section Here Documents -@cindex Here document -@cindex Multiline strings +@cindex here document +@cindex multiline strings @dfn{Here-document} is a special form of a string literal is, allowing to specify multiline strings without having to use backslash escapes. The format of here-documents is: @@ -4193,7 +4193,7 @@ TEXT @node Sendmail Macros @section Sendmail Macros -@cindex Macros, referencing +@cindex macros, referencing @cindex Sendmail macros, referencing Sendmail macros are referenced exactly the same way they are in @file{sendmail.cf} configuration file, i.e. @samp{$@var{name}}, @@ -4213,7 +4213,7 @@ result in raising a @code{macroundef} exception at the run time @node Constants @section Constants -@cindex Constants, defining +@cindex constants, defining @cindex const A @dfn{constant} is a symbolic name for an @acronym{MFL} value. Constants are defined using @code{const} statement: @@ -4227,7 +4227,7 @@ where @var{name} is an identifier, and @var{expr} is any valid @acronym{MFL} expression evaluating immediately to a constant literal or numeric value. -@cindex Constants, using in program text +@cindex constants, using in program text After defining, any appearance of @var{name} in the program text is replaced by its value. For example: @@ -4240,7 +4240,7 @@ const text "X is " defines the numeric constant @samp{x} with the value @samp{5}, and the literal constant @samp{text} with the value @samp{X is }. -@cindex Constants, using in literals +@cindex constants, using in literals Constants can also be used in literals. To expand a constant within a literal string, prepend a percent sign to its name, e.g.: @@ -4334,7 +4334,7 @@ script file @code{/etc/mailfromd.rc}, like this: @node Variables @section Variables -@cindex Variables, defined +@cindex variables, defined Variables represent regions of memory used to hold variable data. These memory regions are identified by @dfn{variable names}. A variable name must begin with a letter or underscore and must consist @@ -4402,7 +4402,7 @@ declaration}.@footnote{Notice, that this differs from the way variables were handled in versions up to 3.0.2, which declared all variables as global.} -@cindex Variables, referencing +@cindex variables, referencing Variables are referenced using the notation @samp{%@var{name}}. The variable being referenced must have been declared earlier (either explicitly or implicitly). @@ -4414,7 +4414,7 @@ explicitly or implicitly). @node Predefined variables @subsection Predefined Variables -@cindex Predefined variables +@cindex predefined variables @cindex variables, predefined Several variables are predefined. In @command{mailfromd} version @value{VERSION} these are: @@ -4511,7 +4511,7 @@ example of how to change it: set mailfrom_address "postmaster@@my.domain.com" @end smallexample -@cindex Multiple sender addresses +@cindex multiple sender addresses You can set this value to a comma-separated list of email addresses, in which case the probing will try each address until either the remote party accepts it or the list of addresses is exhausted, @@ -4549,7 +4549,7 @@ Spam keywords for the message, set by @code{sa} function (@pxref{sa}). @node Back references @section Back references -@cindex Back references, in program text +@cindex back references, in program text A @dfn{back reference} is a sequence @samp{\@var{d}}, where @var{d} is a decimal number. It refers to the @var{d}th parenthesized subexpression in the last @command{matches} statement@footnote{The @@ -5421,8 +5421,8 @@ See the description of @code{stdpoll} for the detailed information. In @code{on} context, it is synonymous to @code{poll host @var{host}}. @end deftypefn -@cindex Multiple sender addresses, using with polling commands. -@cindex Trying several sender addresses +@cindex multiple sender addresses, using with polling commands. +@cindex trying several sender addresses The @var{mailfrom} argument can be a comma-separated list of email addresses, which can be useful for servers that are unusually picky about sender addresses. It is advised, however, that this list always @@ -5815,14 +5815,14 @@ returned. Otherwise, the function performs actual @acronym{DNS} lookup, stores the obtained data in the database and returns it. @cindex @acronym{DNS} cache database, expiration times -@cindex Expiration time, @acronym{DNS} cache database +@cindex expiration time, @acronym{DNS} cache database The expiration date for each new record is obtained by increasing the current system timestamp by the value of @acronym{TTL} obtained from the @acronym{DNS} reply. If the latter carried several @acronym{TTL}s (e.g. if it was an @samp{MX} request), the smallest of them is used. @cindex @acronym{DNS} cache database, negative caching -@cindex Negative caching, @acronym{DNS} cache database +@cindex negative caching, @acronym{DNS} cache database @cindex @acronym{DNS} cache database, negative expiration interval If the @acronym{DNS} lookup failed, the result is stored in the database as well. In this case, the value part of the record consists only of the @@ -5843,7 +5843,7 @@ settings of the @acronym{DNS} databases. The following example illustrates them @end smallexample @cindex @acronym{DNS} cache database, listing -@cindex Listing @acronym{DNS} cache database +@cindex listing @acronym{DNS} cache database The contents of the @acronym{DNS} database can be listed using the following command: @@ -7239,9 +7239,9 @@ done @end group @end smallexample -@cindex Procedures -@cindex Function returning void -@cindex Void functions +@cindex procedures +@cindex function returning void +@cindex void functions The @code{returns} part in the function declaration is optional. A declaration lacking it defines a @dfn{procedure}, or @dfn{void function}, i.e. a function that is not supposed to return any value. @@ -7258,8 +7258,10 @@ done @end group @end smallexample -@cindex Automatic variables -@cindex Local variables +@cindex automatic variables +@cindex variables, local +@cindex local variables +@cindex variables, automatic A variable declared within a function becomes a local variable to this function. Its lexical scope ends with the terminating @code{done} statement. @@ -7469,7 +7471,7 @@ done @node Expressions @section Expressions -@cindex Expressions +@cindex expressions Expressions are language constructs, that evaluate to a value, that can subsequently be echoed, tested in a conditional statement, assigned to a variable or passed to a function. @@ -7698,7 +7700,8 @@ If @code{@var{x} @result{} @code{true}}, the result is @code{true} and @node Precedence @subsection Operator Precedence -@cindex Operator precedence, defined +@cindex operator precedence, defined +@cindex precedence, operators Operator @dfn{precedence} is an abstract value associated with each language operator, that determines the order in which operators are executed when they appear together within a single expression. @@ -7708,7 +7711,8 @@ expression @code{a + b * c} is evaluated in the following order: first @code{b} is multiplied by @code{c}, then @code{a} is added to the product. -@cindex Operator associativity +@cindex operator associativity +@cindex associativity, operators When operators of equal precedence are used together they are evaluated from left to right (i.e., they are @dfn{left-associative}), except for comparison operators, which are non-associative (these are @@ -7852,7 +7856,7 @@ program. @node Actions @subsection Action Statements -@cindex Actions +@cindex actions An @dfn{action} statement instructs @command{mailfromd} to perform a certain action over the message being processed. There are two kinds of actions: return actions and header manipulation actions. @@ -7918,7 +7922,8 @@ reject 503 5.0.0 "Need HELO command" @end smallexample @anchor{header manipulation} -@cindex Header manipulation actions +@cindex header manipulation actions +@cindex actions, header manipulation Header manipulation actions allow you to add, delete or modify message @acronym{RFC} 2822 headers. @@ -8032,7 +8037,8 @@ done @node Conditionals @section Conditional Statements -@cindex Conditional statements +@cindex conditional statements +@cindex statements, conditional @dfn{Conditional expressions}, or conditionals for short, test some conditions and alter the control flow depending on the result. There are two kinds of conditional statements: @dfn{if-else} @@ -8920,7 +8926,7 @@ done @node Modules @section Modules -@cindex Module, defined +@cindex module, defined A module is an @acronym{MFL} source file containing a collection of conceptually united functions and data. Currently, there are no special syntax rules that make an arbitrary source file a module, it @@ -9087,8 +9093,8 @@ done @node Reserved Words @section Reserved Words -@cindex Reserved Words -@cindex Keywords +@cindex reserved words +@cindex keywords For your reference, here is an alphabetical list of all reserved words: @@ -9760,7 +9766,7 @@ group}). In example above, you need to use the following directive: (The same effect can be achieved with @option{--group} command line option: @kbd{mailfromd --group=smmsp}). -@cindex Signals +@cindex signals @cindex SIGQUIT @cindex SIGTERM @cindex SIGINT |