1 .TH "VMM" "1" "17 Aug 2009" "Pascal Volk" |
1 .TH "VMM" "1" "2011-02-21" "vmm 0.6" "vmm" |
2 .SH NAME |
2 .SH NAME |
3 vmm \- command line tool to manage email domains/accounts/aliases |
3 vmm \- command line tool to manage email domains/accounts/aliases |
|
4 .\" ----------------------------------------------------------------------- |
4 .SH SYNOPSIS |
5 .SH SYNOPSIS |
5 .B vmm |
6 .B vmm |
6 \fIsubcommand\fP \fIobject\fP [ \fIargs\fP ] |
7 .IR subcommand " [" "argument ..." ] |
|
8 .\" ----------------------------------------------------------------------- |
7 .SH DESCRIPTION |
9 .SH DESCRIPTION |
8 \fBvmm\fP (Virtual Mail Manager) is a command line tool for |
10 .B vmm |
9 administrators/postmasters to manage domains, accounts and aliases. It's |
11 (a virtual mail manager) is the easy to use command line tool for |
10 designed for Dovecot and Postfix with a PostgreSQL backend. |
12 administrators and postmasters to manage (alias) domains, accounts, aliases |
11 .SH SUBCOMMANDS |
13 and relocated users. |
12 Each subcommand has both a long and a short form. Both forms are case sensitive. |
14 It allows you to simply and quickly administer your mail server. |
13 .SS GENERAL SUBCOMMANDS |
15 .br |
14 .TP |
16 It\(aqs designed for Dovecot and Postfix with a PostgreSQL backend. |
15 \fBconfigure\fP (\fBcf\fP) [ \fIsection\fP ] |
17 .PP |
|
18 Each |
|
19 .I subcommand |
|
20 has both a long and a short form. |
|
21 The short form is shown enclosed in parentheses. |
|
22 Both forms are case sensitive. |
|
23 .PP |
|
24 Most of the |
|
25 .IR subcommand s |
|
26 take one or more |
|
27 .IR argument s. |
|
28 .\" ----------------------------------------------------------------------- |
|
29 .SH ARGUMENTS |
|
30 .TP 12 |
|
31 .I address |
|
32 The complete e\-mail address |
|
33 .RI ( local\-part @ fqdn ) |
|
34 of an user account, alias address or relocated user. |
|
35 .\" -------------------------- |
|
36 .TP |
|
37 .I destination |
|
38 Is either an e\-mail |
|
39 .I address |
|
40 when used with |
|
41 .IR "ALIAS SUBCOMMANDS" . |
|
42 Or a |
|
43 .I fqdn |
|
44 when used with |
|
45 .IR "ALIASDOMAIN SUBCOMMANDS" . |
|
46 .\" -------------------------- |
|
47 .TP |
|
48 .I fqdn |
|
49 The fully qualified domain name \- without the trailing dot \- of a domain |
|
50 or alias domain. |
|
51 .\" -------------------------- |
|
52 .TP |
|
53 .I messages |
|
54 An integer value which specifies a quota limit in number of messages. |
|
55 .B 0 |
|
56 (zero) means unlimited \- no quota limit for the number of messages. |
|
57 .\" -------------------------- |
|
58 .TP |
|
59 .I option |
|
60 is the name of a configuration option, prefixed with the section name and a |
|
61 dot. |
|
62 For example: |
|
63 .IB misc . transport |
|
64 .br |
|
65 All configuration options are described in |
|
66 .BR vmm.cfg (5). |
|
67 .\" -------------------------- |
|
68 .TP |
|
69 .I service |
|
70 The name of a service, commonly used with Dovecot. |
|
71 Supported services are: |
|
72 .BR imap ", " pop3 ", " sieve " and " smtp . |
|
73 .\" -------------------------- |
|
74 .TP |
|
75 .I storage |
|
76 Specifies a quota limit in bytes. |
|
77 One of the following prefixes can be appended to the integer value: |
|
78 .BR b " (bytes), " k " (kilobytes), " M " (megabytes) or " G |
|
79 (gigabytes). |
|
80 .B 0 |
|
81 (zero) means unlimited \- no quota limit in bytes. |
|
82 .\" -------------------------- |
|
83 .TP |
|
84 .I transport |
|
85 A transport for Postfix, written as: |
|
86 .IB transport : |
|
87 or |
|
88 .IB transport :\c |
|
89 .IR nexthop . |
|
90 See |
|
91 .BR transport (5) |
|
92 for more details. |
|
93 .\" ----------------------------------------------------------------------- |
|
94 .SH GENERAL SUBCOMMANDS |
|
95 .SS configget (cg) |
|
96 .BI "vmm configget" " option" |
|
97 .PP |
|
98 This subcommand is used to display the actual value of the given |
|
99 configuration |
|
100 .IR option . |
|
101 .PP |
|
102 Example: |
|
103 .PP |
|
104 .nf |
|
105 .B vmm configget misc.crypt_sha512_rounds |
|
106 misc.crypt_sha512_rounds = 5000 |
|
107 .fi |
|
108 .\" ------------------------------------ |
|
109 .SS configset (cs) |
|
110 .B vmm configset |
|
111 .I option value |
|
112 .PP |
|
113 Use this subcommand to set or update a single configuration option\(aqs |
|
114 value. |
|
115 .I option |
|
116 is the configuration option, |
|
117 .I value |
|
118 is the |
|
119 .IR option \(aqs |
|
120 new value. |
|
121 .IP Note: |
|
122 This subcommand will create a new |
|
123 .I vmm.cfg |
|
124 without any comments. |
|
125 Your current configuration file will be backed as |
|
126 .IR vmm.cfg.bak . |
|
127 .PP |
|
128 Example: |
|
129 .PP |
|
130 .nf |
|
131 .B vmm configget misc.transport |
|
132 misc.transport = dovecot: |
|
133 .B vmm configset misc.transport lmtp:unix:private/dovecot\-lmtp |
|
134 .B vmm cg misc.transport |
|
135 misc.transport = lmtp:unix:private/dovecot\-lmtp |
|
136 .fi |
|
137 .\" ------------------------------------ |
|
138 .SS configure (cf) |
|
139 .B vmm configure |
|
140 .RI [ section ] |
|
141 .PP |
16 Starts the interactive configuration for all configuration sections. |
142 Starts the interactive configuration for all configuration sections. |
17 .br |
143 .PP |
18 If the optional argument \fIsection\fP is given, only the configuration options |
144 In this process the currently set value of each option will be displayed in |
19 from the given section will be displayed and will be configurable. The following |
145 square brackets. |
20 sections are available: |
146 If no value is configured, the default value of each option will be |
|
147 displayed in square brackets. |
|
148 Press the return key, to accept the displayed value. |
|
149 .PP |
|
150 If the optional argument |
|
151 .I section |
|
152 is given, only the configuration options from the given section will be |
|
153 displayed and will be configurable. |
|
154 The following sections are available: |
21 .RS |
155 .RS |
22 .PD 0 |
156 .TP 10 |
23 .TP |
157 .B account |
24 - |
158 Account settings |
25 .B |
159 .TP |
26 database |
160 .B bin |
27 .TP |
161 Paths to external binaries |
28 - |
162 .TP |
29 .B |
163 .B database |
30 maildir |
164 Database settings |
31 .TP |
165 .TP |
32 - |
166 .B domain |
33 .B |
167 Domain settings |
34 services |
168 .TP |
35 .TP |
169 .B mailbox |
36 - |
170 Mailbox settings |
37 .B |
171 .TP |
38 domdir |
172 .B misc |
39 .TP |
173 Miscellaneous settings |
40 - |
|
41 .B |
|
42 bin |
|
43 .TP |
|
44 - |
|
45 .B |
|
46 misc |
|
47 .PD |
|
48 .RE |
174 .RE |
49 .LP |
175 .PP |
50 .PP |
176 All configuration options are described in |
51 .nf |
177 .BR vmm.cfg (5). |
52 Example: |
178 .IP Note: |
|
179 This subcommand will create a new |
|
180 .I vmm.cfg |
|
181 without any comments. |
|
182 Your current configuration file will be backed as |
|
183 .IR vmm.cfg.bak . |
|
184 .PP |
|
185 Example: |
|
186 .PP |
|
187 .nf |
|
188 .B vmm configure mailbox |
|
189 Using configuration file: /usr/local/etc/vmm.cfg |
53 |
190 |
54 \fBvmm configure services\fP |
191 * Configuration section: \(aqmailbox\(aq |
55 Using configuration file: /usr/local/etc/vmm.cfg |
192 Enter new value for option folders [Drafts:Sent:Templates:Trash]: |
56 |
193 Enter new value for option format [maildir]: mdbox |
57 * Config section: “services” |
194 Enter new value for option subscribe [True]: |
58 Enter new value for option pop3 [True]: |
195 Enter new value for option root [Maildir]: mdbox |
59 Enter new value for option smtp [True]: |
196 .fi |
60 Enter new value for option imap [True]: |
197 .\" ------------------------------------ |
61 Enter new value for option sieve [True]: false |
198 .SS getuser (gu) |
62 .fi |
199 .BI "vmm getuser" " uid" |
63 .PP |
200 .PP |
64 .TP |
201 If only the |
65 \fBgetuser\fP (\fBgu\fP) \fIuserid\fP |
202 .I uid |
66 If only the userid is available, for example from process list, the subcommand |
203 is available, for example from process list, the subcommand |
67 \fBgetuser\fP will show the user's address. |
204 .B getuser |
68 .PP |
205 will show the user\(aqs address. |
69 .nf |
206 .PP |
70 Example: |
207 Example: |
71 |
208 .PP |
72 \fBvmm getuser 70004\fP |
209 .nf |
73 Account information |
210 .B vmm getuser 70772 |
74 ------------------- |
211 Account information |
75 UID............: 70004 |
212 ------------------- |
76 GID............: 70000 |
213 UID............: 70772 |
77 Address........: c.user@example.com |
214 GID............: 70312 |
78 .fi |
215 Address........: a.user@example.com |
79 .\" |
216 .fi |
80 .TP |
217 .\" ------------------------------------ |
81 \fBlistdomains\fP (\fBld\fP) [ \fIpattern\fP ] |
218 .SS help (h) |
82 This subcommand lists all available domains. All domain names will be prefixed |
219 .B vmm help |
83 either with '[+]', if the domain is a primary domain, or with '[-]', if it is |
220 .RI [ subcommand ] |
84 an alias domain name. The output can be limited with an optional \fIpattern\fP. |
221 .PP |
85 .br |
222 Prints a list of available subcommands with a short description to stdout. |
86 To perform a wild card search, the % character can be used at the start and/or |
223 When a |
87 the end of the \fIpattern\fP. |
224 .I subcommand |
88 .PP |
225 was given, help for that |
89 .nf |
226 .I subcommand |
90 Example: |
227 will be displayed. |
91 |
228 After this |
92 \fBvmm listdomains %example%\fP |
229 .B vmm |
93 Matching domains |
230 exits. |
94 ---------------- |
231 .\" ------------------------------------ |
95 [+] example.com |
232 .SS listdomains (ld) |
96 [-] e.g.example.com |
233 .B vmm listdomains |
97 [-] example.name |
234 .RI [ pattern ] |
98 [+] example.net |
235 .PP |
99 [+] example.org |
236 This subcommand lists all available domains. |
100 .fi |
237 All domain names will be prefixed either with `[+]\(aq, if the domain is a |
101 .\" |
238 primary domain, or with `[-]\(aq, if it is an alias domain name. |
102 .TP |
239 The output can be limited with an optional |
103 \fBhelp\fP (\fBh\fP) |
240 .IR pattern . |
104 Prints all available commands to stdout. After this \fBvmm\fP exits. |
241 .PP |
105 .TP |
242 To perform a wild card search, the % character can be used at the start |
106 \fBversion\fP (\fBv\fP) |
243 and/or the end of the |
107 Prints the version information from \fBvmm\fP. |
244 .IR pattern . |
108 .\" |
245 .PP |
109 .SS DOMAIN SUBCOMMANDS |
246 Example: |
110 .TP |
247 .PP |
111 \fBdomainadd\fP (\fBda\fP) \fIdomain\fP [ \fItransport\fP ] |
248 .nf |
112 Adds the new \fIdomain\fP into the database. |
249 .B vmm listdomains %example% |
113 .br |
250 Matching domains |
114 If the optional argument \fItransport\fP is given, it will overwrite the |
251 ---------------- |
115 default transport from \fBvmm.cfg\fP (misc/transport). The specified transport |
252 [+] example.com |
|
253 [\-] e.g.example.com |
|
254 [\-] example.name |
|
255 [+] example.net |
|
256 [+] example.org |
|
257 .fi |
|
258 .\" ------------------------------------ |
|
259 .SS version (v) |
|
260 .B vmm version |
|
261 .PP |
|
262 Prints |
|
263 .BR vmm \(aqs |
|
264 version and copyright information to stdout. |
|
265 After this |
|
266 .B vmm |
|
267 exits. |
|
268 .\" ----------------------------------------------------------------------- |
|
269 .SH DOMAIN SUBCOMMANDS |
|
270 .SS domainadd (da) |
|
271 .B vmm domainadd |
|
272 .IR fqdn " [" transport ] |
|
273 .PP |
|
274 Adds the new domain into the database and creates the domain directory. |
|
275 .PP |
|
276 If the optional argument |
|
277 .I transport |
|
278 is given, it will override the default transport |
|
279 .RI ( misc.transport ") from " vmm.cfg . |
|
280 The specified |
|
281 .I transport |
116 will be the default transport for all new accounts in this domain. |
282 will be the default transport for all new accounts in this domain. |
117 .PP |
283 .PP |
118 .nf |
284 Configuration\-related behavior: |
119 Examples: |
|
120 |
|
121 \fBvmm domainadd support.example.com smtp:mx1.example.com |
|
122 vmm domainadd sales.example.com\fP |
|
123 .fi |
|
124 .TP |
|
125 \fBdomaininfo\fP (\fBdi\fP) \fIdomain\fP [ \fIdetails\fP ] |
|
126 This subcommand shows some information about the given \fIdomain\fP. |
|
127 .br |
|
128 For a more detailed information about the \fIdomain\fP the optional argument |
|
129 \fIdetails\fP can be specified. A possible \fIdetails\fP value may be one of |
|
130 the following five keywords: |
|
131 .RS |
285 .RS |
132 .PD 0 |
286 .TP |
133 .TP |
287 .I domain.auto_postmaster |
|
288 When that option is set to |
|
289 .BR true " (default) " vmm |
|
290 will automatically create the postmaster account for the new domain and |
|
291 prompt for |
|
292 .BI postmaster@ fqdn\c |
|
293 \(aqs password. |
|
294 .TP |
|
295 .I account.random_password |
|
296 When the value of that option is also set to |
|
297 .BR true ", " vmm |
|
298 will automatically create the postmaster account for the new domain and |
|
299 print the generated postmaster password to stdout. |
|
300 .RE |
|
301 .PP |
|
302 Examples: |
|
303 .PP |
|
304 .nf |
|
305 .B vmm domainadd support.example.com smtp:[mx1.example.com]:2025 |
|
306 Enter new password: |
|
307 Retype new password: |
|
308 .B vmm cs account.random_password true |
|
309 .B vmm domainadd sales.example.com |
|
310 Generated password: hHu8DeTC |
|
311 .fi |
|
312 .\" ------------------------------------ |
|
313 .SS domaindelete (dd) |
|
314 .BI "vmm domaindelete " fqdn |
|
315 .RB [ force ] |
|
316 .PP |
|
317 This subcommand deletes the domain specified by |
|
318 .IR fqdn . |
|
319 .PP |
|
320 If there are accounts, aliases and/or relocated users assigned to the given |
|
321 domain, |
|
322 .B vmm |
|
323 will abort the requested operation and show an error message. |
|
324 If you know, what you are doing, you can specify the optional keyword |
|
325 .BR force . |
|
326 .PP |
|
327 If you really always know what you are doing, edit your |
|
328 .I vmm.cfg |
|
329 and set the option |
|
330 .I domain.force_deletion |
|
331 to |
|
332 .BR true . |
|
333 .\" ------------------------------------ |
|
334 .SS domaininfo (di) |
|
335 .B vmm domaininfo |
|
336 .IR fqdn \ [ details ] |
|
337 .PP |
|
338 This subcommand shows some information about the given domain. |
|
339 .PP |
|
340 For a more detailed information about the domain the optional argument |
|
341 .I details |
|
342 can be specified. |
|
343 A possible |
|
344 .I details |
|
345 value can be one of the following five keywords: |
|
346 .RS |
|
347 .TP 14 |
134 .B accounts |
348 .B accounts |
135 to list all existing accounts |
349 to list the e\-mail addresses of all existing user accounts |
136 .TP |
350 .TP |
137 .B aliasdomains |
351 .B aliasdomains |
138 to list all assigned alias domains |
352 to list all assigned alias domain names |
139 .TP |
353 .TP |
140 .B aliases |
354 .B aliases |
141 to list all available aliases addresses |
355 to list all available alias e\-mail addresses |
142 .TP |
356 .TP |
143 .B relocated |
357 .B relocated |
144 to list all relocated users |
358 to list the e\-mail addresses of all relocated users |
145 .TP |
359 .TP |
146 .B full |
360 .B full |
147 to list all information mentioned above |
361 to list all information mentioned above |
148 .PD |
|
149 .RE |
362 .RE |
150 .LP |
363 .PP |
151 .nf |
364 Example: |
152 Example: |
365 .PP |
153 |
366 .nf |
154 \fBvmm domaininfo sales.example.com\fP |
367 .B vmm domaininfo sales.example.com |
155 Domain information |
368 Domain information |
156 ------------------ |
369 ------------------ |
157 Domainname.....: sales.example.com |
370 Domainname.....: sales.example.com |
158 GID............: 70002 |
371 GID............: 70693 |
159 Transport......: dovecot: |
372 Transport......: dovecot: |
160 Domaindir......: /home/mail/5/70002 |
373 Domaindir......: /home/mail/v/70693 |
161 Aliasdomains...: 0 |
374 Quota Limit....: Storage: 0 Messages 0 |
162 Accounts.......: 0 |
375 Aliasdomains...: 0 |
163 Aliases........: 0 |
376 Accounts.......: 1 |
164 Relocated......: 0 |
377 Aliases........: 0 |
165 |
378 Relocated......: 0 |
166 .fi |
379 .fi |
167 .TP |
380 .\" ------------------------------------ |
168 \fBdomaintransport\fP (\fBdt\fP) \fIdomain\fP \fItransport\fP [ \fIforce\fP ] |
381 .SS domainquota (dq) |
|
382 .B vmm domainquota |
|
383 .IR "fqdn storage" " [" messages ] |
|
384 .RB [ force ] |
|
385 .PP |
|
386 This subcommand is used to configure a new quota limit for the accounts of |
|
387 the domain - not for the domain itself. |
|
388 .PP |
|
389 The default quota limit for accounts is defined in the |
|
390 .IR vmm.cfg " (" misc.quota_bytes " and " misc.quota_messages ). |
|
391 The new quota limit will be applied to all newly created accounts. |
|
392 If you want to apply the new quota limit also to existing accounts, you |
|
393 have to give the optional keyword |
|
394 .BR force . |
|
395 .br |
|
396 When the argument |
|
397 .I messages |
|
398 was omitted the default number of messages |
|
399 .B 0 |
|
400 (zero) will be applied. |
|
401 .PP |
|
402 Example: |
|
403 .PP |
|
404 .nf |
|
405 .B vmm domainquota example.com 1g force |
|
406 .fi |
|
407 .\" ------------------------------------ |
|
408 .SS domaintransport (dt) |
|
409 .BI "vmm domaintransport" " fqdn transport" |
|
410 .RB [ force ] |
|
411 .PP |
169 A new transport for the indicated domain can be set with this subcommand. |
412 A new transport for the indicated domain can be set with this subcommand. |
|
413 .PP |
|
414 If the optional keyword |
|
415 .B force |
|
416 is given all account specific transport settings will be also updated. |
|
417 Otherwise this setting will affect only new created accounts. |
|
418 .PP |
|
419 Example: |
|
420 .PP |
|
421 .nf |
|
422 .B vmm domaintransport support.example.com dovecot: |
|
423 .fi |
|
424 .\" ----------------------------------------------------------------------- |
|
425 .SH ALIAS DOMAIN SUBCOMMANDS |
|
426 An alias domain is an alias for a domain that was previously added with the |
|
427 subcommand |
|
428 .BR domainadd . |
|
429 All accounts, aliases and relocated users from the domain will be also |
|
430 available in the alias domain. |
170 .br |
431 .br |
171 If the additional keyword '\fBforce\fP' is given all account specific transport |
432 In the following is to be assumed that example.name is an alias for |
172 settings will be overwritten. |
433 example.com. |
|
434 .PP |
|
435 Postfix will not accept erroneously e\-mails for unknown.user@example.name |
|
436 and bounce them back later to the mostly faked sender. |
|
437 Postfix will immediately reject all e\-mails addressed to nonexistent |
|
438 users. |
173 .br |
439 .br |
174 Otherwise this setting will affect only new created accounts. |
440 This behavior is ensured as long as you use the recommended database |
175 .PP |
441 queries in your |
176 .nf |
442 .I $config_directory/pgsql\-*.cf |
177 Example: |
443 configuration files. |
178 |
444 .\" ------------------------------------ |
179 \fBvmm domaintransport support.example.com dovecot:\fP |
445 .SS aliasdomainadd (ada) |
180 .fi |
446 .BI "vmm aliasdomainadd" " fqdn destination" |
181 .TP |
447 .PP |
182 \fBdomaindelete\fP (\fBdd\fP) \fIdomain\fP [ \fIdelalias\fP | \fIdeluser\fP | \fIdelall\fP ] |
448 This subcommand adds the new alias domain |
183 This subcommand deletes the specified \fIdomain\fP. |
449 .RI ( fqdn ) |
184 .br |
450 to the |
185 If there are accounts and/or aliases assigned to the given domain, \fBvmm\fP |
451 .I destination |
186 will abort the requested operation and show an error message. If you know, what |
452 domain that should be aliased. |
187 you are doing, you can specify one of the following keywords: '\fBdelalias\fP', '\fBdeluser\fP' or '\fBdelall\fP'. |
453 .PP |
188 .br |
454 Example: |
189 |
455 .PP |
190 If you really always know what you are doing, edit your \fBvmm.cfg\fP and set |
456 .nf |
191 the option \fIforcedel\fP, in section \fImisc\fP, to true. |
457 .B vmm aliasdomainadd example.name example.com |
192 .\" |
458 .fi |
193 .SS ALIAS DOMAIN SUBCOMMANDS |
459 .\" ------------------------------------ |
194 .TP |
460 .SS aliasdomaindelete (add) |
195 \fBaliasdomainaddd\fP (\fBada\fP) \fIaliasdomain\fP \fItargetdomain\fP |
461 .BI "vmm aliasdomaindelete" " fqdn" |
196 This subcommand adds the new \fIaliasdomain\fP to the \fItargetdomain\fP that |
462 .PP |
197 should be aliased. |
463 Use this subcommand if the alias domain |
198 .PP |
464 .I fqdn |
199 .nf |
465 should be removed. |
200 Example: |
466 .PP |
201 |
467 Example: |
202 \fBvmm aliasdomainadd example.name example.com\fP |
468 .PP |
203 .fi |
469 .nf |
204 .TP |
470 .B vmm aliasdomaindelete e.g.example.com |
205 \fBaliasdomaininfo (\fBadi\fP) \fIaliasdomain\fP |
471 .fi |
206 This subcommand shows to which domain the \fIaliasdomain\fP is assigned to. |
472 .\" ------------------------------------ |
207 .PP |
473 .SS aliasdomaininfo (adi) |
208 .nf |
474 .BI "vmm aliasdomaininfo" " fqdn" |
209 Example: |
475 .PP |
210 |
476 This subcommand shows to which domain the alias domain |
211 \fBvmm aliasdomaininfo example.name\fP |
477 .I fqdn |
212 Alias domain information |
478 is assigned to. |
213 ------------------------ |
479 .PP |
214 The alias domain example.name belongs to: |
480 Example: |
215 * example.com |
481 .PP |
216 .fi |
482 .nf |
217 .TP |
483 .B vmm adi example.name |
218 \fBaliasdomainswitch\fP (\fBads\fP) \fIaliasdomain\fP \fItargetdomain\fP |
484 Alias domain information |
219 If the target of the existing \fIaliasdomain\fP should be switched to another |
485 ------------------------ |
220 \fItargetdomain\fP use this subcommand. |
486 The alias domain example.name belongs to: |
221 .PP |
487 * example.com |
222 .nf |
488 .fi |
223 Example: |
489 .\" ------------------------------------ |
224 |
490 .SS aliasdomainswitch (ads) |
225 \fBvmm aliasdomainswitch example.name example.org\fP |
491 .BI "vmm aliasdomainswitch" " fqdn destination" |
226 .fi |
492 .PP |
227 .TP |
493 If the destination of the existing alias domain |
228 \fBaliasdomaindelete\fP (\fBadd\fP) \fIaliasdomain\fP |
494 .I fqdn |
229 Use this subcommand if the alias domain \fIaliasdomain\fP should be removed. |
495 should be switched to another |
230 .PP |
496 .I destination |
231 .nf |
497 use this subcommand. |
232 Example: |
498 .nf |
233 |
499 .PP |
234 \fBvmm aliasdomaindelete e.g.example.com\fP |
500 Example: |
235 .fi |
501 .PP |
236 .\" |
502 .B vmm aliasdomainswitch example.name example.org |
237 .SS ACCOUNT SUBCOMMANDS |
503 .fi |
238 .TP |
504 .\" ----------------------------------------------------------------------- |
239 \fBuseradd\fP (\fBua\fP) \fIaddress\fP [ \fIpassword\fP ] |
505 .SH ACCOUNT SUBCOMMANDS |
240 Use this subcommand to create a new email account for the given \fIaddress\fP. |
506 .SS useradd (ua) |
241 .br |
507 .B vmm useradd |
242 If the \fIpassword\fP is not provided, \fBvmm\fP will prompt for it |
508 .IR address " [" password ] |
243 interactively. |
509 .PP |
244 .PP |
510 Use this subcommand to create a new e\-mail account for the given |
245 .nf |
511 .IR address . |
246 Examples: |
512 .PP |
247 |
513 If the |
248 \fBvmm ua d.user@example.com 'A 5ecR3t P4s5\\/\\/0rd'\fP |
514 .I password |
249 \fBvmm ua e.user@example.com\fP |
515 is not provided, |
250 Enter new password: |
516 .B vmm |
251 Retype new password: |
517 will prompt for it interactively. |
252 .fi |
518 When no |
253 .TP |
519 .I password |
254 \fBuserinfo\fP (\fBui\fP) \fIaddress\fP [ \fIdetails\fP ] |
520 is provided and |
|
521 .I account.random_password |
|
522 is set to |
|
523 .BR true ", " vmm |
|
524 will generate a random password and print it to stdout after the account |
|
525 has been created. |
|
526 .PP |
|
527 Examples: |
|
528 .PP |
|
529 .nf |
|
530 .B vmm ua d.user@example.com \(aqA 5ecR3t P4s5\(rs/\(rs/0rd\(aq |
|
531 .B vmm useradd e.user@example.com |
|
532 Enter new password: |
|
533 Retype new password: |
|
534 .fi |
|
535 .\" ------------------------------------ |
|
536 .SS userdelete (ud) |
|
537 .BI "vmm userdelete" " address" |
|
538 .RB [ force ] |
|
539 .PP |
|
540 Use this subcommand to delete the account with the given |
|
541 .IR address . |
|
542 .PP |
|
543 If there are one or more aliases with an identical destination address, |
|
544 .B vmm |
|
545 will abort the requested operation and show an error message. |
|
546 To prevent this, specify the optional keyword |
|
547 .BR force . |
|
548 .\" ------------------------------------ |
|
549 .SS userdisable (u0) |
|
550 .BI "vmm userdisable" " address" |
|
551 .RI [ "service ..." ] |
|
552 .PP |
|
553 If a user should not be able to access one or more services you can |
|
554 restrict the user\(aqs access with this subcommand. |
|
555 .PP |
|
556 If no |
|
557 .I service |
|
558 was given all services |
|
559 .RB ( imap ", " pop3 ", " sieve " and " smtp ) |
|
560 will be disabled for the account with the specified |
|
561 .IR address . |
|
562 Otherwise only the specified |
|
563 .IR service (s) |
|
564 will be restricted. |
|
565 .PP |
|
566 Examples: |
|
567 .PP |
|
568 .nf |
|
569 .B vmm u0 b.user@example.com imap pop3 |
|
570 .B vmm userdisable c.user@example.com |
|
571 .fi |
|
572 .\" ------------------------------------ |
|
573 .SS userenable (u1) |
|
574 .BI "vmm userenable" " address" |
|
575 .RI [ "service ..." ] |
|
576 .PP |
|
577 To allow access to one or more restricted |
|
578 .IR service (s) |
|
579 use this subcommand. |
|
580 .PP |
|
581 If no |
|
582 .I service |
|
583 was given all services |
|
584 .RB ( imap ", " pop3 ", " sieve " and " smtp ) |
|
585 will be enabled for the account with the specified |
|
586 .IR address . |
|
587 Otherwise only the specified |
|
588 .IR service (s) |
|
589 will be enabled. |
|
590 .\" ------------------------------------ |
|
591 .SS userinfo (ui) |
|
592 .B "vmm userinfo" |
|
593 .IR address " [" details ] |
|
594 .PP |
255 This subcommand displays some information about the account specified by |
595 This subcommand displays some information about the account specified by |
256 \fIaddress\fP. |
596 .IR address . |
257 .br |
597 .PP |
258 If the optional argument \fIdetails\fP is given some more information will be |
598 If the optional argument |
259 displayed. |
599 .I details |
260 .br |
600 is given some more information will be displayed. |
261 Possible values for \fIdetails\fP are: |
601 Possible values for |
|
602 .I details |
|
603 are: |
262 .RS |
604 .RS |
263 .PD 0 |
605 .TP 8 |
264 .TP |
|
265 .B aliases |
606 .B aliases |
266 to list all alias addresses with the destination \fIaddress\fP |
607 to list all alias addresses with the destination |
|
608 .I address |
267 .TP |
609 .TP |
268 .B du |
610 .B du |
269 to display the disk usage of users maildir |
611 to display the disk usage of the user\(aqs mail directory. |
|
612 In order to summarize the disk usage each time the this subcommand is |
|
613 executed automatically, set |
|
614 .I account.disk_usage |
|
615 in your |
|
616 .I vmm.cfg |
|
617 to |
|
618 .BR true . |
270 .TP |
619 .TP |
271 .B full |
620 .B full |
272 to list all information mentioned above |
621 to list all information mentioned above |
273 .PD |
622 .PP |
274 .RE |
623 Example: |
275 .LP |
624 .PP |
276 .TP |
625 .nf |
277 \fBusername\fP (\fBun\fP) \fIaddress\fP \fI'Users Name'\fP |
626 .B vmm ui d.user@example.com |
278 The user's real name can be set/updated with this subcommand. |
627 Account information |
279 .PP |
628 ------------------- |
280 .nf |
629 Address........: d.user@example.com |
281 Example: |
630 Name...........: None |
282 |
631 UID............: 79839 |
283 \fBvmm un d.user@example.com 'John Doe'\fP |
632 GID............: 70312 |
284 .fi |
633 Home...........: /srv/mail/8/70312/79839 |
285 .TP |
634 Mail_Location..: mdbox:~/mdbox |
286 \fBuserpassword\fP (\fBup\fP) \fIaddress\fP [ \fIpassword\fP ] |
635 Quota Storage..: [ 0.00%] 0/1.00 GiB |
287 The \fIpassword\fP from an account can be updated with this subcommand. |
636 Quota Messages.: [ 0.00%] 0/0 |
|
637 Transport......: dovecot: |
|
638 SMTP...........: enabled |
|
639 POP3...........: enabled |
|
640 IMAP...........: enabled |
|
641 SIEVE..........: enabled |
|
642 .fi |
|
643 .\" ------------------------------------ |
|
644 .SS username (un) |
|
645 .BI "vmm username" " address name" |
|
646 .PP |
|
647 The user\(aqs real |
|
648 .I name |
|
649 can be set/updated with this subcommand. |
|
650 .PP |
|
651 Example: |
|
652 .PP |
|
653 .nf |
|
654 .B vmm un d.user@example.com \(dqJohn Doe\(dq |
|
655 .fi |
|
656 .\" ------------------------------------ |
|
657 .SS userpassword (up) |
|
658 .BI "vmm userpassword" " address" |
|
659 .RI [ password ] |
|
660 .PP |
|
661 The password of an account can be updated with this subcommand. |
|
662 .PP |
|
663 If no |
|
664 .I password |
|
665 was provided, |
|
666 .B vmm |
|
667 will prompt for it interactively. |
|
668 .PP |
|
669 Example: |
|
670 .PP |
|
671 .nf |
|
672 .B vmm up d.user@example.com \(aqA |\(rs/|0r3 5ecur3 P4s5\(rs/\(rs/0rd?\(aq |
|
673 .fi |
|
674 .\" ------------------------------------ |
|
675 .SS userquota (uq) |
|
676 .BI "vmm userquota" " address storage" |
|
677 .RI [ messages ] |
|
678 .PP |
|
679 This subcommand is used to set a new quota limit for the given account. |
|
680 .PP |
|
681 When the argument |
|
682 .I messages |
|
683 was omitted the default number of messages |
|
684 .B 0 |
|
685 (zero) will be applied. |
|
686 .PP |
|
687 Example: |
|
688 .PP |
|
689 .nf |
|
690 .B vmm userquota d.user@example.com 750m |
|
691 .fi |
|
692 .\" ------------------------------------ |
|
693 .SS usertransport (ut) |
|
694 .BI "vmm usertransport" " address transport" |
|
695 .PP |
|
696 A different |
|
697 .I transport |
|
698 for an account can be specified with this subcommand. |
|
699 .PP |
|
700 Example: |
288 .br |
701 .br |
289 If the \fIpassword\fP is not provided, \fBvmm\fP will prompt for it |
702 Assumed you want to use Dovecot\(aqs |
290 interactively. |
703 .BR dsync (1) |
291 .PP |
704 to convert a user\(aqs mailbox from Maildir format to mdbox format, you |
292 .nf |
705 can tell Postfix to retry later. |
293 Example: |
706 .PP |
294 |
707 .nf |
295 \fBvmm up d.user@example.com 'A |\\/|0r3 5ecur3 P4s5\\/\\/0rd?'\fP |
708 .B vmm ut d.user@example.com \(dqretry:4.0.0 Mailbox being migrated\(dq |
296 .fi |
709 # convert the mailbox ... then set the transport to Dovecot\(aqs lmtp |
297 .TP |
710 .B vmm ut d.user@example.com lmtp:unix:private/dovecot\-lmtp |
298 \fBusertransport\fP (\fBut\fP) \fIaddress\fP \fItransport\fP |
711 .fi |
299 A different transport for an account can be specified with this subcommand. |
712 .\" ----------------------------------------------------------------------- |
300 .PP |
713 .SH ALIAS SUBCOMMANDS |
301 .nf |
714 .SS aliasadd (aa) |
302 Example: |
715 .BI "vmm aliasadd" " address destination ..." |
303 |
716 .PP |
304 \fBvmm ut d.user@example.com smtp:pc105.it.example.com\fP |
717 This subcommand is used to create a new alias |
305 .fi |
718 .I address |
306 .TP |
719 with one or more |
307 \fBuserdisable\fP (\fBu0\fP) \fIaddress\fP [ \fIservice\fP ] |
720 .I destination |
308 If a user shouldn't have access to one or all services you can restrict the |
721 addresses. |
309 access with this subcommand. |
722 .PP |
310 .br |
723 Examples: |
311 If neither a \fIservice\fP nor the keyword '\fIall\fP' is given all services |
724 .PP |
312 (\fIsmtp\fP, \fIpop3\fP, \fIimap\fP, and \fIsieve\fP) will be disabled for the |
725 .nf |
313 account with the specified \fIaddress\fP. Otherwise only the specified |
726 .B vmm aliasadd john.doe@example.com d.user@example.com |
314 \fIservice\fP will be restricted. |
727 .B vmm aa support@example.com d.user@example.com e.user@example.com |
315 .PP |
728 .fi |
316 .nf |
729 .\" ------------------------------------ |
317 Examples: |
730 .SS aliasdelete (ad) |
318 |
731 .BI "vmm aliasdelete" " address" |
319 \fBvmm u0 b.user@example.com imap\fP |
732 .RI [ destination ] |
320 \fBvmm userdisable c.user@example.com\fP |
733 .PP |
321 .fi |
734 Use this subcommand to delete the alias with the given |
322 .TP |
735 .IR address . |
323 \fBuserenable\fP (\fBu1\fP) \fIaddress\fP [ \fIservice\fP ] |
736 .PP |
324 To allow access to one or all restricted services use this subcommand. |
737 If the optional |
325 .br |
738 .I destination |
326 If neither a \fIservice\fP nor the keyword '\fIall\fP' is given all services |
739 address is given, only this |
327 (\fIsmtp\fP, \fIpop3\fP, \fIimap\fP, and \fIsieve\fP) will be enabled for the |
740 destination will be removed from the alias. |
328 account with the specified \fIaddress\fP. Otherwise only the specified |
741 .PP |
329 \fIservice\fP will be enabled. |
742 Example: |
330 .PP |
743 .PP |
331 .TP |
744 .nf |
332 \fBuserdelete\fP (\fBud\fP) \fIaddress\fP [ \fIdelalias\fP ] |
745 .B vmm ad support@example.com d.user@example.com |
333 Use this subcommand to delete the account with the given \fIaddress\fP. |
746 .fi |
334 .br |
747 .\" ------------------------------------ |
335 If there are one or more aliases with an identical destination address, |
748 .SS aliasinfo (ai) |
336 \fBvmm\fP will abort the requested operation and show an error message. To |
749 .BI "vmm aliasinfo" " address" |
337 prevent this, specify the optional keyword '\fIdelalias\fP'. |
750 .PP |
338 .\" |
751 Information about the alias with the given |
339 .SS ALIAS SUBCOMMANDS |
752 .I address |
340 .TP |
753 can be displayed with this subcommand. |
341 \fBaliasadd\fP (\fBaa\fP) \fIalias\fP \fItarget\fP |
754 .PP |
342 This subcommand is used to create a new alias. |
755 Example: |
343 .PP |
756 .PP |
344 .nf |
757 .nf |
345 Examples: |
758 .B vmm aliasinfo support@example.com |
346 |
759 Alias information |
347 \fBvmm aliasadd john.doe@example.com d.user@example.com\fP |
760 ----------------- |
348 \fBvmm aa support@example.com d.user@example.com\fP |
761 Mail for support@example.com will be redirected to: |
349 \fBvmm aa support@example.com e.user@example.com\fP |
762 * e.user@example.com |
350 .fi |
763 .fi |
351 .TP |
764 .\" ----------------------------------------------------------------------- |
352 \fBaliasinfo\fP (\fBai\fP) \fIalias\fP |
765 .SH RELOCATED SUBCOMMANDS |
353 Information about an alias can be displayed with this subcommand. |
766 .SS relocatedadd (ra) |
354 .PP |
767 .BI "vmm relocatedadd" " address newaddress" |
355 .nf |
768 .PP |
356 Example: |
|
357 |
|
358 \fBvmm aliasinfo support@example.com\fP |
|
359 Alias information |
|
360 ----------------- |
|
361 Mail for support@example.com will be redirected to: |
|
362 * d.user@example.com |
|
363 * e.user@example.com |
|
364 .fi |
|
365 .TP |
|
366 \fBaliasdelete\fP (\fBad\fP) \fIalias\fP [ \fItarget\fP ] |
|
367 Use this subcommand to delete the \fIalias\fP. |
|
368 .br |
|
369 If the optional destination address \fItarget\fP is given, only this |
|
370 destination will be removed from the \fIalias\fP. |
|
371 .PP |
|
372 .nf |
|
373 Example: |
|
374 |
|
375 \fBvmm ad support@example.com d.user@example.com\fP |
|
376 .fi |
|
377 .\" |
|
378 .SS RELOCATED SUBCOMMANDS |
|
379 .TP |
|
380 \fBrelocatedadd\fP (\fBra\fP) \fIold_address\fP \fInew_address\fP |
|
381 A new relocated user can be created with this subcommand. |
769 A new relocated user can be created with this subcommand. |
382 .br |
770 .PP |
383 \fIold_address\fP is the users ex-email address, for example b.user@example.com, |
771 .I address |
384 and \fInew_address\fP points to the new email address where the user can be |
772 is the user\(aqs ex\-email address, for example b.user@example.com, and |
385 reached. |
773 .I newaddress |
386 .PP |
774 points to the new email address where the user can be reached. |
387 .nf |
775 .PP |
388 Example: |
776 Example: |
389 |
777 .PP |
390 \fBvmm relocatedadd b.user@example.com b-user@company.tld\fP |
778 .nf |
391 .fi |
779 .B vmm relocatedadd b.user@example.com b\-user@company.tld |
392 .TP |
780 .fi |
393 \fBrelocatedinfo\fP (\fBri\fP) \fIold_address\fP |
781 .\" ------------------------------------ |
394 This subcommand shows the new address of the relocated user with the |
782 .SS relocatedinfo (ri) |
395 \fIold_address\fP. |
783 .BI "vmm relocatedinfo " address |
396 .PP |
784 .PP |
397 .nf |
785 This subcommand shows the new address of the relocated user with the given |
398 Example: |
786 .IR address . |
399 |
787 .PP |
400 \fBvmm relocatedinfo b.user@example.com\fP |
788 Example: |
401 Relocated information |
789 .PP |
402 --------------------- |
790 .nf |
403 User “b.user@example.com” has moved to “b-user@company.tld” |
791 .B vmm relocatedinfo b.user@example.com |
404 .fi |
792 Relocated information |
405 .TP |
793 --------------------- |
406 \fBrelocateddelete\fP (\fBrd\fP) \fIold_address\fP |
794 User \(aqb.user@example.com\(aq has moved to \(aqb\-user@company.tld\(aq |
407 Use this subcommand in order to delete the relocated user with the |
795 .fi |
408 \fIold_address\fP. |
796 .\" ------------------------------------ |
409 .PP |
797 .SS relocateddelete (rd) |
410 .nf |
798 .BI "vmm relocateddelete " address |
411 Example: |
799 .PP |
412 |
800 Use this subcommand in order to delete the relocated user with the given |
413 \fBvmm relocateddelete b.user@example.com\fP |
801 .IR address . |
414 .fi |
802 .PP |
415 .\" |
803 Example: |
|
804 .PP |
|
805 .nf |
|
806 .B vmm relocateddelete b.user@example.com |
|
807 .fi |
|
808 .\" ----------------------------------------------------------------------- |
416 .SH FILES |
809 .SH FILES |
417 /usr/local/etc/vmm.cfg |
810 .TP |
|
811 .I /root/vmm.cfg |
|
812 will be used when found. |
|
813 .TP |
|
814 .I /usr/local/etc/vmm.cfg |
|
815 will be used when the above file doesn\(aqt exist. |
|
816 .TP |
|
817 .I /etc/vmm.cfg |
|
818 will be used when none of the both above mentioned files exists. |
|
819 .\" ----------------------------------------------------------------------- |
418 .SH SEE ALSO |
820 .SH SEE ALSO |
419 vmm.cfg(5), configuration file for vmm |
821 .BR dsync (1), |
420 .SH AUTHOR |
822 .BR transport (5), |
|
823 .BR vmm.cfg (5) |
|
824 .\" ----------------------------------------------------------------------- |
|
825 .SH INTERNET RESOURCES |
|
826 .TP |
|
827 Wiki |
|
828 http://vmm.localdomain.org/ |
|
829 .TP |
|
830 Project site |
|
831 http://sf.net/projects/vmm/ |
|
832 .TP |
|
833 Bug tracker |
|
834 http://sf.net/tracker/?group_id=213727&atid=1026862 |
|
835 .\" ----------------------------------------------------------------------- |
|
836 .SH COPYING |
421 \fBvmm\fP and its man pages were written by Pascal Volk |
837 \fBvmm\fP and its man pages were written by Pascal Volk |
422 <\fIneverseen@users.sourceforge.net\fP> and are licensed under the terms of the |
838 <\fIneverseen@users.sourceforge.net\fP> and are licensed under the terms of the |
423 BSD License. |
839 BSD License. |