4 |
4 |
5 vmm is the easy to use command-line tool of the Virtual Mail Manager. |
5 vmm is the easy to use command-line tool of the Virtual Mail Manager. |
6 It allows you to simply and quickly administer your mail server. |
6 It allows you to simply and quickly administer your mail server. |
7 The general command syntax looks like:: |
7 The general command syntax looks like:: |
8 |
8 |
9 vmm subcommand [argument …] |
9 vmm -h|-v|--help|--version |
|
10 vmm subcommand -h|--help |
|
11 vmm subcommand arguments [options] |
10 |
12 |
11 Each subcommand has both a long and a short form. |
13 Each subcommand has both a long and a short form. |
12 Both forms are case sensitive. |
14 Both forms are case sensitive. |
13 The subcommands are categorized by their functionality: |
15 The subcommands are categorized by their functionality: |
14 |
16 |
24 howto/manage_relocated_users |
26 howto/manage_relocated_users |
25 |
27 |
26 |
28 |
27 Most of the *subcommand*\ s take one or more *argument*\ s. |
29 Most of the *subcommand*\ s take one or more *argument*\ s. |
28 |
30 |
|
31 Options |
|
32 ------- |
|
33 The following options are recognized by :program:`vmm`. |
|
34 |
|
35 .. program:: vmm |
|
36 |
|
37 .. option:: -h, --help |
|
38 |
|
39 show a list of available subcommands and exit. |
|
40 |
|
41 .. option:: -v, --version |
|
42 |
|
43 show :command:`vmm`'s version and copyright information and exit. |
|
44 |
|
45 |
29 Arguments |
46 Arguments |
30 --------- |
47 --------- |
31 address |
48 *address* |
32 The complete e-mail address (*local-part*\ @\ *fqdn*) of an user account, |
49 The complete e-mail address (*local-part*\ @\ *fqdn*) of an user account, |
33 alias address or relocated user. |
50 alias address or relocated user. |
34 |
51 |
35 destination |
52 *destination* |
36 Is either an e-mail address when used with |
53 Is either an e-mail address when used with |
37 :doc:`Alias subcommands <howto/manage_alias_addresses>`. |
54 :doc:`Alias subcommands <howto/manage_alias_addresses>`. |
38 Or a *fqnd* when used with |
55 Or a *fqdn* when used with |
39 :doc:`Alias domain subcommands <howto/manage_alias_domains>`. |
56 :doc:`Alias domain subcommands <howto/manage_alias_domains>`. |
40 |
57 |
41 fqdn |
58 *fqdn* |
42 The fully qualified domain name – without the trailing dot – of a domain |
59 The fully qualified domain name – without the trailing dot – of a domain |
43 or alias domain. |
60 or alias domain. |
44 |
61 |
45 messages |
62 *messages* |
46 An integer value which specifies a quota limit in number of messages. |
63 An integer value which specifies a quota limit in number of messages. |
47 **0** (zero) means unlimited - no quota limit for the number of messages. |
64 **0** (zero) means unlimited - no quota limit for the number of messages. |
48 |
65 |
49 option |
66 *option* |
50 Is the name of a configuration option, prefixed with the section name and |
67 Is the name of a configuration option, prefixed with the section name and |
51 a dot. |
68 a dot. |
52 For example: *misc*\ **.**\ *transport* |
69 For example: *misc*\ **.**\ *transport* |
53 All configuration options are described in :manpage:`vmm.cfg(5)`. |
70 All configuration options are described in :manpage:`vmm.cfg(5)`. |
54 |
71 |
55 service |
72 *service* |
56 The name of a service, commonly used with Dovecot. |
73 The name of a service, commonly used with Dovecot. |
57 Supported services are: **imap**, **pop3**, **sieve** and **smtp**. |
74 Supported services are: **imap**, **pop3**, **sieve** and **smtp**. |
58 |
75 |
59 storage |
76 *storage* |
60 Specifies a quota limit in bytes. |
77 Specifies a quota limit in bytes. |
61 One of the following prefixes can be appended to the integer value: |
78 One of the following prefixes can be appended to the integer value: |
62 **b** (bytes), **k** (kilobytes), **M** (megabytes) or **G** (gigabytes). |
79 **b** (bytes), **k** (kilobytes), **M** (megabytes) or **G** (gigabytes). |
63 **0** (zero) means unlimited - no quota limit in bytes. |
80 **0** (zero) means unlimited - no quota limit in bytes. |
64 |
81 |
65 transport |
82 *transport* |
66 A transport for Postfix, written as: *transport*\ **:** or |
83 A transport for Postfix, written as: *transport*\ **:** or |
67 *transport*\ **:**\ *nexthop*. |
84 *transport*\ **:**\ *nexthop*. |
68 See :manpage:`transport(5)` for more details. |
85 See :manpage:`transport(5)` for more details. |
69 |
86 |
70 Files |
87 Files |