Switch from GPL-3 to AGPL-3 and update project URLs.

[list-remote-forwards.git] / list-remote-forwards.cabal

diff --git a/list-remote-forwards.cabal b/list-remote-forwards.cabal
index 6b85533a6b7c197a20ff3db30f299586a15d7573..fe8761e8e9561013c7e12ee8e0b8623ca9c89809 100644 (file)
--- a/list-remote-forwards.cabal
+++ b/list-remote-forwards.cabal
@@ -3,13 +3,13 @@ version:        0.0.1
 cabal-version:  >= 1.8
 author:         Michael Orlitzky
 maintainer:    Michael Orlitzky <michael@orlitzky.com>
-license:        GPL-3
+license:        AGPL-3
 license-file:   doc/LICENSE
 bug-reports:    mailto:michael@orlitzky.com
 category:       Mail, Utils
 build-type:     Simple
 extra-source-files:
-  doc/list-remote-forwards.example
+  doc/list-remote-forwardsrc.example
   doc/man1/list-remote-forwards.1
   test/fixtures/postfixadmin.sqlite3
 synopsis:
@@ -73,7 +73,25 @@ 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 sole mail exchanger (MX
+  record). In that case, you might want to exclude those domains from
+  the report by naming mx1.example.com here.
+  .
+  A forward will be excluded from the report only if /all/ 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)
+  .
+  @
+  \--forward-query, -f
   @
   .
   SQL query used to produce a list of all forwards on the mail
@@ -85,7 +103,7 @@ description:
   Default: \"SELECT address,goto FROM alias ORDER BY address;\"
   .
   @
-  \--host
+  \--host, -h
   @
   .
   Hostname where the database is located (Postgres-only).
@@ -108,7 +126,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).
@@ -118,11 +136,12 @@ description:
   /Examples/:
   .
   @
-  $ list-remote-forwards --database=postfixadmin.sqlite3
+  $ 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
   @
 
 executable list-remote-forwards
@@ -152,9 +171,11 @@ executable list-remote-forwards
     Configuration
     CommandLine
     DNS
+    Forward
     OptionalConfiguration
     MxList
     Report
+    String
 
   ghc-options:
     -Wall
@@ -239,5 +260,5 @@ test-suite doctests
 
 source-repository head
   type: git
-  location: http://michael.orlitzky.com/git/list-remote-forwards.git
+  location: http://gitweb.michael.orlitzky.com/list-remote-forwards.git
   branch: master