|
1 ========= |
|
2 Using vmm |
|
3 ========= |
|
4 |
|
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. |
|
7 The general command syntax looks like:: |
|
8 |
|
9 vmm subcommand [argument …] |
|
10 |
|
11 Each subcommand has both a long and a short form. |
|
12 Both forms are case sensitive. |
|
13 The subcommands are categorized by their functionality: |
|
14 |
|
15 .. toctree:: |
|
16 :maxdepth: 1 |
|
17 |
|
18 howto/general_subcommands |
|
19 howto/manage_domains |
|
20 howto/manage_alias_domains |
|
21 howto/manage_accounts |
|
22 howto/manage_alias_addresses |
|
23 howto/manage_catch-all_addresses |
|
24 howto/manage_relocated_users |
|
25 |
|
26 |
|
27 Most of the *subcommand*\ s take one or more *argument*\ s. |
|
28 |
|
29 Arguments |
|
30 --------- |
|
31 address |
|
32 The complete e-mail address (*local-part*\ @\ *fqdn*) of an user account, |
|
33 alias address or relocated user. |
|
34 |
|
35 destination |
|
36 Is either an e-mail address when used with |
|
37 :doc:`Alias subcommands <howto/manage_alias_addresses>`. |
|
38 Or a *fqnd* when used with |
|
39 :doc:`Alias domain subcommands <howto/manage_alias_domains>`. |
|
40 |
|
41 fqdn |
|
42 The fully qualified domain name – without the trailing dot – of a domain |
|
43 or alias domain. |
|
44 |
|
45 messages |
|
46 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. |
|
48 |
|
49 option |
|
50 Is the name of a configuration option, prefixed with the section name and |
|
51 a dot. |
|
52 For example: *misc*\ **.**\ *transport* |
|
53 All configuration options are described in :manpage:`vmm.cfg(5)`. |
|
54 |
|
55 service |
|
56 The name of a service, commonly used with Dovecot. |
|
57 Supported services are: **imap**, **pop3**, **sieve** and **smtp**. |
|
58 |
|
59 storage |
|
60 Specifies a quota limit in bytes. |
|
61 One of the following prefixes can be appended to the integer value: |
|
62 **b** (bytes), **k** (kilobytes), **M** (megabytes) or **G** (gigabytes). |
|
63 **0** (zero) means unlimited - no quota limit in bytes. |
|
64 |
|
65 transport |
|
66 A transport for Postfix, written as: *transport*\ **:** or |
|
67 *transport*\ **:**\ *nexthop*. |
|
68 See :manpage:`transport(5)` for more details. |
|
69 |
|
70 Files |
|
71 ----- |
|
72 :command:`vmm` reads its configuration data from :file:`vmm.cfg`. |
|
73 |
|
74 :file:`/root/vmm.cfg` |
|
75 will be used when found. |
|
76 |
|
77 :file:`/usr/local/etc/vmm.cfg` |
|
78 will be used when the above file doesn't exist. |
|
79 |
|
80 :file:`/etc/vmm.cfg` |
|
81 will be used when none of the both above mentioned files exists. |