doc/web/source/howto/manage_accounts.rst
author Pascal Volk <user@localhost.localdomain.org>
Mon, 09 Jun 2014 18:54:44 +0000
branchv0.7.x
changeset 757 3d592b5d5e2d
parent 752 271bd82c05c0
permissions -rw-r--r--
{man1,doc/web}: Updated userdelete's --delete-home -> --delete-directory.
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
----------
752
271bd82c05c0 {man1,doc/web}: Added userdelete --delete-home's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 738
diff changeset
    39
271bd82c05c0 {man1,doc/web}: Added userdelete --delete-home's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 738
diff changeset
    40
.. program:: vmm userdelete
271bd82c05c0 {man1,doc/web}: Added userdelete --delete-home's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 738
diff changeset
    41
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    42
Syntax:
757
3d592b5d5e2d {man1,doc/web}: Updated userdelete's --delete-home -> --delete-directory.
Pascal Volk <user@localhost.localdomain.org>
parents: 752
diff changeset
    43
 | **vmm userdelete** *address* [**‒‒delete-directory**] [**‒‒force**]
3d592b5d5e2d {man1,doc/web}: Updated userdelete's --delete-home -> --delete-directory.
Pascal Volk <user@localhost.localdomain.org>
parents: 752
diff changeset
    44
 | **vmm ud** *address* [**‒‒delete-directory**] [**‒‒force**]
752
271bd82c05c0 {man1,doc/web}: Added userdelete --delete-home's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 738
diff changeset
    45
757
3d592b5d5e2d {man1,doc/web}: Updated userdelete's --delete-home -> --delete-directory.
Pascal Volk <user@localhost.localdomain.org>
parents: 752
diff changeset
    46
.. option:: --delete-directory
752
271bd82c05c0 {man1,doc/web}: Added userdelete --delete-home's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 738
diff changeset
    47
271bd82c05c0 {man1,doc/web}: Added userdelete --delete-home's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 738
diff changeset
    48
 When this option is present, :command:`vmm` will also delete the account's
271bd82c05c0 {man1,doc/web}: Added userdelete --delete-home's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 738
diff changeset
    49
 home directory.
271bd82c05c0 {man1,doc/web}: Added userdelete --delete-home's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 738
diff changeset
    50
 This overrides the *account.delete_directory* setting of :file:`vmm.cfg`.
271bd82c05c0 {man1,doc/web}: Added userdelete --delete-home's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 738
diff changeset
    51
271bd82c05c0 {man1,doc/web}: Added userdelete --delete-home's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 738
diff changeset
    52
.. option:: --force
271bd82c05c0 {man1,doc/web}: Added userdelete --delete-home's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 738
diff changeset
    53
271bd82c05c0 {man1,doc/web}: Added userdelete --delete-home's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 738
diff changeset
    54
 When this option is given, :command:`vmm` will delete the account, even if
271bd82c05c0 {man1,doc/web}: Added userdelete --delete-home's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 738
diff changeset
    55
 there are aliases with the account's address as their destination.
271bd82c05c0 {man1,doc/web}: Added userdelete --delete-home's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 738
diff changeset
    56
 Those aliases will be deleted too.
591
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
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
    59
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    60
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
    61
:command:`vmm` will abort the requested operation and show an error message.
752
271bd82c05c0 {man1,doc/web}: Added userdelete --delete-home's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 738
diff changeset
    62
To prevent this, give the optional argument :option:`--force`.
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    63
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    64
userinfo
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    65
--------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    66
Syntax:
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
    67
 | **vmm userinfo** *address* [**-d** *details*]
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
    68
 | **vmm ui** *address* [**-d** *details*]
591
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
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
    71
*address*.
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
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
    74
displayed.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    75
Possible values for *details* are:
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
======= ==============================================================
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    78
value   description
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
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
    81
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
    82
        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
    83
        is executed automatically, set *account.disk_usage* in your
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    84
        :file:`vmm.cfg` to **true**.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    85
full    to list all information mentioned above
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    86
======= ==============================================================
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    87
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    88
Example:
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
.. code-block:: console
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
 root@host:~# vmm ui d.user@example.com
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    93
 Account information
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    94
 -------------------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    95
         Address..........: d.user@example.com
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    96
         Name.............: None
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    97
         UID..............: 79881
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    98
         GID..............: 70704
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    99
         Home.............: /srv/mail/2/70704/79881
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   100
         Mail_Location....: mdbox:~/mdbox
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   101
         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
   102
         Quota Messages...: [  0.00%] 0/10,000 [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   103
         Transport........: lmtp:unix:private/dovecot-lmtp [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   104
         SMTP.............: disabled [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   105
         POP3.............: disabled [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   106
         IMAP.............: enabled [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   107
         SIEVE............: enabled [domain default]
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   108
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   109
username
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   110
--------
690
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   111
.. program:: vmm username
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   112
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   113
Syntax:
690
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   114
 | **vmm username** *address* **-d** | **-n** *name*
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   115
 | **vmm un** *address* **-d** | **-n** *name*
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   116
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   117
.. option:: -d
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   118
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   119
 delete the user's name
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   120
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   121
.. option:: -n name
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   122
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   123
 a user's real name
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   124
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   125
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
   126
690
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   127
In order to delete the value stored for the account, pass the :option:`-d`
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   128
option.
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   129
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   130
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   131
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   132
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   133
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   134
 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
   135
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   136
usernote
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   137
--------
690
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   138
.. program:: vmm usernote
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   139
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   140
Syntax:
690
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   141
 | **vmm usernote** *address* **-d** | **-n** *note*
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   142
 | **vmm uo** *address* **-d** | **-n** *note*
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   143
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   144
.. option:: -d
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   145
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   146
 delete the user's note
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   147
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   148
.. option:: -n note
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   149
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   150
 the note that should be set
591
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
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
   153
account.
690
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   154
In order to delete an existing note, pass the :option:`-d` option.
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   155
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   156
Example:
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
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   159
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   160
 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
   161
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   162
.. versionadded:: 0.6.0
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   163
604
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   164
userpassword
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   165
------------
730
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 690
diff changeset
   166
.. program:: vmm userpassword
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 690
diff changeset
   167
604
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   168
Syntax:
738
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   169
 | **vmm userpassword** *address* ([**-p** *password*] [**-s** *scheme*] | \
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   170
  [**‒‒hash** *pwhash*])
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   171
 | **vmm up** *address* ([**-p** *password*] [**-s** *scheme*] | \
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   172
  [**‒‒hash** *pwhash*])
730
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 690
diff changeset
   173
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 690
diff changeset
   174
.. option:: -p password
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 690
diff changeset
   175
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 690
diff changeset
   176
 The user's new password.
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 690
diff changeset
   177
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 690
diff changeset
   178
.. option:: -s scheme
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 690
diff changeset
   179
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 690
diff changeset
   180
 When a *scheme* was specified, it overrides the *misc.password_scheme*
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 690
diff changeset
   181
 setting, configured in the :file:`vmm.cfg` file.
604
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   182
738
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   183
.. option:: --hash pwhash
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   184
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   185
 A hashed password, prefixed with **{**\ *SCHEME*\ **}**; as generated by
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   186
 :command:`doveadm pw`.
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   187
 You should enclose the hashed password in single quotes, if it contains
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   188
 one ore more dollar signs (**$**).
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   189
604
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   190
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
   191
738
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   192
If no *password* or *pwhash* was provided, :command:`vmm` will prompt for a
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   193
password interactively.
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   194
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   195
.. note::
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   196
  When passing a hashed password, :command:`vmm` checks only if the included
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   197
  *SCHEME* is supported by your Dovecot installation.  No further checks are
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   198
  done.
604
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   199
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   200
Example:
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   201
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   202
.. code-block:: console
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   203
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   204
 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
   205
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   206
userquota
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   207
---------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   208
Syntax:
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   209
 | **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
   210
 | **vmm uq** *address storage* [**-m** *messages*]
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   211
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   212
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
   213
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   214
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
   215
**0** (zero) will be applied.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   216
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   217
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
   218
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
   219
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   220
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   221
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   222
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   223
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   224
 root@host:~# userquota d.user@example.com 750m
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   225
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   226
.. versionadded:: 0.6.0
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   227
604
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   228
userservices
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   229
------------
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   230
Syntax:
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   231
 | **vmm userservices** *address* [**-s** *service ...*]
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   232
 | **vmm us** *address* [**-s** *service ...*]
604
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   233
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   234
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
   235
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   236
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
   237
given *address*.
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   238
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   239
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
   240
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
   241
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   242
Example:
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   243
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   244
.. code-block:: console
7fdc4b2d4640 doc/web: Added missing userservices description.
Pascal Volk <user@localhost.localdomain.org>
parents: 592
diff changeset
   245
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 626
diff changeset
   246
 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
   247
626
f151defe7078 doc/web: Updated documentation for vmm-0.6.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 604
diff changeset
   248
.. _usertransport:
f151defe7078 doc/web: Updated documentation for vmm-0.6.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 604
diff changeset
   249
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   250
usertransport
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   251
-------------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   252
Syntax:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   253
 | **vmm usertransport** *address transport*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   254
 | **vmm ut** *address transport*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   255
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   256
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
   257
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   258
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
   259
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
   260
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   261
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   262
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   263
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   264
592
ef384bc8fde6 doc/web: Added the transport filed to the usertransport example.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   265
 root@host:~# ut c.user@example.com smtp:[pc105.it.example.com]