author | Pascal Volk <neverseen@users.sourceforge.net> |
Fri, 22 Aug 2008 22:39:03 +0000 | |
changeset 56 | 9ae1b1b2ee5c |
parent 37 | 89f952b0f366 |
child 57 | 38c42e09677a |
permissions | -rw-r--r-- |
24 | 1 |
.\" $Id$ |
37
89f952b0f366
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
36
diff
changeset
|
2 |
.TH "VMM" "1" "11. Jun 2008" "Pascal Volk" |
21 | 3 |
.SH NAME |
26 | 4 |
vmm \- command line tool to manage email domains/accounts/aliases |
21 | 5 |
.SH SYNOPSIS |
6 |
.B vmm |
|
22 | 7 |
\fIsubcommand\fP \fIobject\fP [ \fIargs\fP ] |
21 | 8 |
.SH DESCRIPTION |
9 |
\fBvmm\fP (Virtual Mail Manager) is a command line tool for |
|
10 |
administrators/postmasters to manage domains, accounts and aliases. It's |
|
11 |
designed for Dovecot and Postfix with a PostgreSQL backend. |
|
22 | 12 |
.SH SUBCOMMANDS |
13 |
Each subcommand has both a long and a short form. Both forms are case sensitive. |
|
14 |
.SS GENERAL SUBCOMMANDS |
|
21 | 15 |
.TP |
16 |
\fBconfigure\fP (\fBcf\fP) [ \fIsection\fP ] |
|
17 |
Starts the interactive configuration for all configuration sections. |
|
18 |
.br |
|
23 | 19 |
If the optional argument \fIsection\fP is given, only the configuration options |
26 | 20 |
from the given section will be displayed and will be configurable. The following |
21 | 21 |
sections are available: |
22 |
.RS |
|
23 |
.PD 0 |
|
24 |
.TP |
|
25 |
- |
|
26 |
.B |
|
27 |
database |
|
28 |
.TP |
|
29 |
- |
|
30 |
.B |
|
31 |
maildir |
|
32 |
.TP |
|
33 |
- |
|
34 |
.B |
|
35 |
services |
|
36 |
.TP |
|
37 |
- |
|
38 |
.B |
|
39 |
domdir |
|
40 |
.TP |
|
41 |
- |
|
42 |
.B |
|
43 |
bin |
|
44 |
.TP |
|
45 |
- |
|
46 |
.B |
|
47 |
misc |
|
48 |
.PD |
|
49 |
.RE |
|
50 |
.LP |
|
51 |
.PP |
|
52 |
.nf |
|
53 |
Example: |
|
54 |
||
55 |
\fBvmm configure services\fP |
|
56 |
* Config section: services |
|
57 |
Enter new value for pop3 [True]: |
|
58 |
Enter new value for smtp [True]: |
|
59 |
Enter new value for imap [True]: |
|
60 |
Enter new value for managesieve [True]: false |
|
61 |
.fi |
|
62 |
.PP |
|
63 |
.TP |
|
64 |
\fBgetuser\fP (\fBgu\fP) \fIuserid\fP |
|
22 | 65 |
If only the userid is available, for example from process list, the subcommand |
21 | 66 |
\fBgetuser\fP will show the user's address. |
67 |
.PP |
|
68 |
.nf |
|
69 |
Example: |
|
23 | 70 |
|
21 | 71 |
\fBvmm getuser 70004\fP |
72 |
Account information |
|
73 |
------------------- |
|
37
89f952b0f366
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
36
diff
changeset
|
74 |
UID............: 70004 |
89f952b0f366
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
36
diff
changeset
|
75 |
GID............: 70000 |
21 | 76 |
Address........: c.user@example.com |
77 |
.fi |
|
36 | 78 |
.\" |
79 |
.TP |
|
80 |
\fBlistdomains\fP (\fBld\fP) [ \fIpattern\fP ] |
|
81 |
This subcommand lists all available domains. The output can be limited with an |
|
82 |
optional \fIpattern\fP. |
|
83 |
.br |
|
84 |
To perform a wild card search, the % character can be used at the start and/or |
|
85 |
the end of the \fIpattern\fP. |
|
86 |
.PP |
|
87 |
.nf |
|
88 |
Example: |
|
89 |
||
90 |
\fBvmm listdomains example%\fP |
|
91 |
Matching domains |
|
92 |
---------------- |
|
93 |
example.com |
|
94 |
example.net |
|
95 |
example.org |
|
96 |
.fi |
|
97 |
.\" |
|
21 | 98 |
.TP |
99 |
\fBhelp\fP (\fBh\fP) |
|
22 | 100 |
Prints all available commands to stderr. After this \fBvmm\fP exits. |
21 | 101 |
.TP |
102 |
\fBversion\fP (\fBv\fP) |
|
37
89f952b0f366
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
36
diff
changeset
|
103 |
Prints the version information from \fBvmm\fP. |
21 | 104 |
.\" |
22 | 105 |
.SS DOMAIN SUBCOMMANDS |
21 | 106 |
.TP |
107 |
\fBdomainadd\fP (\fBda\fP) \fIdomain\fP [ \fItransport\fP ] |
|
23 | 108 |
Adds the new \fIdomain\fP into the database. |
22 | 109 |
.br |
23 | 110 |
If the optional argument \fItransport\fP is given, it will overwrite the |
111 |
default transport from \fBvmm.cfg\fP (misc/transport). The specified transport |
|
112 |
will be the default transport for all new accounts in this domain. |
|
22 | 113 |
.PP |
114 |
.nf |
|
115 |
Examples: |
|
116 |
||
117 |
\fBvmm domainadd support.example.com smtp:mx1.example.com |
|
118 |
vmm domainadd sales.example.com\fP |
|
119 |
.fi |
|
21 | 120 |
.TP |
22 | 121 |
\fBdomaininfo\fP (\fBdi\fP) \fIdomain\fP [ \fIdetailed\fP ] |
122 |
This subcommand shows some information about the given domain. |
|
123 |
.br |
|
23 | 124 |
If the keyword '\fBdetailed\fP' is specified as optional argument, all |
125 |
available accounts and aliases will be listed. |
|
22 | 126 |
.PP |
127 |
.nf |
|
128 |
Example: |
|
129 |
||
130 |
\fBvmm domaininfo sales.example.com\fP |
|
131 |
Domain information |
|
132 |
------------------ |
|
133 |
Domainname.....: sales.example.com |
|
37
89f952b0f366
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
36
diff
changeset
|
134 |
GID............: 70002 |
89f952b0f366
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
36
diff
changeset
|
135 |
Transport......: dovecot: |
22 | 136 |
Domaindir......: /home/mail/5/70002 |
137 |
Accounts.......: 0 |
|
138 |
Aliases........: 0 |
|
139 |
||
140 |
.fi |
|
21 | 141 |
.TP |
22 | 142 |
\fBdomaintransport\fP (\fBdt\fP) \fIdomain\fP \fItransport\fP [ \fIforce\fP ] |
26 | 143 |
A new transport for the indicated domain can be set with this subcommand. |
22 | 144 |
.br |
23 | 145 |
If the additional keyword '\fBforce\fP' is given all account specific transport |
22 | 146 |
settings will be overwritten. |
147 |
.br |
|
148 |
Otherwise this setting will affect only new created accounts. |
|
149 |
.PP |
|
150 |
.nf |
|
151 |
Example: |
|
152 |
||
153 |
\fBvmm domaintransport support.example.com dovecot:\fP |
|
154 |
.fi |
|
21 | 155 |
.TP |
37
89f952b0f366
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
36
diff
changeset
|
156 |
\fBdomaindelete\fP (\fBdd\fP) \fIdomain\fP [ \fIdelalias\fP | \fIdeluser\fP | \fIdelall\fP ] |
23 | 157 |
This subcommand deletes the specified \fIdomain\fP. |
22 | 158 |
.br |
159 |
If there are accounts and/or aliases assigned to the given domain, \fBvmm\fP |
|
160 |
will abort the requested operation and show a error message. If you know, what |
|
37
89f952b0f366
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
36
diff
changeset
|
161 |
you are doing, you can specify one of the following keywords: '\fBdelalias\fP', '\fBdeluser\fP' or '\fBdelall\fP'. |
22 | 162 |
.br |
23 | 163 |
|
22 | 164 |
If you really always know what you are doing, edit your \fBvmm.cfg\fP and set |
165 |
the option \fIforcedel\fP, in section \fImisc\fP, to true. |
|
21 | 166 |
.\" |
22 | 167 |
.SS ACCOUNT SUBCOMMANDS |
168 |
.TP |
|
169 |
\fBuseradd\fP (\fBua\fP) \fIaddress\fP [ \fIpassword\fP ] |
|
23 | 170 |
Use this subcommand to create a new email account for the given \fIaddress\fP. |
171 |
.br |
|
172 |
If the \fIpassword\fP is not provided, \fBvmm\fP will prompt for it |
|
173 |
interactively. |
|
174 |
.PP |
|
175 |
.nf |
|
176 |
Examples: |
|
177 |
||
178 |
\fBvmm ua d.user@example.com 'A 5ecR3t P4s5\\/\\/0rd'\fP |
|
179 |
\fBvmm ua e.user@example.com\fP |
|
180 |
Enter new password: |
|
181 |
Retype new password: |
|
182 |
.fi |
|
22 | 183 |
.TP |
184 |
\fBuserinfo\fP (\fBui\fP) \fIaddress\fP [ \fIdu\fP ] |
|
23 | 185 |
This subcommand displays some information about the account specified by |
186 |
\fIaddress\fP. |
|
187 |
.br |
|
188 |
If the optional argument \fIdu\fP is given, the disk usage of users maildir will |
|
189 |
be summarized and displayed too. |
|
22 | 190 |
.TP |
23 | 191 |
\fBusername\fP (\fBun\fP) \fIaddress\fP \fI'Users Name'\fP |
26 | 192 |
The user's real name can be set/updated with this subcommand. |
23 | 193 |
.PP |
194 |
.nf |
|
195 |
Example: |
|
196 |
||
197 |
\fBvmm un d.user@example.com 'John Doe'\fP |
|
198 |
.fi |
|
21 | 199 |
.TP |
22 | 200 |
\fBuserpassword\fP (\fBup\fP) \fIaddress\fP [ \fIpassword\fP ] |
23 | 201 |
The \fIpassword\fP from an account can be updated with this subcommand. |
202 |
.br |
|
203 |
If the \fIpassword\fP is not provided, \fBvmm\fP will prompt for it |
|
204 |
interactively. |
|
205 |
.PP |
|
206 |
.nf |
|
207 |
Example: |
|
208 |
||
209 |
\fBvmm up d.user@example.com 'A |\\/|0r3 5ecur3 P4s5\\/\\/0rd?'\fP |
|
210 |
.fi |
|
22 | 211 |
.TP |
23 | 212 |
\fBusertransport\fP (\fBut\fP) \fIaddress\fP \fItransport\fP |
213 |
A different transport for an account can be specified with this subcommand. |
|
214 |
.PP |
|
215 |
.nf |
|
216 |
Example: |
|
217 |
||
218 |
\fBvmm ut d.user@example.com smtp:pc105.it.example.com\fP |
|
219 |
.fi |
|
22 | 220 |
.TP |
37
89f952b0f366
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
36
diff
changeset
|
221 |
\fBuserdisable\fP (\fBu0\fP) \fIaddress\fP [ \fIsmtp\fP | \fIpop3\fP | \fIimap\fP | \fImanagesieve\fP | \fIall\fP ] |
23 | 222 |
If a user shouldn't have access to one or all services you can restrict the |
223 |
access with this subcommand. |
|
224 |
.br |
|
26 | 225 |
If neither a service nor the keyword '\fIall\fP' is given all services ('smtp', 'pop3', 'imap', and 'managesieve') will be disabled for the account with the specified |
23 | 226 |
\fIaddress\fP. Otherwise only the specified service will be restricted. |
227 |
.PP |
|
228 |
.nf |
|
229 |
Examples: |
|
230 |
||
231 |
\fBvmm u0 b.user@example.com imap\fP |
|
232 |
\fBvmm userdisable c.user@example.com\fP |
|
233 |
.fi |
|
22 | 234 |
.TP |
37
89f952b0f366
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
36
diff
changeset
|
235 |
\fBuserenable\fP (\fBu1\fP) \fIaddress\fP [ \fIsmtp\fP | \fIpop3\fP | \fIimap\fP | \fImanagesieve\fP | \fIall\fP ] |
23 | 236 |
To allow access to one or all restricted services use this subcommand. |
237 |
.br |
|
26 | 238 |
If neither a service nor the keyword '\fIall\fP' is given all services ('smtp', 'pop3', 'imap', and 'managesieve') will be enabled for the account with the specified |
23 | 239 |
\fIaddress\fP. Otherwise only the specified service will be enabled. |
21 | 240 |
.TP |
22 | 241 |
\fBuserdelete\fP (\fBud\fP) \fIaddress\fP |
23 | 242 |
Use this subcommand to delete the account with the given \fIaddress\fP. |
22 | 243 |
.\" |
244 |
.SS ALIAS SUBCOMMANDS |
|
21 | 245 |
.TP |
22 | 246 |
\fBaliasadd\fP (\fBaa\fP) \fIalias\fP \fItarget\fP |
23 | 247 |
This subcommand is used to create a new alias. |
248 |
.PP |
|
249 |
.nf |
|
250 |
Examples: |
|
251 |
||
252 |
\fBvmm aliasadd john.doe@example.com d.user@example.com\fP |
|
253 |
\fBvmm aa support@example.com d.user@example.com\fP |
|
254 |
\fBvmm aa support@example.com e.user@example.com\fP |
|
255 |
.fi |
|
22 | 256 |
.TP |
257 |
\fBaliasinfo\fP (\fBai\fP) \fIalias\fP |
|
23 | 258 |
Information about an alias can be displayed with this subcommand. |
259 |
.PP |
|
260 |
.nf |
|
261 |
Example: |
|
262 |
||
263 |
\fBvmm aliasinfo support@example.com\fP |
|
264 |
Alias information |
|
265 |
----------------- |
|
266 |
Mail for support@example.com goes to: |
|
267 |
-> d.user@example.com |
|
268 |
-> e.user@example.com |
|
269 |
.fi |
|
22 | 270 |
.TP |
271 |
\fBaliasdelete\fP (\fBad\fP) \fIalias\fP [ \fItarget\fP ] |
|
23 | 272 |
Use this subcommand to delete the \fIalias\fP. |
273 |
.br |
|
274 |
If the optional destination address \fItarget\fP is given, only this |
|
275 |
destination will be removed from the \fIalias\fP. |
|
276 |
.PP |
|
277 |
.nf |
|
278 |
Example: |
|
279 |
\fBvmm ad support@example.com d.user@example.com\fP |
|
280 |
.fi |
|
21 | 281 |
.SH FILES |
282 |
/usr/local/etc/vmm.cfg |
|
283 |
.SH SEE ALSO |
|
25 | 284 |
vmm.cfg(5), configuration file for vmm |
21 | 285 |
.SH AUTHOR |
22 | 286 |
\fBvmm\fP and its man pages were written by Pascal Volk |
287 |
<\fIp.volk@veb-it.de\fP> and are licensed under the terms of the BSD License. |