doc/web/source/howto.rst
author Pascal Volk <user@localhost.localdomain.org>
Sat, 19 Jan 2013 16:55:18 +0000
branchv0.7.x
changeset 687 5eb033796444
parent 682 697350dd9369
permissions -rw-r--r--
doc: Added description of {domain,user}add's -n option.
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
Using vmm
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
vmm is the easy to use command-line tool of the Virtual Mail Manager.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     6
It allows you to simply and quickly administer your mail server.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     7
The general command syntax looks like::
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     8
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
     9
 vmm -h|-v|--help|--version
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    10
 vmm subcommand -h|--help
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    11
 vmm subcommand arguments [options]
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    12
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    13
Each subcommand has both a long and a short form.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    14
Both forms are case sensitive.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    15
The subcommands are categorized by their functionality:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    16
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    17
.. toctree::
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    18
   :maxdepth: 1
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
   howto/general_subcommands
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    21
   howto/manage_domains
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    22
   howto/manage_alias_domains
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    23
   howto/manage_accounts
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    24
   howto/manage_alias_addresses
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    25
   howto/manage_catch-all_addresses
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    26
   howto/manage_relocated_users
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
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    29
Most of the *subcommand*\ s take one or more *argument*\ s.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    30
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    31
Options
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    32
-------
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    33
The following options are recognized by :program:`vmm`.
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    34
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    35
.. program:: vmm
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    36
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    37
.. option:: -h, --help
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    38
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    39
 show a list of available subcommands and exit.
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    40
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    41
.. option:: -v, --version
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    42
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    43
 show :command:`vmm`'s version and copyright information and exit.
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    44
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    45
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    46
Arguments
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    47
---------
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    48
*address*
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    49
 The complete e-mail address (*local-part*\ @\ *fqdn*) of an user account,
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    50
 alias address or relocated user.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    51
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    52
*destination*
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    53
 Is either an e-mail address when used with
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    54
 :doc:`Alias subcommands <howto/manage_alias_addresses>`.
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    55
 Or a *fqdn* when used with
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    56
 :doc:`Alias domain subcommands <howto/manage_alias_domains>`.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    57
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    58
*fqdn*
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    59
 The fully qualified domain name – without the trailing dot – of a domain
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    60
 or alias domain.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    61
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    62
*messages*
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    63
 An integer value which specifies a quota limit in number of messages.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    64
 **0** (zero) means unlimited - no quota limit for the number of messages.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    65
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    66
*option*
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    67
 Is the name of a configuration option, prefixed with the section name and
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    68
 a dot.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    69
 For example: *misc*\ **.**\ *transport*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    70
 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
    71
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    72
*service*
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    73
 The name of a service, commonly used with Dovecot.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    74
 Supported services are: **imap**, **pop3**, **sieve** and **smtp**.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    75
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    76
*storage*
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    77
 Specifies a quota limit in bytes.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    78
 One of the following prefixes can be appended to the integer value:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    79
 **b** (bytes), **k** (kilobytes), **M** (megabytes) or **G** (gigabytes).
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    80
 **0** (zero) means unlimited - no quota limit in bytes.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    81
682
697350dd9369 doc/web: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    82
*transport*
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    83
 A transport for Postfix, written as: *transport*\ **:** or
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    84
 *transport*\ **:**\ *nexthop*.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    85
 See :manpage:`transport(5)` for more details.
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
Files
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    88
-----
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    89
:command:`vmm` reads its configuration data from :file:`vmm.cfg`.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    90
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    91
:file:`/root/vmm.cfg`
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    92
 will be used when found.
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
:file:`/usr/local/etc/vmm.cfg`
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    95
 will be used when the above file doesn't exist.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    96
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    97
:file:`/etc/vmm.cfg`
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    98
 will be used when none of the both above mentioned files exists.