- .
- @
- \--database
- @
- .
- The name of the database (or file, if SQLite) to which we should
- connect.
- .
- Default: The name of the current user (Postgres only).
- .
- @
- \--domain-query
- @
- 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: \"SELECT domain FROM domain WHERE domain <> 'ALL' ORDER BY domain;\"
- .
- @
- \--forward-query
- @
- .
- 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 \"goto\" is the destination address; i.e. to where
- the \"address\" forwards. The \"goto\" field may contain more
- than one email address, separated by commas.
- .
- Default: \"SELECT address,goto FROM alias ORDER BY address;\"
- .
- @
- \--host
- @
- .
- Hostname where the database is located (Postgres-only).
- .
- Default: None, a UNIX domain socket connection is attempted (Postgres only)
- .
- @
- \--password
- @
- .
- Password used to connect to the database (Postgres-only).
- .
- Default: None (assumes passwordless authentication)
- .
- @
- \--port
- @
- Port number used to connect to the database (Postgres-only).
- .
- Default: None, a UNIX domain socket connection is attempted (Postgres only)
- .
- @
- \--username
- @
- .
- Username used to connect to the database (Postgres-only).
- .
- Default: The current user
- .
+
+ * \--database
+
+ The name of the database (or file, if SQLite) to which we should
+ connect.
+
+ Default: The name of the current user (Postgres only).
+
+ * \--domain-query
+
+ 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: \"SELECT domain FROM domain WHERE domain <> 'ALL' ORDER BY
+ domain;\"
+
+ * \--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
+ system. This query should return the set of all (address, goto)
+ triples, where \"goto\" is the destination address; i.e. to
+ where the \"address\" forwards. The \"goto\" field may contain
+ more than one email address, separated by commas.
+
+ Default: \"SELECT address,goto FROM alias ORDER BY address;\"
+
+ * \--host, -h
+
+ Hostname where the database is located (Postgres-only).
+
+ Default: None, a UNIX domain socket connection is attempted
+ (Postgres only)
+
+ * \--password
+
+ Password used to connect to the database (Postgres-only).
+
+ Default: None (assumes passwordless authentication)
+
+ * \--port
+
+ Port number used to connect to the database (Postgres-only).
+
+ Default: None, a UNIX domain socket connection is attempted
+ (Postgres only)
+
+ * \--username, -u
+
+ Username used to connect to the database (Postgres-only).
+
+ Default: The current user
+