list-remote-forwards.cabal: delete the redundant description

[list-remote-forwards.git] / doc / man1 / list-remote-forwards.1

diff --git a/doc/man1/list-remote-forwards.1 b/doc/man1/list-remote-forwards.1
index 13ebb4a1028f5471cff70719f06a0115beeb429b..851cd60f8f0affdde92edb7e44640b4b5a1b6e34 100644 (file)
--- a/doc/man1/list-remote-forwards.1
+++ b/doc/man1/list-remote-forwards.1
@@ -15,10 +15,10 @@ A list of addresses that are forwarded to remote domains.
 .SH DESCRIPTION
 .P
 A list of local domains is supplied to the program (more or less)
-through the \fI\-\-domain\-query\fR option. Any addresses which
-forward to another address not contained in this list of local domains
-is considered a remote forward. Remote forwards can cause problems for
-a number of reasons, the most common of which are,
+through the \fI\-\-domain\-query\fR option. Any addresses in the list
+that forward to an address \fBnot\fR in the list are considered remote
+forwards. Remote forwards can cause problems for a number of reasons,
+the most common of which are,
 .IP \(bu 2
 If the sender has an SPF record authorizing his mail server to send
 mail on his behalf, then when his message is forwarded by the
@@ -47,17 +47,21 @@ SQL query used to produce a list of local domains. This should return
 the set of all domains (i.e one column) that are local to the
 server. See the default value for an example.
 
-Default: \(dqSELECT domain FROM domain WHERE domain <> 'ALL' ORDER BY domain;\(dq
+Default: \(dqSELECT domain FROM domain WHERE domain <> 'ALL' ORDER BY
+domain;\(dq
 
 .IP \fB\-\-exclude-mx\fR,\ \fB-e\fR
 The name of a mail exchanger, the forwards of whose domains we should
 ignore. For example, if one mail exchanger, mx1.example.com, has
 strict spam filtering, it may be acceptable to have remote forwarding
-for domains that have mx1.example.com as their mail exchanger (MX
+for domains that have mx1.example.com as their sole mail exchanger (MX
 record). In that case, you might want to exclude those domains from
 the report by naming mx1.example.com here.
 
-Can be repeated to exclude more than one mail exchanger.
+A forward will be excluded from the report only if \fIall\fR of its MX
+records are contained in the given exclude list.
+
+This option can be repeated to add mail exchangers to the exclude list.
 
 Default: [] (empty)
 
@@ -90,14 +94,25 @@ Username used to connect to the database (Postgres-only).
 
 Default: The current user
 
+.SH CONFIGURATION FILE
+
+Any of the options above can be placed in a configuration file rather
+than passed on the command line. An example config file
+\fIdoc/list-remote-forwardsrc.example\fR is included with the
+source. You can edit it and rename it to either
+\fI$sysconfdir/list-remote-forwardsrc\fR or
+\fI~/.list-remote-forwardsrc\fR. The variable \fI$sysconfdir\fR is
+determined at build time and is typically \fI/etc\fR on UNIX systems.
+
 .SH EXAMPLES
 
 .nf
-.I $ list-remote-forwards --database=postfixadmin.sqlite3
+.I $ list-remote-forwards --database=test/fixtures/postfixadmin.sqlite3
 user1@example.com -> user1@example.net
 user2@example.com -> user1@example.org
 user2@example.com -> user2@example.org
 user2@example.com -> user3@example.org
+user7@example.com -> user8@example.net
 .fi
 .SH BUGS
 .P