vmm: {man1,doc/web}: Added userdelete --delete-home's description.

[<nev...@us...>]

details:     http://hg.localdomain.org/vmm/rev/271bd82c05c0
changeset:   752:271bd82c05c0
user:        Pascal Volk
date:        Sun Jun 08 17:15:55 2014 +0000
description: {man1,doc/web}: Added userdelete --delete-home's description.

diffstat:

 doc/web/source/howto/manage_accounts.rst |  21 ++++++++++++++++++---
 man/man1/vmm.1                           |  23 ++++++++++++++++++++++-
 2 files changed, 40 insertions(+), 4 deletions(-)

diffs (76 lines):

diff -r 9d739cd2f527 -r 271bd82c05c0 doc/web/source/howto/manage_accounts.rst
--- a/doc/web/source/howto/manage_accounts.rst	Sun Jun 08 17:11:55 2014 +0000
+++ b/doc/web/source/howto/manage_accounts.rst	Sun Jun 08 17:15:55 2014 +0000
@@ -36,15 +36,30 @@
 
 userdelete
 ----------
+
+.. program:: vmm userdelete
+
 Syntax:
- | **vmm userdelete** *address* [**‒‒force**]
- | **vmm ud** *address* [**‒‒force**]
+ | **vmm userdelete** *address* [**‒‒delete-home**] [**‒‒force**]
+ | **vmm ud** *address* [**‒‒delete-home**] [**‒‒force**]
+
+.. option:: --delete-home
+
+ When this option is present, :command:`vmm` will also delete the account's
+ home directory.
+ This overrides the *account.delete_directory* setting of :file:`vmm.cfg`.
+
+.. option:: --force
+
+ When this option is given, :command:`vmm` will delete the account, even if
+ there are aliases with the account's address as their destination.
+ Those aliases will be deleted too.
 
 Use this subcommand to delete the account with the given *address*.
 
 If there are one or more aliases with an identical destination address,
 :command:`vmm` will abort the requested operation and show an error message.
-To prevent this, give the optional argument **‒‒force**.
+To prevent this, give the optional argument :option:`--force`.
 
 userinfo
 --------
diff -r 9d739cd2f527 -r 271bd82c05c0 man/man1/vmm.1
--- a/man/man1/vmm.1	Sun Jun 08 17:11:55 2014 +0000
+++ b/man/man1/vmm.1	Sun Jun 08 17:15:55 2014 +0000
@@ -1,4 +1,4 @@
-.TH "VMM" "1" "2014-02-23" "vmm 0.7" "vmm"
+.TH "VMM" "1" "2014-06-08" "vmm 0.7" "vmm"
 .SH NAME
 vmm \- command line tool to manage email domains/accounts/aliases
 .\" -----------------------------------------------------------------------
@@ -739,8 +739,29 @@
 .\" ------------------------------------
 .SS userdelete (ud)
 .BI "vmm userdelete" " address"
+.RB [ \-\-delete\-home ]
 .RB [ \-\-force ]
 .PP
+.\" ------------------------------------
+.TP
+.B \-\-delete\-home
+When this option is present,
+.B vmm
+will also delete the account\(aqs home directory.
+This overrides the
+.I account.delete_directory
+setting of
+.IR vmm.cfg .
+.\" ------------------------------------
+.TP
+.B \-\-force
+When this option is given,
+.B vmm
+will delete the account, even if there are aliases with the account\(aqs
+address as their destination.
+Those aliases will be deleted too.
+.\" ------------------------------------
+.PP
 Use this subcommand to delete the account with the given
 .IR address .
 .PP