From: Michael Orlitzky Date: Sun, 28 Aug 2022 15:52:15 +0000 (-0400) Subject: mailbox-count.cabal: improve haddock doc layout. X-Git-Tag: 0.0.6~2 X-Git-Url: https://gitweb.michael.orlitzky.com/?p=mailbox-count.git;a=commitdiff_plain;h=20cf8f29f0a109c7354c486676471abe2ee3e5bb mailbox-count.cabal: improve haddock doc layout. --- diff --git a/mailbox-count.cabal b/mailbox-count.cabal index fb2e6b2..d4997aa 100644 --- a/mailbox-count.cabal +++ b/mailbox-count.cabal @@ -46,72 +46,59 @@ 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). - @ - \--detail - @ + * \--detail - Produce a detailed report listing all mailboxes by domain. + Produce a detailed report listing all mailboxes by domain. - @ - \--detail-query - @ + * \--detail-query - SQL query used to produce the detail report. This should return the - set of all (domain, username) pairs. See the default value for an - example. + SQL query used to produce the detail report. This should return the + set of all (domain, username) pairs. See the default value for an + example. - Default: \"SELECT domain,username FROM mailbox ORDER BY domain;\" + Default: \"SELECT domain,username FROM mailbox ORDER BY domain;\" - @ - \--host - @ + * \--host - Hostname where the database is located (Postgres-only). + Hostname where the database is located (Postgres-only). - Default: None, a UNIX domain socket connection is attempted (Postgres only) + Default: None, a UNIX domain socket connection is attempted + (Postgres only) - @ - \--password - @ + * \--password - Password used to connect to the database (Postgres-only). + Password used to connect to the database (Postgres-only). - Default: None (assumes passwordless authentication) + Default: None (assumes passwordless authentication) - @ - \--port - @ - Port number used to connect to the database (Postgres-only). + * \--port - Default: None, a UNIX domain socket connection is attempted (Postgres only) + Port number used to connect to the database (Postgres-only). - @ - \--summary-query - @ + Default: None, a UNIX domain socket connection is attempted + (Postgres only) - SQL query used to produce the summary report. This should return - (domain, user count) pairs. See the default value for an - example. + * \--summary-query - Default: \"SELECT domain,COUNT(username) FROM mailbox GROUP BY domain - ORDER BY domain;\" + SQL query used to produce the summary report. This should return + (domain, user count) pairs. See the default value for an + example. - @ - \--username - @ + Default: \"SELECT domain,COUNT(username) FROM mailbox GROUP BY domain + ORDER BY domain;\" + + * \--username - 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/: