net-mail/mailbox-count/metadata.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
   3 <pkgmetadata>
   4         <maintainer type="person">
   5                 <email>mjo@gentoo.org</email>
   6                 <name>Michael Orlitzky</name>
   7         </maintainer>
   8         <maintainer type="project">
   9                 <email>haskell@gentoo.org</email>
  10                 <name>Gentoo Haskell</name>
  11         </maintainer>
  12         <longdescription>
  13                 /Usage/:
  14
  15                 @
  16                 mailbox-count [OPTIONS]
  17                 @
  18
  19                 Mailbox-count produces a simple count of mailboxes that exist
  20                 per-domain in some SQL database. The default queries are compatible
  21                 with the schema used by PostfixAdmin &lt;http://postfixadmin.sourceforge.net/&gt;,
  22                 but it is possible to supply your own queries via the @--summary-query@
  23                 and @--detail-query@ options.
  24
  25                 The summary report lists each domain, along with the number of
  26                 mailboxes owned by that domain. The order is determined by the summary
  27                 query, which lists the domains alphabetically by default.
  28
  29                 The default detail report shows the same, but also contains a list of
  30                 each individual mailbox (again in alphabetical order) belonging to the
  31                 domains.
  32
  33                 /Input/:
  34
  35                 None.
  36
  37                 /Output/:
  38
  39                 Either a summary, or detailed report (with @--detail@) of the
  40                 number of mailboxes per-domain contained in the database.
  41
  42                 /Options/:
  43
  44                 @
  45                 \--database
  46                 @
  47
  48                 The name of the database (or file, if SQLite) to which we should
  49                 connect.
  50
  51                 Default: The name of the current user (Postgres only).
  52
  53                 @
  54                 \--detail
  55                 @
  56
  57                 Produce a detailed report listing all mailboxes by domain.
  58
  59                 @
  60                 \--detail-query
  61                 @
  62
  63                 SQL query used to produce the detail report. This should return the
  64                 set of all (domain, username) pairs. See the default value for an
  65                 example.
  66
  67                 Default: \"SELECT domain,username FROM mailbox ORDER BY domain;\"
  68
  69                 @
  70                 \--host
  71                 @
  72
  73                 Hostname where the database is located (Postgres-only).
  74
  75                 Default: None, a UNIX domain socket connection is attempted (Postgres only)
  76
  77                 @
  78                 \--password
  79                 @
  80
  81                 Password used to connect to the database (Postgres-only).
  82
  83                 Default: None (assumes passwordless authentication)
  84
  85                 @
  86                 \--port
  87                 @
  88                 Port number used to connect to the database (Postgres-only).
  89
  90                 Default: None, a UNIX domain socket connection is attempted (Postgres only)
  91
  92                 @
  93                 \--summary-query
  94                 @
  95
  96                 SQL query used to produce the summary report. This should return
  97                 (domain, user count) pairs. See the default value for an
  98                 example.
  99
 100                 Default: \"SELECT domain,COUNT(username) FROM mailbox GROUP BY domain
 101                 ORDER BY domain;\"
 102
 103                 @
 104                 \--username
 105                 @
 106
 107                 Username used to connect to the database (Postgres-only).
 108
 109                 Default: The current user
 110
 111                 /Examples/:
 112
 113                 The default summary report:
 114
 115                 @
 116                 $ mailbox-count --database=postfixadmin.sqlite3
 117                 Summary (number of mailboxes per domain)
 118                 \----------------------------------------
 119                 example.com:     3
 120                 example.invalid: 1
 121                 example.net:     2
 122                 example.org:     1
 123                 @
 124
 125                 The more detailed report:
 126
 127                 @
 128                 $ mailbox-count --detail --database=postfixadmin.sqlite3
 129                 Detail (list of all mailboxes by domain)
 130                 \----------------------------------------
 131                 example.com (3):
 132                 &amp;#x20; user1
 133                 &amp;#x20; user3
 134                 &amp;#x20; user5
 135                 example.invalid (1):
 136                 &amp;#x20; user7
 137                 example.net (2):
 138                 &amp;#x20; user2
 139                 &amp;#x20; user4
 140                 example.org (1):
 141                 &amp;#x20; user6
 142                 @
 143         </longdescription>
 144 </pkgmetadata>