From 5a89b4b3bfe057e3bf7fd3b7aee5424b02513090 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Thu, 25 Apr 2024 17:56:12 -0400 Subject: [PATCH] mailbox-count.cabal: trim the description I don't want to maintain two copies any more. --- mailbox-count.cabal | 126 ++++---------------------------------------- 1 file changed, 9 insertions(+), 117 deletions(-) diff --git a/mailbox-count.cabal b/mailbox-count.cabal index c495ca2..756ed41 100644 --- a/mailbox-count.cabal +++ b/mailbox-count.cabal @@ -17,127 +17,19 @@ extra-source-files: synopsis: Count mailboxes in a SQL database description: - /Usage/: - - @ - mailbox-count [OPTIONS] - @ - - Mailbox-count produces a simple count of mailboxes that exist + mailbox-count produces a simple count of mailboxes that exist per-domain in some SQL database. The default queries are compatible - with the schema used by PostfixAdmin , - but it is possible to supply your own queries via the @--summary-query@ - and @--detail-query@ options. + with the [PostfixAdmin](https://postfixadmin.sourceforge.net/) + schema, but it is possible to supply your own queries. The summary report lists each domain, along with the number of - mailboxes owned by that domain. The order is determined by the summary - query, which lists the domains alphabetically by default. - - The default detail report shows the same, but also contains a list of - each individual mailbox (again in alphabetical order) belonging to the - domains. - - /Input/: - - None. - - /Output/: - - Either a summary, or detailed report (with @--detail@) of the - number of mailboxes per-domain contained in the database. - - /Options/: - - * \--database - - The name of the database (or file, if SQLite) to which we should - connect. - - Default: The name of the current user (Postgres only). - - * \--detail - - Produce a detailed report listing all mailboxes by domain. - - * \--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. - - Default: \"SELECT domain,username FROM mailbox ORDER BY domain;\" - - * \--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) - - * \--summary-query - - SQL query used to produce the summary report. This should return - (domain, user count) pairs. See the default value for an - example. - - Default: \"SELECT domain,COUNT(username) FROM mailbox GROUP BY domain - ORDER BY domain;\" - - * \--username - - Username used to connect to the database (Postgres-only). - - Default: The current user - - /Examples/: - - The default summary report: - - @ - $ mailbox-count --database=postfixadmin.sqlite3 - Summary (number of mailboxes per domain) - \---------------------------------------- - example.com: 3 - example.invalid: 1 - example.net: 2 - example.org: 1 - @ - - The more detailed report: - - @ - $ mailbox-count --detail --database=postfixadmin.sqlite3 - Detail (list of all mailboxes by domain) - \---------------------------------------- - example.com (3): - user1 - user3 - user5 - - example.invalid (1): - user7 - - example.net (2): - user2 - user4 - - example.org (1): - user6 - @ + mailboxes owned by that domain. The order is determined by the + summary query, which lists the domains alphabetically by + default. The default detail report shows the same, but also contains + a list of each individual mailbox (again in alphabetical order) + belonging to the domains. + A full set of options and examples can be found in the man page. executable mailbox-count -- 2.44.2