list-remote-forwards.cabal: improve haddock docs layout.

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

diff --git a/list-remote-forwards.cabal b/list-remote-forwards.cabal
index f78f6b20008c565a4e79ddde0fa87e0a2e18b61b..bbf73d2a9edf1887b8003a771965b470bc5c7434 100644 (file)
--- a/list-remote-forwards.cabal
+++ b/list-remote-forwards.cabal
@@ -54,84 +54,74 @@ description:
 
   /Options/:
 
-  @
-  \--database
-  @
+  * \--database
 
-  The name of the database (or file, if SQLite) to which we should
-  connect.
+      The name of the database (or file, if SQLite) to which we should
+      connect.
 
-  Default: The name of the current user (Postgres only).
+      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.
+  * \--domain-query
 
-  Default: \"SELECT domain FROM domain WHERE domain <> 'ALL' ORDER BY domain;\"
+      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.
 
-  @
-  \--exclude-mx, -e
-  @
+      Default: \"SELECT domain FROM domain WHERE domain <> 'ALL' ORDER BY
+      domain;\"
 
-  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.
+  * \--exclude-mx, -e
 
-  A forward will be excluded from the report only if /all/ of its MX
-  records are contained in the given exclude list.
+      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.
 
-  This option can be repeated to add mail exchangers to the exclude list.
+      A forward will be excluded from the report only if /all/ of its MX
+      records are contained in the given exclude list.
 
-  Default: [] (empty)
+      This option can be repeated to add mail exchangers to the exclude list.
 
-  @
-  \--forward-query, -f
-  @
+      Default: [] (empty)
 
-  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.
+  * \--forward-query, -f
 
-  Default: \"SELECT address,goto FROM alias ORDER BY address;\"
+      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.
 
-  @
-  \--host, -h
-  @
+      Default: \"SELECT address,goto FROM alias ORDER BY address;\"
 
-  Hostname where the database is located (Postgres-only).
+  * \--host, -h
 
-  Default: None, a UNIX domain socket connection is attempted (Postgres only)
+      Hostname where the database is located (Postgres-only).
 
-  @
-  \--password
-  @
+      Default: None, a UNIX domain socket connection is attempted
+      (Postgres only)
 
-  Password used to connect to the database (Postgres-only).
+  * \--password
 
-  Default: None (assumes passwordless authentication)
+      Password used to connect to the database (Postgres-only).
 
-  @
-  \--port
-  @
-  Port number used to connect to the database (Postgres-only).
+      Default: None (assumes passwordless authentication)
 
-  Default: None, a UNIX domain socket connection is attempted (Postgres only)
+  * \--port
 
-  @
-  \--username, -u
-  @
+      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).
+      Username used to connect to the database (Postgres-only).
 
-  Default: The current user
+      Default: The current user
 
   /Examples/: