doc/web/source/howto/manage_accounts.rst
author Pascal Volk <user@localhost.localdomain.org>
Sun, 30 Dec 2012 16:10:29 +0000
branchv0.7.x
changeset 665 33d15936b53a
parent 626 f151defe7078
child 682 697350dd9369
permissions -rw-r--r--
VMM/cli/subcommands: Switched argument parsing over to argparse.
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
-------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     6
Syntax:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     7
 | **vmm useradd** *address* [*password*]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     8
 | **vmm ua** *address* [*password*]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     9
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    10
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
    11
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    12
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
    13
interactively.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    14
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
    15
**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
    16
stdout after the account has been created.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    17
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    18
Example:
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
.. code-block:: console
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
 root@host:~# vmm ua d.user@example.com "A 5ecR3t P4s5\/\/0rd"
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    23
 root@host:~# vmm useradd e.user@example.com
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    24
 Enter new password:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    25
 Retype new password:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    26
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    27
userdelete
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    28
----------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    29
Syntax:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    30
 | **vmm userdelete** *address* [*force*]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    31
 | **vmm ud** *address* [*force*]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    32
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    33
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
    34
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    35
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
    36
:command:`vmm` will abort the requested operation and show an error message.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    37
To prevent this, specify the optional keyword **force**.
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
userinfo
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    40
--------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    41
Syntax:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    42
 | **vmm userinfo** *address* [*details*]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    43
 | **vmm ui** *address* [*details*]
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
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
    46
*address*.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    47
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    48
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
    49
displayed.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    50
Possible values for *details* are:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    51
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    52
======= ==============================================================
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    53
value   description
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
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
    56
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
    57
        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
    58
        is executed automatically, set *account.disk_usage* in your
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    59
        :file:`vmm.cfg` to **true**.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    60
full    to list all information mentioned above
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
Example:
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
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    66
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    67
 root@host:~# vmm ui d.user@example.com
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    68
 Account information
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    69
 -------------------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    70
         Address..........: d.user@example.com
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    71
         Name.............: None
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    72
         UID..............: 79881
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    73
         GID..............: 70704
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    74
         Home.............: /srv/mail/2/70704/79881
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    75
         Mail_Location....: mdbox:~/mdbox
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    76
         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
    77
         Quota Messages...: [  0.00%] 0/10,000 [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    78
         Transport........: lmtp:unix:private/dovecot-lmtp [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    79
         SMTP.............: disabled [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    80
         POP3.............: disabled [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    81
         IMAP.............: enabled [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    82
         SIEVE............: enabled [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    83
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    84
username
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    85
--------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    86
Syntax:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    87
 | **vmm username** *address* [*name*]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    88
 | **vmm un** *address* [*name*]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    89
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    90
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
    91
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    92
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
    93
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    94
Example:
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
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    97
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    98
 root@host:~# vmm un d.user@example.com "John Doe"
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
usernote
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
Syntax:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   103
 | **vmm usernote** *address* [*note*]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   104
 | **vmm uo** *address* [*note*]
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
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
   107
account.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   108
Without an argument, an existing note is removed.
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
Example:
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
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   113
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   114
 root@host:~# vmm uo d.user@example.com Only needed until end of May 2012
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
.. versionadded:: 0.6.0
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   117
604
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   118
userpassword
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   119
------------
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   120
Syntax:
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   121
 | **vmm userpassword** *address* [*password*]
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   122
 | **vmm up** *address* [*password*]
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   123
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   124
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
   125
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   126
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
   127
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   128
Example:
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
.. code-block:: console
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   131
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   132
 root@host:~# vmm up d.user@example.com "A |\/|0r3 5ecur3 P4s5\/\/0rd?"
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   133
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   134
userquota
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   135
---------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   136
Syntax:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   137
 | **vmm userquota** *address storage* [*messages*]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   138
 | **vmm uq** *address storage* [*messages*]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   139
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   140
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
   141
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   142
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
   143
**0** (zero) will be applied.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   144
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   145
Instead of *storage* pass **domain** to remove the account-specific
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   146
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
   147
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   148
Example:
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
.. code-block:: console
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
 root@host:~# userquota d.user@example.com 750m
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   153
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   154
.. versionadded:: 0.6.0
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   155
604
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   156
userservices
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   157
------------
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   158
Syntax:
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   159
 | **vmm userservices** *address* [*service ...*]
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   160
 | **vmm us** *address* [*service ...*]
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   161
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   162
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
   163
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   164
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
   165
given *address*.
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   166
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   167
Instead of *service* pass **domain** to remove the account-specific override,
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   168
causing the domain's value to be in effect.
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   169
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   170
Example:
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
.. code-block:: console
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
 root@host:~# userservices d.user@example.com SMTP IMAP
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   175
626
f151defe7078 doc/web: Updated documentation for vmm-0.6.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 604
diff changeset
   176
.. _usertransport:
f151defe7078 doc/web: Updated documentation for vmm-0.6.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 604
diff changeset
   177
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   178
usertransport
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   179
-------------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   180
Syntax:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   181
 | **vmm usertransport** *address transport*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   182
 | **vmm ut** *address transport*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   183
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   184
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
   185
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   186
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
   187
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
   188
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   189
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   190
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   191
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   192
592
ef384bc8fde6 doc/web: Added the transport filed to the usertransport example.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   193
 root@host:~# ut c.user@example.com smtp:[pc105.it.example.com]