/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/: