Update cabal description, and make minor documentation fixes.
authorMichael Orlitzky <michael@orlitzky.com>
Thu, 27 Nov 2014 15:40:33 +0000 (10:40 -0500)
committerMichael Orlitzky <michael@orlitzky.com>
Thu, 27 Nov 2014 15:40:33 +0000 (10:40 -0500)
doc/list-remote-forwardsrc.example
doc/man1/list-remote-forwards.1
list-remote-forwards.cabal

index 6f118698db1ca1514cbcca58f477ed73c4f24c69..3e435603ba0d4cb9d1a07a5a5d1ec3fc22b6de96 100644 (file)
 # domain_query = "SELECT DISTINCT domain FROM alias;"
 
 
-# The name of a mail exchange, the forwards of whose domains we should
+# 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.
 #
+# Given as a list, it can be used to exclude more than one mail
+# exchanger.
+#
 # Default: [] (empty)
 #
 # exclude_mx = ["mx1.example.com"]
index bcc7b9c04e754d945f434f49f705a399a2bc1458..13ebb4a1028f5471cff70719f06a0115beeb429b 100644 (file)
@@ -57,6 +57,8 @@ 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.
 
+Can be repeated to exclude more than one mail exchanger.
+
 Default: [] (empty)
 
 .IP \fB\-\-forward-query\fR,\ \fB-f\fR
index 6b85533a6b7c197a20ff3db30f299586a15d7573..4718b35534331b0a5bd58ca1f9d54a44a1126cc7 100644 (file)
@@ -73,7 +73,22 @@ description:
   Default: \"SELECT domain FROM domain WHERE domain <> 'ALL' ORDER BY domain;\"
   .
   @
-  \--forward-query
+  \--exclude-mx, -e
+  @
+  .
+  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.
+  .
+  Can be repeated to exclude more than one mail exchanger.
+  .
+  Default: [] (empty)
+  .
+  @
+  \--forward-query, -f
   @
   .
   SQL query used to produce a list of all forwards on the mail
@@ -85,7 +100,7 @@ description:
   Default: \"SELECT address,goto FROM alias ORDER BY address;\"
   .
   @
-  \--host
+  \--host, -h
   @
   .
   Hostname where the database is located (Postgres-only).
@@ -108,7 +123,7 @@ description:
   Default: None, a UNIX domain socket connection is attempted (Postgres only)
   .
   @
-  \--username
+  \--username, -u
   @
   .
   Username used to connect to the database (Postgres-only).
@@ -123,6 +138,7 @@ description:
   user2@example.com -> user1@example.org
   user2@example.com -> user2@example.org
   user2@example.com -> user3@example.org
+  user7@example.com -> user8@example.net
   @
 
 executable list-remote-forwards