doc/man1/list-remote-forwards.1: mention the configuration file

[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..39042e3f0baf019198683171101bbc485615207d 100644 (file)
--- a/doc/man1/list-remote-forwards.1
+++ b/doc/man1/list-remote-forwards.1
@@ -53,11 +53,14 @@ Default: \(dqSELECT domain FROM domain WHERE domain <> 'ALL' ORDER BY domain;\(d
 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
 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.
 
 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)
 
 
 Default: [] (empty)
 


@@ -90,14 +93,25 @@ Username used to connect to the database (Postgres-only).
 
 Default: The current user
 
 
 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
 .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
 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
 .fi
 .SH BUGS
 .P