doc: Added description of {domain,user}add's -n option. v0.7.x
authorPascal Volk <user@localhost.localdomain.org>
Sat, 19 Jan 2013 16:55:18 +0000
branchv0.7.x
changeset 687 5eb033796444
parent 686 5f4abdab738e
child 688 c14299bc1b99
doc: Added description of {domain,user}add's -n option.
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 13 18:12:51 2013 +0000
+++ b/doc/web/source/howto/manage_accounts.rst	Sat Jan 19 16:55:18 2013 +0000
@@ -3,9 +3,19 @@
 =================
 useradd
 -------
+.. program:: vmm useradd
+
 Syntax:
- | **vmm useradd** *address* [**-p** *password*]
- | **vmm ua** *address* [**-p** *password*]
+ | **vmm useradd** *address* [**-n** *note*] [**-p** *password*]
+ | **vmm ua** *address* [**-n** *note*] [**-p** *password*]
+
+.. option:: -n note
+
+ the note that should be set
+
+.. option:: -p password
+
+ the new user's password
 
 Use this subcommand to create a new e-mail account for the given *address*.
 
--- a/doc/web/source/howto/manage_domains.rst	Sun Jan 13 18:12:51 2013 +0000
+++ b/doc/web/source/howto/manage_domains.rst	Sat Jan 19 16:55:18 2013 +0000
@@ -5,9 +5,19 @@
 
 domainadd
 ---------
+.. program:: vmm domainadd
+
 Syntax:
- | **vmm domainadd** *fqdn* [**-t** *transport*]
- | **vmm da** *fqdn* [**-t** *transport*]
+ | **vmm domainadd** *fqdn* [**-n** *note*] [**-t** *transport*]
+ | **vmm da** *fqdn* [**-n** *note*] [**-t** *transport*]
+
+.. option:: -n note
+
+ the note that should be set
+
+.. option:: -t transport
+
+ a Postfix transport (transport: or transport:nexthop)
  
 Adds the new domain into the database and creates the domain directory.
 
--- a/man/man1/vmm.1	Sun Jan 13 18:12:51 2013 +0000
+++ b/man/man1/vmm.1	Sat Jan 19 16:55:18 2013 +0000
@@ -1,4 +1,4 @@
-.TH "VMM" "1" "2013-01-13" "vmm 0.7" "vmm"
+.TH "VMM" "1" "2013-01-19" "vmm 0.7" "vmm"
 .SH NAME
 vmm \- command line tool to manage email domains/accounts/aliases
 .\" -----------------------------------------------------------------------
@@ -385,9 +385,21 @@
 .SS domainadd (da)
 .B vmm domainadd
 .I fqdn
+.RB [ \-n
+.IR note ]
 .RB [ \-t
 .IR transport ]
 .PP
+.\" ------------------------------------
+.TP
+.BI "\-n " note
+the note that should be set.
+.\" ------------------------------------
+.TP
+.BI "\-t " transport
+a Postfix transport (transport: or transport:nexthop).
+.\" ------------------------------------
+.PP
 Adds the new domain into the database and creates the domain directory.
 .PP
 If the optional argument
@@ -672,10 +684,22 @@
 .SH ACCOUNT SUBCOMMANDS
 .SS useradd (ua)
 .B vmm useradd
-.I address 
-.RB [ \-p 
+.I address
+.RB [ \-n
+.IR note ]
+.RB [ \-p
 .IR password ]
 .PP
+.\" ------------------------------------
+.TP
+.BI "\-n " note
+the note that should be set.
+.\" ------------------------------------
+.TP
+.BI "\-p " password
+the new user\(aqs password.
+.\" ------------------------------------
+.PP
 Use this subcommand to create a new e\-mail account for the given
 .IR address .
 .PP