aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2007-04-28 12:44:59 +0000
committerSergey Poznyakoff <gray@gnu.org.ua>2007-04-28 12:44:59 +0000
commitf5f4f4f7135e354f4a5c68d1b68db67562e42250 (patch)
treeb814b3c5fc40437634dc15f197d6fa18b7e17734
parent2b4c601367084a290f4405588a06da71bbaf1e87 (diff)
downloadmailfromd-f5f4f4f7135e354f4a5c68d1b68db67562e42250.tar.gz
mailfromd-f5f4f4f7135e354f4a5c68d1b68db67562e42250.tar.bz2
Minor wording fixes
git-svn-id: file:///svnroot/mailfromd/trunk@1394 7a8a7f39-df28-0410-adc6-e0d955640f24
-rw-r--r--doc/mailfromd.texi206
-rw-r--r--doc/mtasim.texi8
2 files changed, 107 insertions, 107 deletions
diff --git a/doc/mailfromd.texi b/doc/mailfromd.texi
index 890def01..9d72db8d 100644
--- a/doc/mailfromd.texi
+++ b/doc/mailfromd.texi
@@ -93,7 +93,7 @@ documents @command{mailfromd} Version @value{VERSION}.
* MFL:: The Mail Filtering Language.
* Mailfromd Configuration:: Configuring @command{mailfromd}.
* Sendmail Configuration:: Configuring Sendmail to use @command{mailfromd}.
-* mtasim:: MTA simulator.
+* mtasim:: An @acronym{MTA} simulator.
* Reporting Bugs:: How to Report a Bug.
Appendices
@@ -384,14 +384,14 @@ always discarded.
The described method of address verification is called
@dfn{standard} method throughout this document. @command{Mailfromd}
also implements a method we call @dfn{strict}. When using strict
-method, @command{mailfromd} first resolves IP address of sender
+method, @command{mailfromd} first resolves @acronym{IP} address of sender
machine to a fully qualified domain name. Then it obtains MX records
for this machine, and then proceeds with probing as described above.
So, the difference between the two methods is in the set of MX
records that are being probed: standard method queries MXs based on
the sender email domain, strict method works with MXs for the sender
-IP address.
+@acronym{IP} address.
Strict method allows to cut off much larger amount of spam,
although it does have many drawbacks. Returning to our example above,
@@ -409,7 +409,7 @@ urge the remote party to retry sending his/her message later.
@cindex caching @acronym{DNS} requests
After receiving a definite answer, @command{mailfromd} will
cache it in its database, so that next time your @acronym{MTA} receives a
-message from that address (or from the sender IP/email address pair,
+message from that address (or from the sender @acronym{IP}/email address pair,
for strict method), it will not waste its time trying to reach MX
servers again. The records remain in the cache database for a certain
time, after which they are discarded.
@@ -437,7 +437,7 @@ the expiration timeout in your cache database.
@item When verifying the remote address, no attempt to actually
deliver the message is made. If @acronym{MTA} accepts the address,
@command{mailfromd} assumes it is OK. However in reality, mail for a
-remote address can bounce @emph{after} the nearest MTA accepts the
+remote address can bounce @emph{after} the nearest @acronym{MTA} accepts the
recipient address.
This drawback can often be avoided by combining sender address
@@ -1371,7 +1371,7 @@ designed for a particular task. In order to access a library
function, you must first @dfn{require} a module it is defined in.
This is done using @code{#require} statement. For example, the
function @code{hostname} looks up in the @acronym{DNS} the name
-corresponding to the IP address specified as its argument. This
+corresponding to the @acronym{IP} address specified as its argument. This
function is defined in module @file{dns.mf}, so before calling it you
must require this module:
@@ -1393,9 +1393,9 @@ module on disk and loads it if it is available.
do not have a proper reverse delegation in the Domain Name System.
In the previous section we introduced the library function
@code{hostname}, that looks up in the @acronym{DNS} the name corresponding to
-the IP address specified as its argument. If there is no
+the @acronym{IP} address specified as its argument. If there is no
corresponding name, the function returns its argument unchanged. This
-can be used to test if the IP was resolved, as illustrated in the
+can be used to test if the @acronym{IP} was resolved, as illustrated in the
example below:
@smallexample
@@ -1415,7 +1415,7 @@ done
after which the definition of @code{hostname} becomes available.
An orthogonal function, @code{resolve}, which resolves the symbolic
-name to the corresponding IP address is provided in the same
+name to the corresponding @acronym{IP} address is provided in the same
@file{dns.mf} module.
@node Checking Sender Address
@@ -1502,10 +1502,10 @@ done
@end smallexample
@node SMTP Timeouts
-@section SMTP Timeouts
+@section @acronym{SMTP} Timeouts
When using polling functions, it is important to take into account
-possible delay, which can occur in SMTP transactions. Most often
+possible delay, which can occur in @acronym{SMTP} transactions. Most often
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.}
@@ -1644,8 +1644,8 @@ done
Another way to avoid infinite looping caused by endless recursive
triggering of @code{on poll}, is to accept relaying of all email originating
-from the local IP cluster with (trusted) clients and SMTP servers,
-provided that the server running mailfromd falls within this IP range:
+from the local @acronym{IP} cluster with (trusted) clients and @acronym{SMTP} servers,
+provided that the server running mailfromd falls within this @acronym{IP} range:
@smallexample
@group
@@ -1670,12 +1670,12 @@ done
@end smallexample
Here, triggering the @code{on poll} statement with more than 1 recursion
-is avoided for all local emails, originating from non-local IPs
-(outside of CIDR range 193.232.0.0/16) - when such an email arrives,
+is avoided for all local emails, originating from non-local @acronym{IP}s
+(outside of @acronym{CIDR} range 193.232.0.0/16) - when such an email arrives,
handler execution falls through to @code{on poll}, which will cause
the server to connect back to itself for local email verification, but
this time, the @code{on poll} check will be skipped, as the server's
-own IP address will be caught by @code{match_cidr} statement.
+own @acronym{IP} address will be caught by @code{match_cidr} statement.
This method has particular advantage over the previous one: it
does not rely on sendmail's relay-domains control, which can be,
alone, too wide for sane relaying control.
@@ -1932,7 +1932,7 @@ interval, which is an integer number. For example, the number
updates the rate record for the given @var{key}, and returns its
value, converted to messages per interval. For example, the following
code limits the mail sending rate for each @samp{email
-address}-@samp{IP} combination to 180 per hour. If the rate value is
+address}-@samp{@acronym{IP}} combination to 180 per hour. If the rate value is
exceeded, the sender is returned a temporary failure response:
@smallexample
@@ -1967,7 +1967,7 @@ intervals are discussed in @ref{time interval specification}.
Greylisting is a simple method of defending against the spam
proposed by Evan Harris. In few words, it consists in recording the
-@samp{sender IP}-@samp{sender email}-@samp{recipient email} triplet of
+@samp{sender @acronym{IP}}-@samp{sender email}-@samp{recipient email} triplet of
mail transactions. Each time the unknown triplet is seen, the
corresponding message is rejected with @code{tempfail} code. If the
mail is legitimate, this will make the originating server will retry
@@ -2036,7 +2036,7 @@ done
@end smallexample
In real life you will have to avoid greylisting some messages, in
-particular those coming from the @samp{<>} address and from the IP
+particular those coming from the @samp{<>} address and from the @acronym{IP}
addresses in your relayed domain. It can easily be done using the
techniques described in previous sections and is left as an exercises
to the reader.
@@ -2212,7 +2212,7 @@ described in the following table:
@table @asis
@item A
- Each field contains the next IP address corresponding to the lookup
+ Each field contains the next @acronym{IP} address corresponding to the lookup
key. Notice, that currently (version @value{VERSION}) there can be at
most one field here, but it may change in the future.
@@ -3144,7 +3144,7 @@ a true value, and @code{no}, @code{false} or @code{nil} to indicate a
false value.
@item address
- An IP address in ``dotted-quad'' notation or a fully-qualified host
+ An @acronym{IP} address in ``dotted-quad'' notation or a fully-qualified host
name.
@item interval
@@ -3217,7 +3217,7 @@ detailed description.
@deffn {pragma option} initial-response-timeout @var{interval}
@xprindex{initial-response-timeout}
- Sets the time to wait for the initial SMTP response. Default is
+ Sets the time to wait for the initial @acronym{SMTP} response. Default is
@value{INITIAL-RESPONSE-TIMEOUT}. @xref{SMTP Timeouts}, for
the detailed description.
@end deffn
@@ -3375,7 +3375,7 @@ port type is not yet supported.
@deffn {pragma option} milter-timeout @var{interval}
@xprindex{milter-timeout}
Set the timeout value for connection between the filter
-and the MTA. Default value is @value{MILTER-TIMEOUT}. You
+and the @acronym{MTA}. Default value is @value{MILTER-TIMEOUT}. You
normally do not need to change this value.
@end deffn
@@ -4159,7 +4159,7 @@ qualified domain name of the host where @command{mailfromd} is run.
@deftypevar {Predefined Variable} string last_poll_host
Polling functions (@pxref{Polling functions}) set this variable before
-returning. It contains the host name or IP address of the last polled host.
+returning. It contains the host name or @acronym{IP} address of the last polled host.
@end deftypevar
@deftypevar {Predefined Variable} string last_poll_recv
@@ -4309,14 +4309,14 @@ the available handlers and their arguments:
@deffn {Handler} connect (string $1, number $2, number $3, string $4)
@subsubheading Invocation
-This handler is called once at the beginning of each SMTP connection.
+This handler is called once at the beginning of each @acronym{SMTP} connection.
@subsubheading Arguments
@enumerate 1
@item @code{string};
-The host name of the message sender, as reported by MTA. Usually it
+The host name of the message sender, as reported by @acronym{MTA}. Usually it
is determined by a reverse lookup on the host address. If the reverse
-lookup fails, @samp{$1} will contain the message sender's IP address
+lookup fails, @samp{$1} will contain the message sender's @acronym{IP} address
enclosed in square brackets (e.g. @samp{[127.0.0.1]}).
@item @code{number};
@@ -4328,17 +4328,17 @@ definitions for the address families. Supported families are:
@cindex FAMILY_INET
@multitable @columnfractions 0.20 .10 0.70
@headitem Constant @tab Value @tab Meaning
-@item FAMILY_STDIO @tab 0 @tab Standard input/output (the MTA is
+@item FAMILY_STDIO @tab 0 @tab Standard input/output (the @acronym{MTA} is
run with @option{-bs} option)
@item FAMILY_UNIX @tab 1 @tab @acronym{UNIX} socket
-@item FAMILY_INET @tab 2 @tab IPv4 protocol
+@item FAMILY_INET @tab 2 @tab @acronym{IP}v4 protocol
@end multitable
@item @code{number};
Port number if @samp{$2} is @samp{FAMILY_INET}.
@item @code{string};
-Remote IP address if @samp{$2} is @samp{FAMILY_INET} or full file name
+Remote @acronym{IP} address if @samp{$2} is @samp{FAMILY_INET} or full file name
of the socket if @samp{$2} is @samp{FAMILY_UNIX}. If @samp{$2} is
@samp{FAMILY_STDIO}, @samp{$4} is an empty string.
@end enumerate
@@ -4391,9 +4391,9 @@ command, excepting ones listed above, is answered with
2821 (section 3.9), which states:
@quotation
- An SMTP server MUST NOT intentionally close the connection except:
+ An @acronym{SMTP} server @emph{must not} intentionally close the connection except:
@dots{}
- - After detecting the need to shut down the SMTP service and
+ - After detecting the need to shut down the @acronym{SMTP} service and
returning a 421 response code. This response code can be issued
after the server receives any command or, if necessary,
asynchronously from command receipt (on the assumption that the
@@ -4416,8 +4416,8 @@ versions of Sendmail up to 8.14.
@deffn {Handler} helo (string $1)
@subsubheading Invocation
-This handler is called whenever the SMTP client sends @code{HELO} or
-@code{EHLO} command. Depending on the actual MTA configuration, it
+This handler is called whenever the @acronym{SMTP} client sends @code{HELO} or
+@code{EHLO} command. Depending on the actual @acronym{MTA} configuration, it
can be called several times or even not at all.
@subsubheading Arguments
@@ -4427,7 +4427,7 @@ can be called several times or even not at all.
@subsubheading Notes
According to @acronym{RFC} 28221, @code{$1} must be the domain name of the
-sending host, or, in case this is not available, its IP address
+sending host, or, in case this is not available, its @acronym{IP} address
enclosed in square brackets. Be careful when taking decisions based
on this value, because in practice many hosts send arbitrary strings.
We recommend to use @code{heloarg_test} function
@@ -4436,7 +4436,7 @@ We recommend to use @code{heloarg_test} function
@deffn {Handler} envfrom (string $1, string $2)
@subsubheading Invocation
-Called when the SMTP client sends @code{MAIL FROM} command, i.e. once
+Called when the @acronym{SMTP} client sends @code{MAIL FROM} command, i.e. once
at the beginning of each message.
@subsubheading Arguments
@@ -4476,7 +4476,7 @@ an array of arguments.
@deffn {Handler} header (string $1, string $2)
@subsubheading Invocation
-Called once for each header line received after SMTP @code{DATA} command.
+Called once for each header line received after @acronym{SMTP} @code{DATA} command.
@subsubheading Arguments
@enumerate 1
@item @code{string}; Header field name.
@@ -4596,7 +4596,7 @@ termination.
for writing modules (@pxref{Modules}), because each module can thus
have its own initialization and cleanup blocks. Notice, however, that
in this case the order in which subsequent @samp{begin} and @samp{end}
-blocks are executed is not defined. It is only warranted, that all
+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
@@ -4901,7 +4901,7 @@ strip_domain_part("puszcza.gnu.org.ua", 0) @result{} "gnu.org.ua"
@deftypefn {Library Function} boolean is_ip (string @var{str})
@flindex is_ip.mf
- Returns @samp{true} if @var{str} is a valid IPv4 address. This
+ Returns @samp{true} if @var{str} is a valid @acronym{IP}v4 address. This
function is defined in @file{is_ip.mf} module (@pxref{Modules}).
For example:
@@ -4922,7 +4922,7 @@ is_ip("0.0.0.0") @result{} 1
@deftypefn {Library Function} string revip (string @var{ip})
Reverses octets in @var{ip}, which must be a valid string
-representation of an IPv4 address.
+representation of an @acronym{IP}v4 address.
Example:
@@ -5082,7 +5082,7 @@ variables:
@multitable @columnfractions 0.30 0.70
@headitem Variable @tab Contains
@cindex last_poll_host, global variable, introduced
-@item last_poll_host @tab Host name or IP address of the last polled
+@item last_poll_host @tab Host name or @acronym{IP} address of the last polled
host.
@cindex last_poll_send, global variable, introduced
@item last_poll_send @tab Last @acronym{SMTP} command, sent to this
@@ -5102,7 +5102,7 @@ variables are modified. @xref{cache_used example}, for an example.
@node Internet address manipulation functions
@subsubsection Internet address manipulation functions
- Following functions operate on IPv4 addresses and CIDRs.
+ Following functions operate on @acronym{IP}v4 addresses and @acronym{CIDR}s.
@deftypefn {Built-in Function} number ntohl (number @var{n})
Converts the number @var{n}, from host to network byte order.
@@ -5141,7 +5141,7 @@ negative number:}
inet_aton("255.255.255.255") @result{} -1
@end smallexample
-However, this does not affect arithmetical operations on IP addresses.
+However, this does not affect arithmetical operations on @acronym{IP} addresses.
@end deftypefn
@@ -5155,7 +5155,7 @@ inet_ntoa(2130706433) @result{} "127.0.0.1"
@end deftypefn
@deftypefn {Built-in Function} number len_to_netmask (number @var{n})
-Convert number of masked bits @var{n} to the IPv4 netmask:
+Convert number of masked bits @var{n} to the @acronym{IP}v4 netmask:
@smallexample
inet_ntoa(len_to_netmask(24)) @result{} 255.255.255.0
@@ -5167,7 +5167,7 @@ exception.
@end deftypefn
@deftypefn {Built-in Function} number netmask_to_len (number @var{mask})
-Convert IPv4 netmask @var{mask} into netmask length (number of bits
+Convert @acronym{IP}v4 netmask @var{mask} into netmask length (number of bits
preserved by the mask):
@smallexample
@@ -5184,15 +5184,15 @@ netmask_to_len(inet_aton("254.0.0.0")) @result{} 7
This function is defined in @file{match_cidr.mf}
module (@pxref{Modules}).
- It returns @code{true} if the IP address @var{ip} pertains to the
-IP range @var{cidr}. The first argument, @var{ip}, is a string
-representation of an IP address. The second argument, @var{cidr}, is
-a string representation of a IP range in @acronym{CIDR} notation, i.e.
-@code{"@var{A.B.C.D}/@var{N}"}, where @var{A.B.C.D} is an IPv4
+ It returns @code{true} if the @acronym{IP} address @var{ip} pertains to the
+@acronym{IP} range @var{cidr}. The first argument, @var{ip}, is a string
+representation of an @acronym{IP} address. The second argument, @var{cidr}, is
+a string representation of a @acronym{IP} range in @acronym{CIDR} notation, i.e.
+@code{"@var{A.B.C.D}/@var{N}"}, where @var{A.B.C.D} is an @acronym{IP}v4
address and @var{N} specifies the @dfn{prefix length} -- the number of
shared initial bits, counting from the left side of the address.
- The following example will reject the mail if the IP address of
+ The following example will reject the mail if the @acronym{IP} address of
the sending machine does not belong to the block @code{10.10.1.0/19}:
@smallexample
@@ -5227,7 +5227,7 @@ available after requesting @file{dns.mf} module (@pxref{Modules}):
@end smallexample
@deftypefn {Built-in Function} string dns_getaddr (string @var{domain})
- Returns a whitespace-separated list of IP addresses (@code{A}
+ Returns a whitespace-separated list of @acronym{IP} addresses (@code{A}
records) for @var{domain}. At most 64 addresses are
returned. @FIXME{This limit should be configurable.}
@@ -5236,7 +5236,7 @@ returned. @FIXME{This limit should be configurable.}
@deftypefn {Built-in Function} string dns_getname (string @var{ipstr})
Returns a whitespace-separated list of domain names (@code{PTR}
-records) for the IPv4 address @var{ipstr}. At most 64 names are
+records) for the @acronym{IP}v4 address @var{ipstr}. At most 64 names are
returned. @FIXME{This limit should be configurable.}
This function does not use the @acronym{DNS} cache.
@@ -5245,7 +5245,7 @@ returned. @FIXME{This limit should be configurable.}
@deftypefn {Built-in Function} string getmx (string @var{domain} @
[, number @var{resolve}])
Returns a whitespace-separated list of MX names (if @var{resolve} is not
-given or if it is @code{0}) or MX IP addresses (if
+given or if it is @code{0}) or MX @acronym{IP} addresses (if
@code{@var{resolve}!=0})) for @var{domain}. Within the returned
strings, items are sorted lexicographically. If @var{domain} has no
MX records, empty string is returned. If the @acronym{DNS} query fails,
@@ -5262,7 +5262,7 @@ mxof("org.pl") @result{} ""
@emph{Notes}:
@enumerate 1
-@item The @code{getmx} function returns at most 32 MX names or IP addresses.
+@item The @code{getmx} function returns at most 32 MX names or @acronym{IP} addresses.
@FIXME{This limit should probably be configurable.}
@item The number of items returned by @code{getmx(@var{domain})} can
@@ -5307,9 +5307,9 @@ has any MX records.
@end deftypefn
@deftypefn {Built-in Function} string primitive_hostname (string @var{ip})
- The @var{ip} argument should be a string representing an IP address in
+ The @var{ip} argument should be a string representing an @acronym{IP} address in
@dfn{dotted-quad} notation. The function returns the canonical name of
-the host with this IP address obtained from @acronym{DNS} lookup. For example
+the host with this @acronym{IP} address obtained from @acronym{DNS} lookup. For example
@smallexample
primitive_hostname $@{client_addr@}
@@ -5327,15 +5327,15 @@ raises the exception @code{not_found}.
@end deftypefn
@deftypefn {Library Function} string hostname (string @var{ip})
- The @var{ip} argument should be a string representing an IP address in
+ The @var{ip} argument should be a string representing an @acronym{IP} address in
@dfn{dotted-quad} notation. The function returns the canonical name of
-the host with this IP address obtained from @acronym{DNS} lookup.
+the host with this @acronym{IP} address obtained from @acronym{DNS} lookup.
If there is no PTR record for @var{ip}, or if the lookup fails,
the function returns @var{ip} unchanged.
The previous @command{mailfromd} versions used the following
-paradigm to check if an IP address resolves:
+paradigm to check if an @acronym{IP} address resolves:
@smallexample
if hostname(%ip) != %ip
@@ -5348,7 +5348,7 @@ paradigm to check if an IP address resolves:
@deftypefn {Built-in Function} boolean primitive_ismx (string @var{domain}, @
string @var{host})
The @var{domain} argument is any valid domain name, the @var{host}
-is a host name or IP address.
+is a host name or @acronym{IP} address.
The function returns @code{true} if @var{host} is one of the MX
records for the @var{domain}.
@@ -5364,7 +5364,7 @@ exception @code{not_found}.
@deftypefn {Library Function} boolean ismx (string @var{domain}, @
string @var{host})
The @var{domain} argument is any valid domain name, the @var{host}
-is a host name or IP address.
+is a host name or @acronym{IP} address.
The function returns @code{true} if @var{host} is one of the MX
records for the @var{domain}. Otherwise it returns @code{false}.
@@ -5376,7 +5376,7 @@ function returns @code{false}.
@deftypefn {Built-in Function} string primitive_resolve (string @var{host}, @
[string @var{domain}])
Reverse of @code{primitive_hostname}. The @code{primitive_resolve} function
-returns the IP address for the host name specified by @var{host}
+returns the @acronym{IP} address for the host name specified by @var{host}
argument. If @var{host} has no A records, the function raises the
exception @code{not_found}.
@@ -5414,7 +5414,7 @@ another practical example of the use of the two-argument form.
@deftypefn {Library Function} string resolve (string @var{host}, @
[string @var{domain}])
Reverse of @code{hostname}. The @code{resolve} function
-returns the IP address for the host name specified by @var{host}
+returns the @acronym{IP} address for the host name specified by @var{host}
argument. If the host name cannot be resolved, or a @acronym{DNS} failure
occurs, the function returns @samp{"0"}.
@@ -5500,7 +5500,7 @@ A mx10.gnu.org: Sun Dec 3 10:56:12 2006 199.232.76.166
@end group
@end smallexample
- The above example shows that the IP address of @samp{mx10.gnu.org}
+ The above example shows that the @acronym{IP} address of @samp{mx10.gnu.org}
and that it expires on Sunday, December 3d, at 10:56:12.
Of course, the rest of database management options are also valid
@@ -5621,7 +5621,7 @@ relayed hostname $@{client_addr@}
@end smallexample
@noindent
-which yields @code{true} if the IP address from @command{Sendmail} variable
+which yields @code{true} if the @acronym{IP} address from @command{Sendmail} variable
@samp{client_addr} is relayed by the local machine.
@end deftypefn
@@ -5707,7 +5707,7 @@ exception if an I/O error occurs.
@end deftypefn
The following example shows how @command{mailfromd} I/O functions can
-be used to automatically add IP addresses to an @acronym{RBL} zone:
+be used to automatically add @acronym{IP} addresses to an @acronym{RBL} zone:
@smallexample
@group
@@ -5803,7 +5803,7 @@ The @var{proto} part specifies the @dfn{connection protocol}. It
should be @samp{tcp} for the @acronym{TCP} connection and @samp{file}
or @samp{socket} for the connection via UNIX socket. In the latter
case the @var{proto} part can be omitted. When using @acronym{TCP}
-connection, the @var{path} part gives the remote host name or IP
+connection, the @var{path} part gives the remote host name or @acronym{IP}
address and the optional @var{port} specifies the port number or
service name to use. For example:
@@ -5956,7 +5956,7 @@ of greylisting period. @xref{Greylisting}, for the detailed explanation.
@end deftypefn
@deftypefn {Built-in Function} boolean listens (string @var{host}, [number @var{port}])
- Returns @code{true} if the IP address or host name given by
+ Returns @code{true} if the @acronym{IP} address or host name given by
@var{host} argument listens on the port number @var{port} (default 25).
@end deftypefn
@@ -6009,11 +6009,11 @@ Arguments:
Sendmail macro;
@item remote_ip
-IP address of the remote client. Typically, the value of
+@acronym{IP} address of the remote client. Typically, the value of
@code{$client_addr} Sendmail macro;
@item local_ip
-IP address of this @acronym{SMTP} server;
+@acronym{IP} address of this @acronym{SMTP} server;
@end table
The function returns a number describing the result of the test, as
@@ -6022,17 +6022,17 @@ described in the following table.
@multitable @columnfractions 0.4 0.6
@headitem Code @tab Meaning
@item HELO_SUCCESS @tab @var{arg} successfully passes all tests.
-@item HELO_MYIP @tab @var{arg} is our IP address.
-@item HELO_IPNOMATCH @tab @var{arg} is an IP, but it does not match
-the remote party IP address.
-@item HELO_ARGNORESOLVE @tab @var{arg} is an IP, but it does not resolve.
-@item HELO_ARGNOIP @tab @var{arg} is in square brackets, but it is not an IP
+@item HELO_MYIP @tab @var{arg} is our @acronym{IP} address.
+@item HELO_IPNOMATCH @tab @var{arg} is an @acronym{IP}, but it does not match
+the remote party @acronym{IP} address.
+@item HELO_ARGNORESOLVE @tab @var{arg} is an @acronym{IP}, but it does not resolve.
+@item HELO_ARGNOIP @tab @var{arg} is in square brackets, but it is not an @acronym{IP}
address.
-@item HELO_ARGINVALID @tab @var{arg} is not an IP address and does not
+@item HELO_ARGINVALID @tab @var{arg} is not an @acronym{IP} address and does not
resolve to one.
-@item HELO_MYSERVERIP @tab @var{arg} resolves to our server IP.
+@item HELO_MYSERVERIP @tab @var{arg} resolves to our server @acronym{IP}.
@item HELO_IPMISMATCH @tab @var{arg} does not resolve to the remote
-client IP address.
+client @acronym{IP} address.
@end multitable
@end deftypefn
@@ -6090,7 +6090,7 @@ mailer.
The @samp{smtp} protocol means to use an @acronym{SMTP} server directly.
In this case the mailer location consists of two slashes,
-the IP address or host name of the @acronym{SMTP} server, and,
+the @acronym{IP} address or host name of the @acronym{SMTP} server, and,
optionally, the port number. For example:
@smallexample
@@ -6229,7 +6229,7 @@ Sender address.
@subsubsection Blacklisting Functions
The functions described in this subsection allow to check whether the
-given IP address is listed in certain @dfn{black list} @acronym{DNS}
+given @acronym{IP} address is listed in certain @dfn{black list} @acronym{DNS}
zone.
@anchor{match_dnsbl}
@@ -6238,7 +6238,7 @@ zone.
This function looks up the @var{address} in the @acronym{DNS}
blacklist zone @var{zone} and checks if the return matches
-given @var{range} of IP addresses.
+given @var{range} of @acronym{IP} addresses.
It is intended as a replacement for the Sendmail macros @samp{dnsbl} and
@samp{enhdnsbl}.
@@ -6251,18 +6251,18 @@ Arguments:
@table @var
@item address
-IP address of the @acronym{SMTP} server to be tested.
+@acronym{IP} address of the @acronym{SMTP} server to be tested.
@item zone
@acronym{FQDN} of the @acronym{DNS}bl zone to test against.
@item range
-The range of IP addresses in @acronym{CIDR} notation or
+The range of @acronym{IP} addresses in @acronym{CIDR} notation or
the word @samp{ANY}, which stands for @samp{127.0.0.0/8}.
@end table
The function returns @code{true} if dns lookup for @var{address} in
-the zone @var{dnsbl} yields an IP that falls within the range,
+the zone @var{dnsbl} yields an @acronym{IP} that falls within the range,
specified by @var{cidr}. Otherwise, it returns @code{false}. If
any of @var{address} or @var{cidr} is invalid, @code{match_dnsbl}
returns @code{false}.
@@ -6272,10 +6272,10 @@ returns @code{false}.
@deftypefn {Library Function} boolean match_rhsbl (string @var{email}, @
string @var{zone}, string @var{range})
-This function checks if the IP address, corresponding to the domain
+This function checks if the @acronym{IP} address, corresponding to the domain
part of @var{email} is listed in the @acronym{RHS DNS} blacklist zone
@var{zone}, and if so, whether its record matches the given range of
-IP addresses @var{range}.
+@acronym{IP} addresses @var{range}.
It is intended as a replacement for the Sendmail macro @samp{rhsbl}
by Derek J. Balling.
@@ -6294,7 +6294,7 @@ E-mail address, whose domain name should be tested (usually, it is
Domain name of the @acronym{RHS DNS} blacklist zone.
@item range
-The range of IP addresses in @acronym{CIDR} notation.
+The range of @acronym{IP} addresses in @acronym{CIDR} notation.
@end table
@end deftypefn
@@ -6333,7 +6333,7 @@ and analyzing its return code. The function can be called either in
@table @var
@item ip
- The IP address of the SMTP client that is emitting the mail.
+ The @acronym{IP} address of the @acronym{SMTP} client that is emitting the mail.
Usually it is @code{$client_addr}.
@item domain
@@ -6368,7 +6368,7 @@ further checks that will decide about its fate.
@cindex Neutral, SPF result code
@item Neutral
The domain owner has explicitly stated that he cannot or does not
-want to assert whether or not the IP address is authorized. This
+want to assert whether or not the @acronym{IP} address is authorized. This
result must be treated exactly like @code{None}; the distinction
between them exists only for informational purposes
@@ -6487,7 +6487,7 @@ result code}.
@table @var
@item ip
- The IP address of the SMTP client that is emitting the mail.
+ The @acronym{IP} address of the @acronym{SMTP} client that is emitting the mail.
Usually it is @code{$client_addr}.
@item domain
@@ -6575,7 +6575,7 @@ traffic.
@table @var
@item ip
- The IP address of the @acronym{SMTP} client that is emitting the mail.
+ The @acronym{IP} address of the @acronym{SMTP} client that is emitting the mail.
Usually it is @code{$client_addr}.
@item domain
@@ -7917,8 +7917,8 @@ argument @var{ipstr}, and checks its validity using the following algorithm:
Perform a @acronym{DNS} reverse-mapping for @var{ipstr}, looking up the
corresponding @code{PTR} record in @samp{in-addr.arpa}. For each record
-returned, look up its IP addresses (A records). If @var{ipstr} is
-among the returned IP addresses, return 1 (@code{true}), otherwise
+returned, look up its @acronym{IP} addresses (A records). If @var{ipstr} is
+among the returned @acronym{IP} addresses, return 1 (@code{true}), otherwise
return 0 (@code{false}).
The implementation of this function in @acronym{MFL} is:
@@ -7972,7 +7972,7 @@ System, it may fail to get a definite result. For example, the @acronym{DNS}
server can be down or temporary unavailable. In other words,
@code{hasmx} can be in a situation when, instead of returning
@samp{yes} or @samp{no}, it has to return @samp{don't know}. That is
-exactly when it will signal an @dfn{exception}.
+exactly then when it signals an @dfn{exception}.
@anchor{status.mfh}
@cindex exception types
@@ -8004,13 +8004,13 @@ This exception can be signaled by any @acronym{DNS}-related function
@cindex invcidr, exception type
@item invcidr
- Invalid CIDR notation. This is signaled by @code{match_cidr} function
-when its second argument is not a valid CIDR.
+ Invalid @acronym{CIDR} notation. This is signaled by @code{match_cidr} function
+when its second argument is not a valid @acronym{CIDR}.
@cindex invip, exception type
@item invip
- Invalid IP address. This is signaled by @code{match_cidr} function
-when its first argument is not a valid IP address.
+ Invalid @acronym{IP} address. This is signaled by @code{match_cidr} function
+when its first argument is not a valid @acronym{IP} address.
@cindex invtime, exception type
@item invtime
@@ -8031,7 +8031,7 @@ exception.
@cindex noresolve, exception type
@item noresolve
The argument of a @acronym{DNS}-related function cannot be resolved to host
-name or IP address. Currently only @code{ismx} (@pxref{ismx}) raises
+name or @acronym{IP} address. Currently only @code{ismx} (@pxref{ismx}) raises
this exception.
@cindex range, exception type
@@ -8603,7 +8603,7 @@ do
@end group
@end smallexample
- Next rule rejects all messages coming from hosts with dynamic IP
+ Next rule rejects all messages coming from hosts with dynamic @acronym{IP}
addresses. A regular expression used to catch such hosts is not 100%
fail-proof, but it tries to cover most existing host naming patterns:
@@ -8617,7 +8617,7 @@ ppp|dhcp|dynamic|[-.]cpe[-.]).*"
@end smallexample
Messages coming from the machines whose host name contains
-something similar to an IP are subject to strict checking:
+something similar to an @acronym{IP} are subject to strict checking:
@smallexample
@group
@@ -9123,7 +9123,7 @@ values}, for the detailed discussion of this option.
@table @option
@opsummary{milter-timeout}
@item --milter-timeout=@var{interval}
-Set MTA connection timeout. Overrides @samp{#pragma option
+Set @acronym{MTA} connection timeout. Overrides @samp{#pragma option
milter-timeout}, which you are advised to use instead (@pxref{pragma
milter-timeout}.
diff --git a/doc/mtasim.texi b/doc/mtasim.texi
index fb4155a0..f86a89d0 100644
--- a/doc/mtasim.texi
+++ b/doc/mtasim.texi
@@ -207,7 +207,7 @@ therefore it must appear @emph{before} @samp{--})
@end smallexample
@cindex @command{mtasim} administrative commands
- While the @acronym{SMTP} do not need any clarification, some words
+ While the @acronym{SMTP} commands do not need any clarification, some words
about the @dfn{administrative commands} are surely in place. These
commands allow to define, undefine and list arbitrary Sendmail macros.
Each administrative command consists of a backslash followed by a command
@@ -354,7 +354,7 @@ quit
@end smallexample
@cindex @command{mtasim}, using in shell scripts
- This sample illustrates also the fact that you can use
+ This example also illustrates the fact that you can use
@samp{#}-style comments in the @command{mtasim} input. Such a script
can be used in shell programs, for example:
@@ -371,7 +371,7 @@ fi
@section Trace Files
@cindex trace file, @command{mtasim}
- It is possible to log the entire @acronym{SMTP} session to a file.
+ It is possible to log an entire @acronym{SMTP} session to a file.
This is called @dfn{session tracing}. Two options are provided for
this purpose:
@@ -400,7 +400,7 @@ using the following option:
is not quite the same as Sendmail @option{-bd} mode. When started in
@dfn{daemon} mode, @command{mtasim} selects the first available
@acronym{TCP} port to use from the range @samp{1024 -- 65535}.
-It prints the port number it selected on standard output and
+It prints the selected port number on the standard output and
starts listening on it. When a connection comes, it serves a
@emph{single} @acronym{SMTP} session and exits immediately when it is
ended.

Return to:

Send suggestions and report system problems to the System administrator.