{man1,doc/web}: Added domaindelete --delete-directory's description. v0.7.x
authorPascal Volk <user@localhost.localdomain.org>
Mon, 09 Jun 2014 18:12:03 +0000
branchv0.7.x
changeset 755 e99e4fc62a5f
parent 754 8363ea6240a5
child 756 139ced0fea1e
{man1,doc/web}: Added domaindelete --delete-directory's description.
doc/web/source/howto/manage_domains.rst
man/man1/vmm.1
--- a/doc/web/source/howto/manage_domains.rst	Mon Jun 09 17:37:36 2014 +0000
+++ b/doc/web/source/howto/manage_domains.rst	Mon Jun 09 18:12:03 2014 +0000
@@ -53,9 +53,22 @@
 
 domaindelete
 ------------
+.. program:: vmm domaindelete
+
 Syntax:
- | **vmm domaindelete** *fqdn* [**‒‒force**]
- | **vmm dd** *fqdn* [**‒‒force**]
+ | **vmm domaindelete** *fqdn* [**‒‒delete‒directory**] [**‒‒force**]
+ | **vmm dd** *fqdn* [**‒‒delete‒directory**] [**‒‒force**]
+
+.. option:: --delete-directory
+
+ When this option is given, :command:`vmm` will delete the directory of
+ the given domain.
+ This overrides the *domain.delete_directory* setting of :file:`vmm.cfg`.
+
+.. option:: --force
+
+ Use this option in oder to force the deletion of the domain, even if
+ there are accounts, aliases, catch-all accounts and/or relocated users.
 
 This subcommand deletes the domain specified by *fqdn*.
 
@@ -63,7 +76,7 @@
 domain, :command:`vmm` will abort the requested operation and show an error
 message.
 If you know, what you are doing, you can specify the optional argument
-**‒‒force**.
+:option:`--force`.
 
 If you really always know what you are doing, edit your :file:`vmm.cfg` and
 set the option *domain.force_deletion* to **true**.
--- a/man/man1/vmm.1	Mon Jun 09 17:37:36 2014 +0000
+++ b/man/man1/vmm.1	Mon Jun 09 18:12:03 2014 +0000
@@ -1,4 +1,4 @@
-.TH "VMM" "1" "2014-06-08" "vmm 0.7" "vmm"
+.TH "VMM" "1" "2014-06-09" "vmm 0.7" "vmm"
 .SH NAME
 vmm \- command line tool to manage email domains/accounts/aliases
 .\" -----------------------------------------------------------------------
@@ -442,8 +442,26 @@
 .\" ------------------------------------
 .SS domaindelete (dd)
 .BI "vmm domaindelete " fqdn
+.RB [ \-\-delete\-directory ]
 .RB [ \-\-force ]
 .PP
+.\" ------------------------------------
+.TP
+.B \-\-delete\-directory
+When this option is given,
+.B vmm
+will delete the directory of the given domain.
+This overrides the
+.I domain.delete_directory
+setting of
+.IR vmm.cfg .
+.\" ------------------------------------
+.TP
+.B \-\-force
+Use this option in oder to force the deletion of the domain, even if there
+are accounts, aliases, catch-all accounts and/or relocated users.
+.\" ------------------------------------
+.PP
 This subcommand deletes the domain specified by
 .IR fqdn .
 .PP