doc/web/source/howto/manage_accounts.rst
author Pascal Volk <user@localhost.localdomain.org>
Sat, 19 Jan 2013 16:59:39 +0000
branchv0.7.x
changeset 688 c14299bc1b99
parent 687 5eb033796444
child 690 06c0acf6c45d
permissions -rw-r--r--
man1: Deleted trailing whitespaces.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     1
=================
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     2
Managing accounts
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     3
=================
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     4
useradd
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     5
-------
687
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 682
diff changeset
     6
.. program:: vmm useradd
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 682
diff changeset
     7
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     8
Syntax:
687
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 682
diff changeset
     9
 | **vmm useradd** *address* [**-n** *note*] [**-p** *password*]
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 682
diff changeset
    10
 | **vmm ua** *address* [**-n** *note*] [**-p** *password*]
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 682
diff changeset
    11
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 682
diff changeset
    12
.. option:: -n note
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 682
diff changeset
    13
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 682
diff changeset
    14
 the note that should be set
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 682
diff changeset
    15
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 682
diff changeset
    16
.. option:: -p password
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 682
diff changeset
    17
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 682
diff changeset
    18
 the new user's password
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    19
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    20
Use this subcommand to create a new e-mail account for the given *address*.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    21
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    22
If the password is not provided, :command:`vmm` will prompt for it
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    23
interactively.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    24
When no *password* is provided and *account.random_password* is set to
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    25
**true**, :command:`vmm` will generate a random password and print it to
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    26
stdout after the account has been created.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    27
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    28
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    29
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    30
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    31
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
    32
 root@host:~# vmm ua d.user@example.com -p "A 5ecR3t P4s5\/\/0rd"
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    33
 root@host:~# vmm useradd e.user@example.com
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    34
 Enter new password:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    35
 Retype new password:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    36
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    37
userdelete
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    38
----------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    39
Syntax:
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
    40
 | **vmm userdelete** *address* [**‒‒force**]
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
    41
 | **vmm ud** *address* [**‒‒force**]
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    42
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    43
Use this subcommand to delete the account with the given *address*.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    44
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    45
If there are one or more aliases with an identical destination address,
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    46
:command:`vmm` will abort the requested operation and show an error message.
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
    47
To prevent this, give the optional argument **‒‒force**.
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    48
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    49
userinfo
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    50
--------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    51
Syntax:
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
    52
 | **vmm userinfo** *address* [**-d** *details*]
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
    53
 | **vmm ui** *address* [**-d** *details*]
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    54
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    55
This subcommand displays some information about the account specified by
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    56
*address*.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    57
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    58
If the optional argument *details* is given some more information will be
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    59
displayed.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    60
Possible values for *details* are:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    61
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    62
======= ==============================================================
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    63
value   description
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    64
======= ==============================================================
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    65
aliases to list all alias addresses with the destination *address*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    66
du      to display the disk usage of the user's mail directory.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    67
        In order to summarize the disk usage each time this subcommand
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    68
        is executed automatically, set *account.disk_usage* in your
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    69
        :file:`vmm.cfg` to **true**.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    70
full    to list all information mentioned above
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    71
======= ==============================================================
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    72
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    73
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    74
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    75
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    76
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    77
 root@host:~# vmm ui d.user@example.com
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    78
 Account information
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    79
 -------------------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    80
         Address..........: d.user@example.com
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    81
         Name.............: None
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    82
         UID..............: 79881
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    83
         GID..............: 70704
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    84
         Home.............: /srv/mail/2/70704/79881
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    85
         Mail_Location....: mdbox:~/mdbox
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    86
         Quota Storage....: [  0.00%] 0/500.00 MiB [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    87
         Quota Messages...: [  0.00%] 0/10,000 [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    88
         Transport........: lmtp:unix:private/dovecot-lmtp [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    89
         SMTP.............: disabled [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    90
         POP3.............: disabled [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    91
         IMAP.............: enabled [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    92
         SIEVE............: enabled [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    93
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    94
username
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    95
--------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    96
Syntax:
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
    97
 | **vmm username** *address* [**-n** *name*]
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
    98
 | **vmm un** *address* [**-n** *name*]
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    99
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   100
The user's real *name* can be set/updated with this subcommand.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   101
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   102
If no *name* is given, the value stored for the account is erased.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   103
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   104
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   105
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   106
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   107
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   108
 root@host:~# vmm un d.user@example.com -n "John Doe"
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   109
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   110
usernote
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   111
--------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   112
Syntax:
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   113
 | **vmm usernote** *address* [**-n** *note*]
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   114
 | **vmm uo** *address* [**-n** *note*]
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   115
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   116
With this subcommand, it is possible to attach a note to the specified
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   117
account.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   118
Without an argument, an existing note is removed.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   119
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   120
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   121
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   122
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   123
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   124
 root@host:~# vmm uo d.user@example.com -n 'Only needed until end of May 2013'
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   125
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   126
.. versionadded:: 0.6.0
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   127
604
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   128
userpassword
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   129
------------
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   130
Syntax:
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   131
 | **vmm userpassword** *address* [**-p** *password*]
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   132
 | **vmm up** *address* [**-p** *password*]
604
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   133
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   134
The password of an account can be updated with this subcommand.
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   135
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   136
If no *password* was provided, :command:`vmm` will prompt for it interactively.
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   137
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   138
Example:
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   139
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   140
.. code-block:: console
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   141
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   142
 root@host:~# vmm up d.user@example.com -p "A |\/|0r3 5ecur3 P4s5\/\/0rd?"
604
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   143
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   144
userquota
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   145
---------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   146
Syntax:
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   147
 | **vmm userquota** *address storage* [**-m** *messages*]
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   148
 | **vmm uq** *address storage* [**-m** *messages*]
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   149
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   150
This subcommand is used to set a new quota limit for the given account.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   151
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   152
When the argument *messages* was omitted the default number of messages
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   153
**0** (zero) will be applied.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   154
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   155
Instead of a *storage* limit pass the keyword **domain** to remove the
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   156
account-specific override, causing the domain's value to be in effect.
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   157
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   158
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   159
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   160
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   161
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   162
 root@host:~# userquota d.user@example.com 750m
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   163
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   164
.. versionadded:: 0.6.0
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   165
604
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   166
userservices
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   167
------------
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   168
Syntax:
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   169
 | **vmm userservices** *address* [**-s** *service ...*]
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   170
 | **vmm us** *address* [**-s** *service ...*]
604
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   171
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   172
To grant a user access to the specified services, use this command.
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   173
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   174
All omitted services will be deactivated/unusable for the user with the
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   175
given *address*.
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   176
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   177
Instead of any *service* pass the keyword **domain** to remove the
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   178
account-specific override, causing the domain's value to be in effect.
604
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   179
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   180
Example:
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   181
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   182
.. code-block:: console
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   183
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   184
 root@host:~# userservices d.user@example.com -s smtp imap
604
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   185
626
f151defe7078 doc/web: Updated documentation for vmm-0.6.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 604
diff changeset
   186
.. _usertransport:
f151defe7078 doc/web: Updated documentation for vmm-0.6.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 604
diff changeset
   187
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   188
usertransport
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   189
-------------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   190
Syntax:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   191
 | **vmm usertransport** *address transport*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   192
 | **vmm ut** *address transport*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   193
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   194
A different *transport* for an account can be specified with this subcommand.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   195
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   196
Instead of *transport* pass **domain** to remove the account-specific
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   197
override, causing the domain's value to be in effect.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   198
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   199
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   200
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   201
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   202
592
ef384bc8fde6 doc/web: Added the transport filed to the usertransport example.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   203
 root@host:~# ut c.user@example.com smtp:[pc105.it.example.com]