From: Michael Orlitzky <michael@orlitzky.com>
Date: Wed, 23 Apr 2014 00:52:40 +0000 (-0400)
Subject: Add an example config file.
X-Git-Tag: 0.0.3~19
X-Git-Url: https://gitweb.michael.orlitzky.com/?p=mailbox-count.git;a=commitdiff_plain;h=7a19ab91c57bfe9c3fb8a6e4105f300c7f638e2d

Add an example config file.
---

diff --git a/doc/mailbox-countrc.example b/doc/mailbox-countrc.example
new file mode 100644
index 0000000..8a3529d
--- /dev/null
+++ b/doc/mailbox-countrc.example
@@ -0,0 +1,44 @@
+#
+# Sample configuration file for mailbox-count.
+#
+
+# The name of the database to which we should connect.
+#
+# Default: The name of the current user (Postgres only)
+#
+# database = "postfixadmin"
+
+
+# Produce a detailed report listing all mailboxes by domain.
+#
+# Default: false
+#
+# detail = true
+
+
+# Hostname where the database is located.
+#
+# Default: None, a UNIX domain socket connection is attempted (Postgres only)
+#
+# host = "localhost"
+
+
+# Password used to connect to the database.
+#
+# Default: None (assumes passwordless authentication)
+#
+# password = "hunter2"
+
+
+# Port number used to connect to the database.
+#
+# Default: None, a UNIX domain socket connection is attempted (Postgres only)
+#
+# port = 5432
+
+
+# Username used to connect to the database.
+#
+# Default: The current user
+#
+# username = "postgres"
diff --git a/mailbox-count.cabal b/mailbox-count.cabal
index f80f2b7..752fe24 100644
--- a/mailbox-count.cabal
+++ b/mailbox-count.cabal
@@ -10,6 +10,7 @@ bug-reports:    mailto:michael@orlitzky.com
 category:       Mail, Utils
 build-type:     Simple
 extra-source-files:
+  doc/mailbox-countrc.example
   doc/man1/mailbox-count.1
   test/fixtures/postfixadmin.sqlite3
 synopsis: