mailshears.gemspec: bump version to 0.1.0

[mailshears.git] / doc / man1 / mailshears.1

diff --git a/doc/man1/mailshears.1 b/doc/man1/mailshears.1
index 286e5e0e3cb3fbb854037ac9f9cae4e4f43b5dba..ee9bbd5dcc5931f12959b7d6cc1d2e9fadd92f07 100644 (file)
--- a/doc/man1/mailshears.1
+++ b/doc/man1/mailshears.1
@@ -4,7 +4,7 @@
 mailshears \- mangle your mail garden
 .SH SYNOPSIS
 
-\fBmailshears\fR [ [\fBprune\fR] | [\fBrm\fR <\fItargets\fR>] | [\fBmv\fR <\fIsrc\fR> <\fIdst\fR>] ]
+\fBmailshears\fR [--help] [ [\fBprune\fR] | [\fBrm\fR <\fItargets\fR>] | [\fBmv\fR <\fIsrc\fR> <\fIdst\fR>] ]
 
 .SH DESCRIPTION
 
@@ -28,8 +28,6 @@ It is assumed that you use the \fBPostfixAdmin schema\fI with
 functionality is provided by plugins. The following are supported at
 the moment:
 \#
-.IP \(bu 2
-Agendav (database, v2.1.x)
 .IP \(bu
 DAViCal (database, v1.1.x)
 .IP \(bu
@@ -77,7 +75,6 @@ Pruning leftover users and domains:
 .I $ mailshears
 mailshears, 2015-11-08 17:01:47 -0500 (Plugin: PrunePlugin)
 -----------------------------------------------------------
-AgendavPrune - Removed user booger@example.com.
 DavicalPrune - Removed user booger@example.com (Principal ID: 2).
 DovecotPrune - Removed user booger@example.com (/tmp/mailshears-test/example.com/booger).
 DovecotPrune - Removed user jeremy@example.com (/tmp/mailshears-test/example.com/jeremy).
@@ -90,7 +87,6 @@ Removing a specific user:
 .I $ mailshears rm adam@example.net
 mailshears, 2015-11-08 17:04:42 -0500 (Plugin: RmPlugin)
 --------------------------------------------------------
-AgendavRm - Removed user adam@example.net.
 DavicalRm - User adam@example.net not found.
 DovecotRm - Removed user adam@example.net (/tmp/mailshears-test/example.net/adam).
 PostfixadminRm - Removed user adam@example.net.
@@ -103,7 +99,6 @@ Removing a domain:
 .I $ mailshears rm example.net
 mailshears, 2015-11-08 17:05:42 -0500 (Plugin: RmPlugin)
 --------------------------------------------------------
-AgendavRm - Removed domain example.net.
 DavicalRm - Domain example.net not found.
 DovecotRm - Removed domain example.net (/tmp/mailshears-test/example.net).
 PostfixadminRm - Removed domain example.net.
@@ -116,7 +111,6 @@ Renaming an existing user:
 .I $ mailshears mv alice@example.com alice@example.net
 mailshears, 2015-11-08 17:06:29 -0500 (Plugin: MvPlugin)
 --------------------------------------------------------
-AgendavMv - Source user alice@example.com not found.
 DavicalMv - Moved user alice@example.com (Principal ID: 1) to alice@example.net (Principal ID: 1).
 DovecotMv - Moved user alice@example.com (/tmp/mailshears-test/example.com/alice) to alice@example.net (/tmp/mailshears-test/example.net/alice).
 PostfixadminMv - Moved user alice@example.com to alice@example.net.
@@ -127,7 +121,8 @@ RoundcubeMv - Moved user alice@example.com (User ID: 1) to alice@example.net (Us
 
 Mailshears is configured with a YAML file containing all of the
 database settings and plugin information. This file should be located
-at ~/.mailshears.conf.yml, in your home directory.
+at \fI$XDG_CONFIG_HOME\fR/mailshears/mailshears.conf.yml, where
+\fI$XDG_CONFIG_HOME\fR defaults to \fI$HOME\fR/.config.
 
 The following two settings are global:
 \#
@@ -138,9 +133,8 @@ will output some \(dqwhat if\(dq information but won't actually
 \#
 .IP \(bu
 \fIplugins\fR (default: ['postfixadmin'])
-A list of enabled plugins. Valid values are \(dqagendav\(dq,
-\(dqdavical\(dq, \(dqdovecot\(dq, \(dqpostfixadmin\(dq, and
-\(dqroundcube\(dq.
+A list of enabled plugins. Valid values are \(dqdavical\(dq,
+\(dqdovecot\(dq, \(dqpostfixadmin\(dq, and \(dqroundcube\(dq.
 .P
 The \(dqdovecot\(dq plugin supports the following:
 \#
@@ -152,8 +146,8 @@ located one level beneath dovecot_mail_root.
 .P
 The database plugins all have the same configutation options:
 connections settings preceded by the plugin name. So in what follows,
-<plugin> would be replaced by \(dqagendav\(dq, \(dqdavical\(dq, or so
-on. Their meanings should be self-explanatory.
+<plugin> would be replaced by \(dqdavical\(dq, for example. Their
+meanings should be self-explanatory.
 \#
 .IP \(bu 2
 \fI<plugin>_dbhost\fR (default: localhost)
@@ -165,9 +159,6 @@ on. Their meanings should be self-explanatory.
 \fI<plugin>_dbopts\fR (default: empty)
 \#
 .IP \(bu
-\fI<plugin>_dbtty\fR (default: empty)
-\#
-.IP \(bu
 \fI<plugin>_dbuser\fR (default: 'postgres')
 \#
 .IP \(bu