From 164a431f0e1a667372c037d6e8f6e7807e3e7880 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Tue, 24 Feb 2026 14:43:23 -0500 Subject: [PATCH] doc/README.rst: provide some usage examples --- doc/README.rst | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/doc/README.rst b/doc/README.rst index b7d39c5..4a119b7 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -49,6 +49,60 @@ By default, mailshears won't actually do anything. There's a variable ``true`` before mailshears will modify the system. +Examples +======== + +**See the man page for detailed usage and configuration information.** + +Prune left-over users and domains: + +.. code-block:: console + + $ mailshears + mailshears, 2015-11-08 17:01:47 -0500 (Plugin: PrunePlugin) + ----------------------------------------------------------- + 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). + RoundcubePrune - Removed user booger@example.com (User ID: 2). + +Remove a single user: + +.. code-block:: console + + $ mailshears rm adam@example.net + mailshears, 2015-11-08 17:04:42 -0500 (Plugin: RmPlugin) + -------------------------------------------------------- + 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. + RoundcubeRm - Removed user adam@example.net (User ID: 3). + +Remove an entire domain: + +.. code-block:: console + + $ mailshears rm example.net + mailshears, 2015-11-08 17:05:42 -0500 (Plugin: RmPlugin) + -------------------------------------------------------- + DavicalRm - Domain example.net not found. + DovecotRm - Removed domain example.net (/tmp/mailshears-test/example.net). + PostfixadminRm - Removed domain example.net. + RoundcubeRm - Removed domain example.net. + +Rename an existing user: + +.. code-block:: console + + $ mailshears mv alice@example.com alice@example.net + mailshears, 2015-11-08 17:06:29 -0500 (Plugin: MvPlugin) + -------------------------------------------------------- + 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. + RoundcubeMv - Moved user alice@example.com (User ID: 1) to alice@example.net (User ID: 1). + + Installation ============ -- 2.51.0