46 .. versionadded:: 0.6.0 |
46 .. versionadded:: 0.6.0 |
47 |
47 |
48 configure |
48 configure |
49 --------- |
49 --------- |
50 Syntax: |
50 Syntax: |
51 | **vmm configure** [*section*] |
51 | **vmm configure** [**-s** *section*] |
52 | **vmm cf** [*section*] |
52 | **vmm cf** [**-s** *section*] |
53 |
53 |
54 Starts the interactive configuration for all configuration sections. |
54 Starts the interactive configuration for all configuration sections. |
55 |
55 |
56 In this process the currently set value of each option will be displayed |
56 In this process the currently set value of each option will be displayed |
57 in square brackets. |
57 in square brackets. |
82 |
82 |
83 Example: |
83 Example: |
84 |
84 |
85 .. code-block:: console |
85 .. code-block:: console |
86 |
86 |
87 root@host:~# vmm configure mailbox |
87 root@host:~# vmm configure -s mailbox |
88 Using configuration file: /usr/local/etc/vmm.cfg |
88 Using configuration file: /usr/local/etc/vmm.cfg |
89 |
89 |
90 * Configuration section: `mailbox' |
90 * Configuration section: `mailbox' |
91 Enter new value for option folders [Drafts:Sent:Templates:Trash]: |
91 Enter new value for option folders [Drafts:Sent:Templates:Trash]: |
92 Enter new value for option format [maildir]: mdbox |
92 Enter new value for option format [maildir]: mdbox |
111 ------------------- |
111 ------------------- |
112 UID............: 79876 |
112 UID............: 79876 |
113 GID............: 70704 |
113 GID............: 70704 |
114 Address........: a.user@example.com |
114 Address........: a.user@example.com |
115 |
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 listaddresses |
116 listaddresses |
127 ------------- |
117 ------------- |
128 Syntax: |
118 Syntax: |
129 | **vmm listaddresses** [*pattern*] |
119 | **vmm listaddresses** [**-p** *pattern*] |
130 | **vmm ll** [*pattern*] |
120 | **vmm ll** [**-p** *pattern*] |
131 |
121 |
132 This command lists all defined addresses. Addresses belonging to |
122 This command lists all defined addresses. Addresses belonging to |
133 alias-domains are prefixed with a '-', addresses of regular domains with |
123 alias-domains are prefixed with a '-', addresses of regular domains with |
134 a '+'. |
124 a '+'. |
135 Additionally, the letters 'u', 'a', and 'r' indicate the type of each |
125 Additionally, the letters 'u', 'a', and 'r' indicate the type of each |
156 .. versionadded:: 0.6.0 |
146 .. versionadded:: 0.6.0 |
157 |
147 |
158 listaliases |
148 listaliases |
159 ----------- |
149 ----------- |
160 Syntax: |
150 Syntax: |
161 | **vmm listaliases** [*pattern*] |
151 | **vmm listaliases** [**-p** *pattern*] |
162 | **vmm la** [*pattern*] |
152 | **vmm la** [**-p** *pattern*] |
163 |
153 |
164 This command lists all defined aliases. Aliases belonging to alias-domains |
154 This command lists all defined aliases. Aliases belonging to alias-domains |
165 are prefixed with a '-', addresses of regular domains with a '+'. |
155 are prefixed with a '-', addresses of regular domains with a '+'. |
166 The output can be limited with an optional *pattern*. |
156 The output can be limited with an optional *pattern*. |
167 |
157 |
170 |
160 |
171 Example: |
161 Example: |
172 |
162 |
173 .. code-block:: console |
163 .. code-block:: console |
174 |
164 |
175 root@host:~# vmm listaliases example.com |
165 root@host:~# vmm listaliases -p example.com |
176 Matching aliases |
166 Matching aliases |
177 ---------------- |
167 ---------------- |
178 [+] support@example.com |
168 [+] support@example.com |
179 |
169 |
180 .. versionadded:: 0.6.0 |
170 .. versionadded:: 0.6.0 |
181 |
171 |
182 listdomains |
172 listdomains |
183 ----------- |
173 ----------- |
184 Syntax: |
174 Syntax: |
185 | **vmm listdomains** [*pattern*] |
175 | **vmm listdomains** [**-p** *pattern*] |
186 | **vmm ld** [*pattern*] |
176 | **vmm ld** [**-p** *pattern*] |
187 |
177 |
188 This subcommand lists all available domains. |
178 This subcommand lists all available domains. |
189 All domain names will be prefixed either with '[+]', if the domain is |
179 All domain names will be prefixed either with '[+]', if the domain is |
190 a primary domain, or with '[-]', if it is an alias domain name. |
180 a primary domain, or with '[-]', if it is an alias domain name. |
191 The output can be limited with an optional pattern. |
181 The output can be limited with an optional pattern. |
226 .. code-block:: console |
216 .. code-block:: console |
227 |
217 |
228 root@host:~# vmm listpwschemes |
218 root@host:~# vmm listpwschemes |
229 Usable password schemes |
219 Usable password schemes |
230 ----------------------- |
220 ----------------------- |
231 CRYPT SHA512-CRYPT LDAP-MD5 DIGEST-MD5 SHA256 SHA512 SSHA512 |
221 CLEARTEXT CRAM-MD5 CRYPT DIGEST-MD5 HMAC-MD5 LANMAN LDAP-MD5 MD5 |
232 SKEY SSHA NTLM RPA MD5-CRYPT HMAC-MD5 SHA1 PLAIN SHA CRAM-MD5 |
222 MD5-CRYPT NTLM OTP PLAIN PLAIN-MD4 PLAIN-MD5 RPA SHA SHA1 SHA256 |
233 SSHA256 MD5 LANMAN CLEARTEXT PLAIN-MD5 PLAIN-MD4 OTP SMD5 |
223 SHA256-CRYPT SHA512 SHA512-CRYPT SKEY SMD5 SSHA SSHA256 SSHA512 |
234 SHA256-CRYPT |
|
235 |
224 |
236 Usable encoding suffixes |
225 Usable encoding suffixes |
237 ------------------------ |
226 ------------------------ |
238 .B64 .BASE64 .HEX |
227 .B64 .BASE64 .HEX |
239 |
228 |
240 .. versionadded:: 0.6.0 |
229 .. versionadded:: 0.6.0 |
241 |
230 |
242 listrelocated |
231 listrelocated |
243 ------------- |
232 ------------- |
244 Syntax: |
233 Syntax: |
245 | **vmm listrelocated** [*pattern*] |
234 | **vmm listrelocated** [**-p** *pattern*] |
246 | **vmm lr** [*pattern*] |
235 | **vmm lr** [**-p** *pattern*] |
247 |
236 |
248 This command lists all defined relocated addresses. |
237 This command lists all defined relocated addresses. |
249 Relocated entries belonging to alias-domains are prefixed with a '-', |
238 Relocated entries belonging to alias-domains are prefixed with a '-', |
250 addresses of regular domains with a '+'. |
239 addresses of regular domains with a '+'. |
251 The output can be limited with an optional *pattern*. |
240 The output can be limited with an optional *pattern*. |
255 |
244 |
256 Example: |
245 Example: |
257 |
246 |
258 .. code-block:: console |
247 .. code-block:: console |
259 |
248 |
260 root@host:~# vmm listrelocated example.com |
249 root@host:~# vmm listrelocated -p example.com |
261 Matching relocated users |
250 Matching relocated users |
262 ------------------------ |
251 ------------------------ |
263 [+] b.user@example.com |
252 [+] b.user@example.com |
264 |
253 |
265 .. versionadded:: 0.6.0 |
254 .. versionadded:: 0.6.0 |
266 |
255 |
267 listusers |
256 listusers |
268 --------- |
257 --------- |
269 Syntax: |
258 Syntax: |
270 | **vmm listusers** [*pattern*] |
259 | **vmm listusers** [**-p** *pattern*] |
271 | **vmm lu** [*pattern*] |
260 | **vmm lu** [**-p** *pattern*] |
272 |
261 |
273 This command lists all user accounts. |
262 This command lists all user accounts. |
274 User accounts belonging to alias-domains are prefixed with a '-', addresses |
263 User accounts belonging to alias-domains are prefixed with a '-', addresses |
275 of regular domains with a '+'. |
264 of regular domains with a '+'. |
276 The output can be limited with an optional *pattern*. |
265 The output can be limited with an optional *pattern*. |
280 |
269 |
281 Example: |
270 Example: |
282 |
271 |
283 .. code-block:: console |
272 .. code-block:: console |
284 |
273 |
285 root@host:~# vmm listusers example.com |
274 root@host:~# vmm listusers -p example.com |
286 Matching user accounts |
275 Matching user accounts |
287 ---------------------- |
276 ---------------------- |
288 [+] a.user@example.com |
277 [+] a.user@example.com |
289 [+] d.user@example.com |
278 [+] d.user@example.com |
290 [+] john.doe@example.com |
279 [+] john.doe@example.com |
291 [+] postmaster@example.com |
280 [+] postmaster@example.com |
292 |
281 |
293 .. versionadded:: 0.6.0 |
282 .. versionadded:: 0.6.0 |
294 |
|
295 version |
|
296 ------- |
|
297 Syntax: |
|
298 | **vmm version** |
|
299 | **vmm v** |
|
300 |
|
301 Prints :command:`vmm`'s version and copyright information to stdout. |
|
302 After this :command:`vmm` exits. |
|