doc/web/source/howto/general_subcommands.rst
author Pascal Volk <user@localhost.localdomain.org>
Sun, 13 Jan 2013 17:24:01 +0000
branchv0.7.x
changeset 685 c6024bc1de0f
parent 682 697350dd9369
child 691 932cd76bf879
permissions -rw-r--r--
VMM/cli/subcommands: domain_add: Fixed a coding error.
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
General subcommands
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
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     5
configget
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     6
---------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     7
Syntax:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     8
 | **vmm configget** *option*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     9
 | **vmm cg** *option*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    10
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    11
This subcommand is used to display the actual value of the given
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    12
configuration *option*.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    13
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    14
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    15
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    16
.. code-block:: console
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
 root@host:~# vmm configget misc.crypt_sha512_rounds
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    19
 misc.crypt_sha512_rounds = 5000
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    20
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    21
.. versionadded:: 0.6.0
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    22
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    23
configset
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    24
---------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    25
Syntax:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    26
 | **vmm configset** *option value*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    27
 | **vmm cs** *option value*
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
Use this subcommand to set or update a single configuration option's value.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    30
*option* is the configuration option, *value* is the *option*'s new value.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    31
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    32
.. note::
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    33
 This subcommand will create a new :file:`vmm.cfg` without any comments.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    34
 Your current configuration file will be backed as :file:`vmm.cfg.bak`.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    35
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    36
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    37
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    38
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    39
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    40
 root@host:~# vmm configget domain.transport
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    41
 domain.transport = dovecot:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    42
 root@host:~# vmm configset domain.transport lmtp:unix:private/dovecot-lmtp
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    43
 root@host:~# vmm cg domain.transport
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    44
 domain.transport = lmtp:unix:private/dovecot-lmtp
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    45
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    46
.. versionadded:: 0.6.0
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
configure
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    49
---------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    50
Syntax:
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
    51
 | **vmm configure** [**-s** *section*]
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
    52
 | **vmm cf** [**-s** *section*]
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    53
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    54
Starts the interactive configuration for all configuration sections.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    55
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    56
In this process the currently set value of each option will be displayed
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    57
in square brackets.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    58
If no value is configured, the default value of each option will be
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    59
displayed in square brackets.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    60
Press the return key, to accept the displayed value.
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
If the optional argument *section* is given, only the configuration options
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    63
from the given section will be displayed and will be configurable.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    64
The following sections are available:
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
======== ==========================
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    67
section  description
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    68
======== ==========================
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    69
account  Account settings
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    70
bin      Paths to external binaries
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    71
database Database settings
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    72
domain   Domain settings
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    73
mailbox  Mailbox settings
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    74
misc     Miscellaneous settings
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    75
======== ==========================
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
All configuration options are described in :manpage:`vmm.cfg(5)`.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    78
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    79
.. note::
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    80
 This subcommand will create a new :file:`vmm.cfg` without any comments.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    81
 Your current configuration file will be backed as :file:`vmm.cfg.bak`.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    82
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    83
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    84
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    85
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    86
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
    87
 root@host:~# vmm configure -s mailbox
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    88
 Using configuration file: /usr/local/etc/vmm.cfg
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
 * Configuration section: `mailbox'
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    91
 Enter new value for option folders [Drafts:Sent:Templates:Trash]:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    92
 Enter new value for option format [maildir]: mdbox
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    93
 Enter new value for option subscribe [True]:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    94
 Enter new value for option root [Maildir]: mdbox
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
getuser
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
Syntax:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    99
 | **vmm getuser** *uid*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   100
 | **vmm gu** *ui*
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 only the *uid* is available, for example from process list, the
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   103
subcommand **getuser** will show the user's address.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   104
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   105
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   106
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   107
.. code-block:: console
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
 root@host:~# vmm getuser 79876
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   110
 Account information
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
         UID............: 79876
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   113
         GID............: 70704
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   114
         Address........: a.user@example.com
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   115
622
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   116
listaddresses
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   117
-------------
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   118
Syntax:
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
   119
 | **vmm listaddresses** [**-p** *pattern*]
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
   120
 | **vmm ll** [**-p** *pattern*]
622
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   121
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   122
This command lists all defined addresses. Addresses belonging to
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   123
alias-domains are prefixed with a '-', addresses of regular domains with
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   124
a '+'.
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   125
Additionally, the letters 'u', 'a', and 'r' indicate the type of each
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   126
address: user, alias and relocated respectively. The output can be limited
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   127
with an optional *pattern*.
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   128
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   129
To perform a wild card search, the **%** character can be used at the start
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   130
and/or the end of the *pattern*.
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   131
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   132
Example:
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   133
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   134
.. code-block:: console
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   135
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
   136
 root@host:~# vmm ll -p example.com
622
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   137
 Matching addresses
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   138
 ------------------
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   139
         [u+] a.user@example.com
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   140
         [r+] b.user@example.com
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   141
         [u+] d.user@example.com
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   142
         [u+] john.doe@example.com
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   143
         [u+] postmaster@example.com
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   144
         [a+] support@example.com
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   145
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   146
.. versionadded:: 0.6.0
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   147
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   148
listaliases
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   149
-----------
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   150
Syntax:
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
   151
 | **vmm listaliases** [**-p** *pattern*]
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
   152
 | **vmm la** [**-p** *pattern*]
622
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   153
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   154
This command lists all defined aliases. Aliases belonging to alias-domains
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   155
are prefixed with a '-', addresses of regular domains with a '+'.
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   156
The output can be limited with an optional *pattern*.
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   157
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   158
To perform a wild card search, the **%** character can be used at the start
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   159
and/or the end of the *pattern*.
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   160
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   161
Example:
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   162
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   163
.. code-block:: console
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   164
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
   165
 root@host:~# vmm listaliases -p example.com
622
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   166
 Matching aliases
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   167
 ----------------
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   168
         [+] support@example.com
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   169
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   170
.. versionadded:: 0.6.0
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   171
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   172
listdomains
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   173
-----------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   174
Syntax:
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
   175
 | **vmm listdomains** [**-p** *pattern*]
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
   176
 | **vmm ld** [**-p** *pattern*]
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   177
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   178
This subcommand lists all available domains.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   179
All domain names will be prefixed either with '[+]', if the domain is
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   180
a primary domain, or with '[-]', if it is an alias domain name.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   181
The output can be limited with an optional pattern.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   182
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   183
To perform a wild card search, the **%** character can be used at the start
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   184
and/or the end of the *pattern*.
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
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   187
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   188
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   189
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
   190
 root@host:~# vmm listdomains -p %example%
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   191
 Matching domains
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   192
 ----------------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   193
         [+] example.com
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   194
         [-]     e.g.example.com
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   195
         [-]     example.name
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   196
         [+] example.net
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   197
         [+] example.org
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
listpwschemes
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
Syntax:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   202
 | **vmm listpwschemes**
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   203
 | **vmm lp**
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   204
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   205
This subcommand lists all password schemes which could be used in the
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   206
:file:`vmm.cfg` as value of the *misc.password_scheme* option.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   207
The output varies, depending on the used Dovecot version and the system's
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   208
libc.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   209
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   210
When your Dovecot installation isn't too old, you will see additionally
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   211
a few usable encoding suffixes.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   212
One of them can be appended to the password scheme.
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
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   215
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   216
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   217
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   218
 root@host:~# vmm listpwschemes
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   219
 Usable password schemes
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   220
 -----------------------
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
   221
         CLEARTEXT CRAM-MD5 CRYPT DIGEST-MD5 HMAC-MD5 LANMAN LDAP-MD5 MD5
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
   222
         MD5-CRYPT NTLM OTP PLAIN PLAIN-MD4 PLAIN-MD5 RPA SHA SHA1 SHA256
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
   223
         SHA256-CRYPT SHA512 SHA512-CRYPT SKEY SMD5 SSHA SSHA256 SSHA512
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   224
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   225
 Usable encoding suffixes
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   226
 ------------------------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   227
         .B64 .BASE64 .HEX
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   228
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   229
.. versionadded:: 0.6.0
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   230
622
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   231
listrelocated
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   232
-------------
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   233
Syntax:
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
   234
 | **vmm listrelocated** [**-p** *pattern*]
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
   235
 | **vmm lr** [**-p** *pattern*]
622
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   236
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   237
This command lists all defined relocated addresses.
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   238
Relocated entries belonging to alias-domains are prefixed with a '-',
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   239
addresses of regular domains with a '+'.
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   240
The output can be limited with an optional *pattern*.
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   241
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   242
To perform a wild card search, the **%** character can be used at the start
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   243
and/or the end of the *pattern*.
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   244
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   245
Example:
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   246
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   247
.. code-block:: console
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   248
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
   249
 root@host:~# vmm listrelocated -p example.com
622
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   250
 Matching relocated users
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   251
 ------------------------
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   252
         [+] b.user@example.com
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   253
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   254
.. versionadded:: 0.6.0
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   255
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   256
listusers
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   257
---------
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   258
Syntax:
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
   259
 | **vmm listusers** [**-p** *pattern*]
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
   260
 | **vmm lu** [**-p** *pattern*]
622
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   261
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   262
This command lists all user accounts.
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   263
User accounts belonging to alias-domains are prefixed with a '-', addresses
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   264
of regular domains with a '+'.
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   265
The output can be limited with an optional *pattern*.
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   266
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   267
To perform a wild card search, the **%** character can be used at the start
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   268
and/or the end of the *pattern*.
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   269
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   270
Example:
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   271
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   272
.. code-block:: console
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   273
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 622
diff changeset
   274
 root@host:~# vmm listusers -p example.com
622
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   275
 Matching user accounts
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   276
 ----------------------
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   277
         [+] a.user@example.com
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   278
         [+] d.user@example.com
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   279
         [+] john.doe@example.com
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   280
         [+] postmaster@example.com
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   281
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
   282
.. versionadded:: 0.6.0