doc/web/source/howto/manage_accounts.rst
branchv0.7.x
changeset 682 697350dd9369
parent 626 f151defe7078
child 687 5eb033796444
--- a/doc/web/source/howto/manage_accounts.rst	Wed Jan 09 20:55:27 2013 +0000
+++ b/doc/web/source/howto/manage_accounts.rst	Sun Jan 13 15:26:37 2013 +0000
@@ -4,8 +4,8 @@
 useradd
 -------
 Syntax:
- | **vmm useradd** *address* [*password*]
- | **vmm ua** *address* [*password*]
+ | **vmm useradd** *address* [**-p** *password*]
+ | **vmm ua** *address* [**-p** *password*]
 
 Use this subcommand to create a new e-mail account for the given *address*.
 
@@ -19,7 +19,7 @@
 
 .. code-block:: console
 
- root@host:~# vmm ua d.user@example.com "A 5ecR3t P4s5\/\/0rd"
+ root@host:~# vmm ua d.user@example.com -p "A 5ecR3t P4s5\/\/0rd"
  root@host:~# vmm useradd e.user@example.com
  Enter new password:
  Retype new password:
@@ -27,20 +27,20 @@
 userdelete
 ----------
 Syntax:
- | **vmm userdelete** *address* [*force*]
- | **vmm ud** *address* [*force*]
+ | **vmm userdelete** *address* [**‒‒force**]
+ | **vmm ud** *address* [**‒‒force**]
 
 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, specify the optional keyword **force**.
+To prevent this, give the optional argument **‒‒force**.
 
 userinfo
 --------
 Syntax:
- | **vmm userinfo** *address* [*details*]
- | **vmm ui** *address* [*details*]
+ | **vmm userinfo** *address* [**-d** *details*]
+ | **vmm ui** *address* [**-d** *details*]
 
 This subcommand displays some information about the account specified by
 *address*.
@@ -84,8 +84,8 @@
 username
 --------
 Syntax:
- | **vmm username** *address* [*name*]
- | **vmm un** *address* [*name*]
+ | **vmm username** *address* [**-n** *name*]
+ | **vmm un** *address* [**-n** *name*]
 
 The user's real *name* can be set/updated with this subcommand.
 
@@ -95,13 +95,13 @@
 
 .. code-block:: console
 
- root@host:~# vmm un d.user@example.com "John Doe"
+ root@host:~# vmm un d.user@example.com -n "John Doe"
 
 usernote
 --------
 Syntax:
- | **vmm usernote** *address* [*note*]
- | **vmm uo** *address* [*note*]
+ | **vmm usernote** *address* [**-n** *note*]
+ | **vmm uo** *address* [**-n** *note*]
 
 With this subcommand, it is possible to attach a note to the specified
 account.
@@ -111,15 +111,15 @@
 
 .. code-block:: console
 
- root@host:~# vmm uo d.user@example.com Only needed until end of May 2012
+ root@host:~# vmm uo d.user@example.com -n 'Only needed until end of May 2013'
 
 .. versionadded:: 0.6.0
 
 userpassword
 ------------
 Syntax:
- | **vmm userpassword** *address* [*password*]
- | **vmm up** *address* [*password*]
+ | **vmm userpassword** *address* [**-p** *password*]
+ | **vmm up** *address* [**-p** *password*]
 
 The password of an account can be updated with this subcommand.
 
@@ -129,21 +129,21 @@
 
 .. code-block:: console
 
- root@host:~# vmm up d.user@example.com "A |\/|0r3 5ecur3 P4s5\/\/0rd?"
+ root@host:~# vmm up d.user@example.com -p "A |\/|0r3 5ecur3 P4s5\/\/0rd?"
 
 userquota
 ---------
 Syntax:
- | **vmm userquota** *address storage* [*messages*]
- | **vmm uq** *address storage* [*messages*]
+ | **vmm userquota** *address storage* [**-m** *messages*]
+ | **vmm uq** *address storage* [**-m** *messages*]
 
 This subcommand is used to set a new quota limit for the given account.
 
 When the argument *messages* was omitted the default number of messages
 **0** (zero) will be applied.
 
-Instead of *storage* pass **domain** to remove the account-specific
-override, causing the domain's value to be in effect.
+Instead of a *storage* limit pass the keyword **domain** to remove the
+account-specific override, causing the domain's value to be in effect.
 
 Example:
 
@@ -156,22 +156,22 @@
 userservices
 ------------
 Syntax:
- | **vmm userservices** *address* [*service ...*]
- | **vmm us** *address* [*service ...*]
+ | **vmm userservices** *address* [**-s** *service ...*]
+ | **vmm us** *address* [**-s** *service ...*]
 
 To grant a user access to the specified services, use this command.
 
 All omitted services will be deactivated/unusable for the user with the
 given *address*.
 
-Instead of *service* pass **domain** to remove the account-specific override,
-causing the domain's value to be in effect.
+Instead of any *service* pass the keyword **domain** to remove the
+account-specific override, causing the domain's value to be in effect.
 
 Example:
 
 .. code-block:: console
 
- root@host:~# userservices d.user@example.com SMTP IMAP
+ root@host:~# userservices d.user@example.com -s smtp imap
 
 .. _usertransport: