X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=mailbox-count.cabal;h=4852d92fa590e9e234b63faa98e6852604e8ca6b;hb=57ae0c295cb129e699a9d8bcb668ae3dd7033808;hp=982cbb9c5388ed3f03c07d03e116582c835d1ea7;hpb=4283c125388433a4e17416e62f4e8af3608eabdc;p=mailbox-count.git diff --git a/mailbox-count.cabal b/mailbox-count.cabal index 982cbb9..4852d92 100644 --- a/mailbox-count.cabal +++ b/mailbox-count.cabal @@ -1,11 +1,10 @@ name: mailbox-count -version: 0.0.1 +version: 0.0.4 cabal-version: >= 1.8 author: Michael Orlitzky maintainer: Michael Orlitzky -license: GPL-3 +license: AGPL-3 license-file: doc/LICENSE -homepage: http://michael.orlitzky.com/code/mailbox-count.php bug-reports: mailto:michael@orlitzky.com category: Mail, Utils build-type: Simple @@ -16,11 +15,145 @@ extra-source-files: synopsis: Count mailboxes in a SQL database. description: - Count mailboxes in a SQL database. + /Usage/: + . + @ + mailbox-count [OPTIONS] + @ + . + 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. + . + 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 + @ + + executable mailbox-count build-depends: - base >= 4.6 && < 5, + base >= 4.8 && < 5, cmdargs >= 0.10, configurator >= 0.2, containers >= 0.5, @@ -32,6 +165,11 @@ executable mailbox-count MissingH >= 1.2, tasty >= 0.8, tasty-hunit >= 0.8 + -- Data.Semigroup was added to GHC.Base in ghc-8.0 + if impl(ghc < 8.0) + -- The minor version 0.18.2 deleted the entire API? + build-depends: semigroups < 0.18.2 + main-is: Main.hs @@ -42,31 +180,31 @@ executable mailbox-count Configuration CommandLine OptionalConfiguration + -- WARNING: the Paths_mailbox_count module is automatically generated by + -- Cabal itself. We don't want it included in the release tarballs, + -- since we typically want the paths that the user has configured. + -- Nevertheless, Cabal will complain if we don't include it here. + Paths_mailbox_count Report - ghc-options: - -Wall - -fwarn-hi-shadowing - -fwarn-missing-signatures - -fwarn-name-shadowing - -fwarn-orphans - -fwarn-type-defaults - -fwarn-tabs - -fwarn-incomplete-record-updates - -fwarn-monomorphism-restriction - -fwarn-unused-do-bind - -rtsopts - -threaded - -optc-O3 - -optc-march=native - test-suite testsuite type: exitcode-stdio-1.0 hs-source-dirs: src test main-is: TestSuite.hs + + other-modules: + Configuration + OptionalConfiguration + -- WARNING: the Paths_mailbox_count module is automatically generated by + -- Cabal itself. We don't want it included in the release tarballs, + -- since we typically want the paths that the user has configured. + -- Nevertheless, Cabal will complain if we don't include it here. + Paths_mailbox_count + Report + build-depends: - base >= 4.6 && < 5, + base >= 4.8 && < 5, cmdargs >= 0.10, configurator >= 0.2, containers >= 0.5, @@ -78,20 +216,10 @@ test-suite testsuite MissingH >= 1.2, tasty >= 0.8, tasty-hunit >= 0.8 - - -- It's not entirely clear to me why I have to reproduce all of this. - ghc-options: - -Wall - -fwarn-hi-shadowing - -fwarn-missing-signatures - -fwarn-name-shadowing - -fwarn-orphans - -fwarn-type-defaults - -fwarn-tabs - -fwarn-incomplete-record-updates - -fwarn-monomorphism-restriction - -fwarn-unused-do-bind - -O2 + -- Data.Semigroup was added to GHC.Base in ghc-8.0 + if impl(ghc < 8.0) + -- The minor version 0.18.2 deleted the entire API? + build-depends: semigroups < 0.18.2 test-suite doctests @@ -99,30 +227,14 @@ test-suite doctests hs-source-dirs: test main-is: Doctests.hs build-depends: - base >= 4.6 && < 5, + base >= 4.8 && < 5, -- Additional test dependencies. doctest >= 0.9, filemanip >= 0.3.6 - -- It's not entirely clear to me why I have to reproduce all of this. - ghc-options: - -Wall - -fwarn-hi-shadowing - -fwarn-missing-signatures - -fwarn-name-shadowing - -fwarn-orphans - -fwarn-type-defaults - -fwarn-tabs - -fwarn-incomplete-record-updates - -fwarn-monomorphism-restriction - -fwarn-unused-do-bind - -rtsopts - -threaded - -optc-O3 - -optc-march=native source-repository head type: git - location: http://michael.orlitzky.com/git/mailbox-count.git + location: http://gitweb.michael.orlitzky.com/mailbox-count.git branch: master