From: Michael Orlitzky <michael@orlitzky.com>
Date: Fri, 30 May 2014 18:46:28 +0000 (-0400)
Subject: Add man page description and fix some options/examples.
X-Git-Tag: 0.0.3~12
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=9aeae00c4b7072e802190c6f0818df366372acde;p=mailbox-count.git

Add man page description and fix some options/examples.
---

diff --git a/doc/man1/mailbox-count.1 b/doc/man1/mailbox-count.1
index 9cd9246..0c59240 100644
--- a/doc/man1/mailbox-count.1
+++ b/doc/man1/mailbox-count.1
@@ -17,7 +17,20 @@ The summary shows only the per-domain mailbox count, while the
 detailed report shows both the count and a list of mailboxes.
 .SH DESCRIPTION
 .P
-Mailbox-count produces a simple count of mailboxes that exist per-domain in some SQL database. The user supplies the...
+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
+<http://postfixadmin.sourceforge.net/>, but it is possible to supply
+your own queries via the \fI\-\-summary-query\fR and
+\fI\-\-detail-query\fR options.
+.P
+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.
+.P
+The default detail report shows the same, but also contains a list of
+each individual mailbox (again in alphabetical order) belonging to the
+domains.
 .SH OPTIONS
 
 .IP \fB\-\-database\fR
@@ -26,7 +39,7 @@ connect.
 
 Default: The name of the current user (Postgres only).
 
-.IP \fB\-\-detail\fR,\ \fB-d\fR
+.IP \fB\-\-detail\fR
 Produce a detailed report listing all mailboxes by domain.
 
 .IP \fB\-\-detail-query\fR
@@ -36,7 +49,7 @@ example.
 
 Default: \(dqSELECT domain,username FROM mailbox ORDER BY domain;\(dq
 
-.IP \fB\-\-hostname\fR
+.IP \fB\-\-host\fR
 Hostname where the database is located (Postgres-only).
 
 Default: None, a UNIX domain socket connection is attempted (Postgres only)
@@ -69,7 +82,7 @@ Default: The current user
 The default summary report:
 
 .nf
-.I $ mailbox-count postfixadmin.sqlite3
+.I $ mailbox-count --database=postfixadmin.sqlite3
 Summary (number of mailboxes per domain)
 ----------------------------------------
 example.com:     3
@@ -81,7 +94,7 @@ example.org:     1
 The more detailed report:
 
 .nf
-.I $ mailbox-count --detail postfixadmin.sqlite3
+.I $ mailbox-count --detail --database=postfixadmin.sqlite3
 Detail (list of all mailboxes by domain)
 ----------------------------------------
 example.com (3):