Add a doctest test suite.

[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 fb9fb5cfbdff05f206ab8b6cc7038ebb1f33482b..bcc7b9c04e754d945f434f49f705a399a2bc1458 100644 (file)
--- a/doc/man1/list-remote-forwards.1
+++ b/doc/man1/list-remote-forwards.1
@@ -49,7 +49,17 @@ server. See the default value for an example.
 
 Default: \(dqSELECT domain FROM domain WHERE domain <> 'ALL' ORDER BY domain;\(dq
 
-.IP \fB\-\-forward-query\fR
+.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
+record). In that case, you might want to exclude those domains from
+the report by naming mx1.example.com here.
+
+Default: [] (empty)
+
+.IP \fB\-\-forward-query\fR,\ \fB-f\fR
 SQL query used to produce a list of all forwards on the mail
 system. This query should return the set of all (address, goto)
 triples, where \(dqgoto\(dq is the destination address; i.e. to where
@@ -58,7 +68,7 @@ than one email address, separated by commas.
 
 Default: \(dqSELECT address,goto FROM alias ORDER BY address;\(dq
 
-.IP \fB\-\-host\fR
+.IP \fB\-\-host\fR,\ \fB-h\fR
 Hostname where the database is located (Postgres-only).
 
 Default: None, a UNIX domain socket connection is attempted (Postgres only)
@@ -73,7 +83,7 @@ Port number used to connect to the database (Postgres-only).
 
 Default: None, a UNIX domain socket connection is attempted (Postgres only)
 
-.IP \fB\-\-username\fR
+.IP \fB\-\-username\fR,\ \fB-u\fR
 Username used to connect to the database (Postgres-only).
 
 Default: The current user