|
1 =================== |
|
2 General subcommands |
|
3 =================== |
|
4 |
|
5 configget |
|
6 --------- |
|
7 Syntax: |
|
8 | **vmm configget** *option* |
|
9 | **vmm cg** *option* |
|
10 |
|
11 This subcommand is used to display the actual value of the given |
|
12 configuration *option*. |
|
13 |
|
14 Example: |
|
15 |
|
16 .. code-block:: console |
|
17 |
|
18 root@host:~# vmm configget misc.crypt_sha512_rounds |
|
19 misc.crypt_sha512_rounds = 5000 |
|
20 |
|
21 .. versionadded:: 0.6.0 |
|
22 |
|
23 configset |
|
24 --------- |
|
25 Syntax: |
|
26 | **vmm configset** *option value* |
|
27 | **vmm cs** *option value* |
|
28 |
|
29 Use this subcommand to set or update a single configuration option's value. |
|
30 *option* is the configuration option, *value* is the *option*'s new value. |
|
31 |
|
32 .. note:: |
|
33 This subcommand will create a new :file:`vmm.cfg` without any comments. |
|
34 Your current configuration file will be backed as :file:`vmm.cfg.bak`. |
|
35 |
|
36 Example: |
|
37 |
|
38 .. code-block:: console |
|
39 |
|
40 root@host:~# vmm configget domain.transport |
|
41 domain.transport = dovecot: |
|
42 root@host:~# vmm configset domain.transport lmtp:unix:private/dovecot-lmtp |
|
43 root@host:~# vmm cg domain.transport |
|
44 domain.transport = lmtp:unix:private/dovecot-lmtp |
|
45 |
|
46 .. versionadded:: 0.6.0 |
|
47 |
|
48 configure |
|
49 --------- |
|
50 Syntax: |
|
51 | **vmm configure** [*section*] |
|
52 | **vmm cf** [*section*] |
|
53 |
|
54 Starts the interactive configuration for all configuration sections. |
|
55 |
|
56 In this process the currently set value of each option will be displayed |
|
57 in square brackets. |
|
58 If no value is configured, the default value of each option will be |
|
59 displayed in square brackets. |
|
60 Press the return key, to accept the displayed value. |
|
61 |
|
62 If the optional argument *section* is given, only the configuration options |
|
63 from the given section will be displayed and will be configurable. |
|
64 The following sections are available: |
|
65 |
|
66 ======== ========================== |
|
67 section description |
|
68 ======== ========================== |
|
69 account Account settings |
|
70 bin Paths to external binaries |
|
71 database Database settings |
|
72 domain Domain settings |
|
73 mailbox Mailbox settings |
|
74 misc Miscellaneous settings |
|
75 ======== ========================== |
|
76 |
|
77 All configuration options are described in :manpage:`vmm.cfg(5)`. |
|
78 |
|
79 .. note:: |
|
80 This subcommand will create a new :file:`vmm.cfg` without any comments. |
|
81 Your current configuration file will be backed as :file:`vmm.cfg.bak`. |
|
82 |
|
83 Example: |
|
84 |
|
85 .. code-block:: console |
|
86 |
|
87 root@host:~# vmm configure mailbox |
|
88 Using configuration file: /usr/local/etc/vmm.cfg |
|
89 |
|
90 * Configuration section: `mailbox' |
|
91 Enter new value for option folders [Drafts:Sent:Templates:Trash]: |
|
92 Enter new value for option format [maildir]: mdbox |
|
93 Enter new value for option subscribe [True]: |
|
94 Enter new value for option root [Maildir]: mdbox |
|
95 |
|
96 getuser |
|
97 ------- |
|
98 Syntax: |
|
99 | **vmm getuser** *uid* |
|
100 | **vmm gu** *ui* |
|
101 |
|
102 If only the *uid* is available, for example from process list, the |
|
103 subcommand **getuser** will show the user's address. |
|
104 |
|
105 Example: |
|
106 |
|
107 .. code-block:: console |
|
108 |
|
109 root@host:~# vmm getuser 79876 |
|
110 Account information |
|
111 ------------------- |
|
112 UID............: 79876 |
|
113 GID............: 70704 |
|
114 Address........: a.user@example.com |
|
115 |
|
116 help |
|
117 ---- |
|
118 Syntax: |
|
119 | **vmm help** [*subcommand*] |
|
120 | **vmm h** [*subcommand*] |
|
121 |
|
122 Prints a list of available subcommands with a short description to stdout. |
|
123 When a *subcommand* was given, help for that *subcommand* will be displayed. |
|
124 After this :command:`vmm` exits. |
|
125 |
|
126 listdomains |
|
127 ----------- |
|
128 Syntax: |
|
129 | **vmm listdomains** [*pattern*] |
|
130 | **vmm ld** [*pattern*] |
|
131 |
|
132 This subcommand lists all available domains. |
|
133 All domain names will be prefixed either with '[+]', if the domain is |
|
134 a primary domain, or with '[-]', if it is an alias domain name. |
|
135 The output can be limited with an optional pattern. |
|
136 |
|
137 To perform a wild card search, the **%** character can be used at the start |
|
138 and/or the end of the *pattern*. |
|
139 |
|
140 Example: |
|
141 |
|
142 .. code-block:: console |
|
143 |
|
144 root@host:~# vmm listdomains %example% |
|
145 Matching domains |
|
146 ---------------- |
|
147 [+] example.com |
|
148 [-] e.g.example.com |
|
149 [-] example.name |
|
150 [+] example.net |
|
151 [+] example.org |
|
152 |
|
153 listpwschemes |
|
154 ------------- |
|
155 Syntax: |
|
156 | **vmm listpwschemes** |
|
157 | **vmm lp** |
|
158 |
|
159 This subcommand lists all password schemes which could be used in the |
|
160 :file:`vmm.cfg` as value of the *misc.password_scheme* option. |
|
161 The output varies, depending on the used Dovecot version and the system's |
|
162 libc. |
|
163 |
|
164 When your Dovecot installation isn't too old, you will see additionally |
|
165 a few usable encoding suffixes. |
|
166 One of them can be appended to the password scheme. |
|
167 |
|
168 Example: |
|
169 |
|
170 .. code-block:: console |
|
171 |
|
172 root@host:~# vmm listpwschemes |
|
173 Usable password schemes |
|
174 ----------------------- |
|
175 CRYPT SHA512-CRYPT LDAP-MD5 DIGEST-MD5 SHA256 SHA512 SSHA512 |
|
176 SKEY SSHA NTLM RPA MD5-CRYPT HMAC-MD5 SHA1 PLAIN SHA CRAM-MD5 |
|
177 SSHA256 MD5 LANMAN CLEARTEXT PLAIN-MD5 PLAIN-MD4 OTP SMD5 |
|
178 SHA256-CRYPT |
|
179 |
|
180 Usable encoding suffixes |
|
181 ------------------------ |
|
182 .B64 .BASE64 .HEX |
|
183 |
|
184 .. versionadded:: 0.6.0 |
|
185 |
|
186 version |
|
187 ------- |
|
188 Syntax: |
|
189 | **vmm version** |
|
190 | **vmm v** |
|
191 |
|
192 Prints :command:`vmm`'s version and copyright information to stdout. |
|
193 After this :command:`vmm` exits. |