doc: Updated doc/web and man1. v0.7.x
authorPascal Volk <user@localhost.localdomain.org>
Sun, 20 Jan 2013 15:50:36 +0000
branchv0.7.x
changeset 690 06c0acf6c45d
parent 689 dab0630947a2
child 691 932cd76bf879
doc: Updated doc/web and man1. Added description of the -d option for subcommands domainnote, username and usernote.
doc/web/source/howto/manage_accounts.rst
doc/web/source/howto/manage_domains.rst
man/man1/vmm.1
--- a/doc/web/source/howto/manage_accounts.rst	Sun Jan 20 14:42:52 2013 +0000
+++ b/doc/web/source/howto/manage_accounts.rst	Sun Jan 20 15:50:36 2013 +0000
@@ -93,13 +93,24 @@
 
 username
 --------
+.. program:: vmm username
+
 Syntax:
- | **vmm username** *address* [**-n** *name*]
- | **vmm un** *address* [**-n** *name*]
+ | **vmm username** *address* **-d** | **-n** *name*
+ | **vmm un** *address* **-d** | **-n** *name*
+
+.. option:: -d
+
+ delete the user's name
+
+.. option:: -n name
+
+ a user's real name
 
 The user's real *name* can be set/updated with this subcommand.
 
-If no *name* is given, the value stored for the account is erased.
+In order to delete the value stored for the account, pass the :option:`-d`
+option.
 
 Example:
 
@@ -109,13 +120,23 @@
 
 usernote
 --------
+.. program:: vmm usernote
+
 Syntax:
- | **vmm usernote** *address* [**-n** *note*]
- | **vmm uo** *address* [**-n** *note*]
+ | **vmm usernote** *address* **-d** | **-n** *note*
+ | **vmm uo** *address* **-d** | **-n** *note*
+
+.. option:: -d
+
+ delete the user's note
+
+.. option:: -n note
+
+ the note that should be set
 
 With this subcommand, it is possible to attach a note to the specified
 account.
-Without an argument, an existing note is removed.
+In order to delete an existing note, pass the :option:`-d` option.
 
 Example:
 
--- a/doc/web/source/howto/manage_domains.rst	Sun Jan 20 14:42:52 2013 +0000
+++ b/doc/web/source/howto/manage_domains.rst	Sun Jan 20 15:50:36 2013 +0000
@@ -112,13 +112,23 @@
 
 domainnote
 ----------
+.. program:: vmm domainnote
+
 Syntax:
- | **vmm domainnote** *fqdn* [**-n** *note*]
- | **vmm do** *fqdn* [**-n** *note*]
+ | **vmm domainnote** *fqdn* **-d** | **-n** *note*
+ | **vmm do** *fqdn* **-d** | **-n** *note*
+
+.. option:: -d
+
+ delete the domain's note
+
+.. option:: -n note
+
+ the note that should be set
 
 With this subcommand, it is possible to attach a note to the specified
 domain.
-Without an argument, an existing note is removed.
+In order to delete an existing note, pass the :option:`-d` option.
 
 Example:
 
--- a/man/man1/vmm.1	Sun Jan 20 14:42:52 2013 +0000
+++ b/man/man1/vmm.1	Sun Jan 20 15:50:36 2013 +0000
@@ -1,4 +1,4 @@
-.TH "VMM" "1" "2013-01-19" "vmm 0.7" "vmm"
+.TH "VMM" "1" "2013-01-20" "vmm 0.7" "vmm"
 .SH NAME
 vmm \- command line tool to manage email domains/accounts/aliases
 .\" -----------------------------------------------------------------------
@@ -589,11 +589,23 @@
 .\" ------------------------------------
 .SS domainnote (do)
 .BI "vmm domainnote" " fqdn"
-.RB [ \-n
-.IR note ]
+.BR \-d | \-n
+.I note
+.PP
+.\" ------------------------------------
+.TP
+.B \-d
+delete the domain\(aqs note.
+.\" ------------------------------------
+.TP
+.BI "\-n " note
+the note that should be set.
+.\" ------------------------------------
 .PP
 With this subcommand, it is possible to attach a note to the specified
-domain. Without an argument, an existing note is removed.
+domain.
+In order to delete an existing note, pass the
+.BR \-d " option."
 .PP
 Example:
 .PP
@@ -797,16 +809,25 @@
 .\" ------------------------------------
 .SS username (un)
 .BI "vmm username" " address"
-.RB [ \-n
-.IR name ]
+.BR \-d | \-n
+.IR name
+.PP
+.\" ------------------------------------
+.TP
+.B \-d
+delete the user\(aqs name.
+.\" ------------------------------------
+.TP
+.BI "\-n " name
+a user\(aqs real name.
+.\" ------------------------------------
 .PP
 The user's real
 .I name
 can be set/updated with this subcommand.
 .PP
-If no
-.I name
-is given, the value stored for the account is erased.
+In order to delete the value stored for the account, pass the
+.BR \-d " option."
 .PP
 Example:
 .PP
@@ -835,11 +856,23 @@
 .\" ------------------------------------
 .SS usernote (uo)
 .BI "vmm usernote" " address"
-.RB [ \-n
-.IR note ]
+.BR \-d | \-n
+.IR note
+.PP
+.\" ------------------------------------
+.TP
+.B \-d
+delete the user\(aqs note.
+.\" ------------------------------------
+.TP
+.BI "\-n " note
+the note that should be set.
+.\" ------------------------------------
 .PP
 With this subcommand, it is possible to attach a note to the specified
-account. Without an argument, an existing note is removed.
+account.
+In order to delete an existing note, pass the
+.BR \-d " option."
 .PP
 Example:
 .PP