author | Pascal Volk <neverseen@users.sourceforge.net> |
Sat, 22 Aug 2009 20:24:50 +0000 (2009-08-22) | |
changeset 131 | 2b8154cc7ebe |
parent 113 | e35755191ff3 |
child 133 | 2d5c4745efec |
permissions | -rw-r--r-- |
113
e35755191ff3
Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents:
102
diff
changeset
|
1 |
.TH "VMM" "1" "17 Aug 2009" "Pascal Volk" |
21 | 2 |
.SH NAME |
26 | 3 |
vmm \- command line tool to manage email domains/accounts/aliases |
21 | 4 |
.SH SYNOPSIS |
5 |
.B vmm |
|
22 | 6 |
\fIsubcommand\fP \fIobject\fP [ \fIargs\fP ] |
21 | 7 |
.SH DESCRIPTION |
8 |
\fBvmm\fP (Virtual Mail Manager) is a command line tool for |
|
9 |
administrators/postmasters to manage domains, accounts and aliases. It's |
|
10 |
designed for Dovecot and Postfix with a PostgreSQL backend. |
|
22 | 11 |
.SH SUBCOMMANDS |
12 |
Each subcommand has both a long and a short form. Both forms are case sensitive. |
|
13 |
.SS GENERAL SUBCOMMANDS |
|
21 | 14 |
.TP |
15 |
\fBconfigure\fP (\fBcf\fP) [ \fIsection\fP ] |
|
16 |
Starts the interactive configuration for all configuration sections. |
|
17 |
.br |
|
23 | 18 |
If the optional argument \fIsection\fP is given, only the configuration options |
26 | 19 |
from the given section will be displayed and will be configurable. The following |
21 | 20 |
sections are available: |
21 |
.RS |
|
22 |
.PD 0 |
|
23 |
.TP |
|
24 |
- |
|
25 |
.B |
|
26 |
database |
|
27 |
.TP |
|
28 |
- |
|
29 |
.B |
|
30 |
maildir |
|
31 |
.TP |
|
32 |
- |
|
33 |
.B |
|
34 |
services |
|
35 |
.TP |
|
36 |
- |
|
37 |
.B |
|
38 |
domdir |
|
39 |
.TP |
|
40 |
- |
|
41 |
.B |
|
42 |
bin |
|
43 |
.TP |
|
44 |
- |
|
45 |
.B |
|
46 |
misc |
|
47 |
.PD |
|
48 |
.RE |
|
49 |
.LP |
|
50 |
.PP |
|
51 |
.nf |
|
52 |
Example: |
|
53 |
||
54 |
\fBvmm configure services\fP |
|
113
e35755191ff3
Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents:
102
diff
changeset
|
55 |
Using configuration file: /usr/local/etc/vmm.cfg |
e35755191ff3
Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents:
102
diff
changeset
|
56 |
|
57
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
57 |
* Config section: »services« |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
58 |
Enter new value for option pop3 [True]: |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
59 |
Enter new value for option smtp [True]: |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
60 |
Enter new value for option imap [True]: |
113
e35755191ff3
Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents:
102
diff
changeset
|
61 |
Enter new value for option sieve [True]: false |
21 | 62 |
.fi |
63 |
.PP |
|
64 |
.TP |
|
65 |
\fBgetuser\fP (\fBgu\fP) \fIuserid\fP |
|
22 | 66 |
If only the userid is available, for example from process list, the subcommand |
21 | 67 |
\fBgetuser\fP will show the user's address. |
68 |
.PP |
|
69 |
.nf |
|
70 |
Example: |
|
23 | 71 |
|
21 | 72 |
\fBvmm getuser 70004\fP |
73 |
Account information |
|
74 |
------------------- |
|
37
89f952b0f366
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
36
diff
changeset
|
75 |
UID............: 70004 |
89f952b0f366
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
36
diff
changeset
|
76 |
GID............: 70000 |
21 | 77 |
Address........: c.user@example.com |
78 |
.fi |
|
36 | 79 |
.\" |
80 |
.TP |
|
81 |
\fBlistdomains\fP (\fBld\fP) [ \fIpattern\fP ] |
|
57
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
82 |
This subcommand lists all available domains. All domain names will be prefixed |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
83 |
either with '[+]', if the domain is a primary domain, or with '[-]', if it is |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
84 |
an alias domain name. The output can be limited with an optional \fIpattern\fP. |
36 | 85 |
.br |
86 |
To perform a wild card search, the % character can be used at the start and/or |
|
87 |
the end of the \fIpattern\fP. |
|
88 |
.PP |
|
89 |
.nf |
|
90 |
Example: |
|
91 |
||
57
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
92 |
\fBvmm listdomains %example%\fP |
36 | 93 |
Matching domains |
94 |
---------------- |
|
57
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
95 |
[+] example.com |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
96 |
[-] e.g.example.com |
79
0ae7597eed11
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
66
diff
changeset
|
97 |
[-] example.name |
57
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
98 |
[+] example.net |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
99 |
[+] example.org |
36 | 100 |
.fi |
101 |
.\" |
|
21 | 102 |
.TP |
103 |
\fBhelp\fP (\fBh\fP) |
|
57
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
104 |
Prints all available commands to stdout. After this \fBvmm\fP exits. |
21 | 105 |
.TP |
106 |
\fBversion\fP (\fBv\fP) |
|
37
89f952b0f366
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
36
diff
changeset
|
107 |
Prints the version information from \fBvmm\fP. |
21 | 108 |
.\" |
22 | 109 |
.SS DOMAIN SUBCOMMANDS |
21 | 110 |
.TP |
111 |
\fBdomainadd\fP (\fBda\fP) \fIdomain\fP [ \fItransport\fP ] |
|
23 | 112 |
Adds the new \fIdomain\fP into the database. |
22 | 113 |
.br |
23 | 114 |
If the optional argument \fItransport\fP is given, it will overwrite the |
115 |
default transport from \fBvmm.cfg\fP (misc/transport). The specified transport |
|
116 |
will be the default transport for all new accounts in this domain. |
|
22 | 117 |
.PP |
118 |
.nf |
|
119 |
Examples: |
|
120 |
||
121 |
\fBvmm domainadd support.example.com smtp:mx1.example.com |
|
122 |
vmm domainadd sales.example.com\fP |
|
123 |
.fi |
|
21 | 124 |
.TP |
64 | 125 |
\fBdomaininfo\fP (\fBdi\fP) \fIdomain\fP [ \fIdetails\fP ] |
62
869de537a020
* 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
59
diff
changeset
|
126 |
This subcommand shows some information about the given \fIdomain\fP. |
22 | 127 |
.br |
64 | 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 |
|
81
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
130 |
the following five keywords: |
62
869de537a020
* 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
59
diff
changeset
|
131 |
.RS |
869de537a020
* 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
59
diff
changeset
|
132 |
.PD 0 |
869de537a020
* 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
59
diff
changeset
|
133 |
.TP |
869de537a020
* 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
59
diff
changeset
|
134 |
.B accounts |
64 | 135 |
to list all existing accounts |
62
869de537a020
* 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
59
diff
changeset
|
136 |
.TP |
869de537a020
* 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
59
diff
changeset
|
137 |
.B aliasdomains |
64 | 138 |
to list all assigned alias domains |
62
869de537a020
* 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
59
diff
changeset
|
139 |
.TP |
869de537a020
* 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
59
diff
changeset
|
140 |
.B aliases |
64 | 141 |
to list all available aliases addresses |
62
869de537a020
* 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
59
diff
changeset
|
142 |
.TP |
81
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
143 |
.B relocated |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
144 |
to list all relocated users |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
145 |
.TP |
62
869de537a020
* 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
59
diff
changeset
|
146 |
.B full |
64 | 147 |
to list all information mentioned above |
62
869de537a020
* 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
59
diff
changeset
|
148 |
.PD |
869de537a020
* 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
59
diff
changeset
|
149 |
.RE |
869de537a020
* 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
59
diff
changeset
|
150 |
.LP |
22 | 151 |
.nf |
152 |
Example: |
|
153 |
||
154 |
\fBvmm domaininfo sales.example.com\fP |
|
155 |
Domain information |
|
156 |
------------------ |
|
157 |
Domainname.....: sales.example.com |
|
37
89f952b0f366
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
36
diff
changeset
|
158 |
GID............: 70002 |
89f952b0f366
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
36
diff
changeset
|
159 |
Transport......: dovecot: |
22 | 160 |
Domaindir......: /home/mail/5/70002 |
57
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
161 |
Aliasdomains...: 0 |
22 | 162 |
Accounts.......: 0 |
163 |
Aliases........: 0 |
|
81
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
164 |
Relocated......: 0 |
22 | 165 |
|
166 |
.fi |
|
21 | 167 |
.TP |
22 | 168 |
\fBdomaintransport\fP (\fBdt\fP) \fIdomain\fP \fItransport\fP [ \fIforce\fP ] |
26 | 169 |
A new transport for the indicated domain can be set with this subcommand. |
22 | 170 |
.br |
23 | 171 |
If the additional keyword '\fBforce\fP' is given all account specific transport |
22 | 172 |
settings will be overwritten. |
173 |
.br |
|
174 |
Otherwise this setting will affect only new created accounts. |
|
175 |
.PP |
|
176 |
.nf |
|
177 |
Example: |
|
178 |
||
179 |
\fBvmm domaintransport support.example.com dovecot:\fP |
|
180 |
.fi |
|
21 | 181 |
.TP |
37
89f952b0f366
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
36
diff
changeset
|
182 |
\fBdomaindelete\fP (\fBdd\fP) \fIdomain\fP [ \fIdelalias\fP | \fIdeluser\fP | \fIdelall\fP ] |
23 | 183 |
This subcommand deletes the specified \fIdomain\fP. |
22 | 184 |
.br |
185 |
If there are accounts and/or aliases assigned to the given domain, \fBvmm\fP |
|
62
869de537a020
* 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
59
diff
changeset
|
186 |
will abort the requested operation and show an error message. If you know, what |
37
89f952b0f366
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
36
diff
changeset
|
187 |
you are doing, you can specify one of the following keywords: '\fBdelalias\fP', '\fBdeluser\fP' or '\fBdelall\fP'. |
22 | 188 |
.br |
23 | 189 |
|
22 | 190 |
If you really always know what you are doing, edit your \fBvmm.cfg\fP and set |
191 |
the option \fIforcedel\fP, in section \fImisc\fP, to true. |
|
21 | 192 |
.\" |
57
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
193 |
.SS ALIAS DOMAIN SUBCOMMANDS |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
194 |
.TP |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
195 |
\fBaliasdomainaddd\fP (\fBada\fP) \fIaliasdomain\fP \fItargetdomain\fP |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
196 |
This subcommand adds the new \fIaliasdomain\fP to the \fItargetdomain\fP that |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
197 |
should be aliased. |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
198 |
.PP |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
199 |
.nf |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
200 |
Example: |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
201 |
|
79
0ae7597eed11
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
66
diff
changeset
|
202 |
\fBvmm aliasdomainadd example.name example.com\fP |
57
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
203 |
.fi |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
204 |
.TP |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
205 |
\fBaliasdomaininfo (\fBadi\fP) \fIaliasdomain\fP |
59
f2f784667040
* 'man/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
57
diff
changeset
|
206 |
This subcommand shows to which domain the \fIaliasdomain\fP is assigned to. |
57
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
207 |
.PP |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
208 |
.nf |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
209 |
Example: |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
210 |
|
79
0ae7597eed11
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
66
diff
changeset
|
211 |
\fBvmm aliasdomaininfo example.name\fP |
57
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
212 |
Alias domain information |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
213 |
------------------------ |
79
0ae7597eed11
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
66
diff
changeset
|
214 |
The alias domain example.name belongs to: |
57
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
215 |
* example.com |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
216 |
.fi |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
217 |
.TP |
79
0ae7597eed11
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
66
diff
changeset
|
218 |
\fBaliasdomainswitch\fP (\fBads\fP) \fIaliasdomain\fP \fItargetdomain\fP |
0ae7597eed11
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
66
diff
changeset
|
219 |
If the target of the existing \fIaliasdomain\fP should be switched to another |
0ae7597eed11
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
66
diff
changeset
|
220 |
\fItargetdomain\fP use this subcommand. |
0ae7597eed11
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
66
diff
changeset
|
221 |
.PP |
0ae7597eed11
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
66
diff
changeset
|
222 |
.nf |
0ae7597eed11
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
66
diff
changeset
|
223 |
Example: |
0ae7597eed11
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
66
diff
changeset
|
224 |
|
0ae7597eed11
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
66
diff
changeset
|
225 |
\fBvmm aliasdomainswitch example.name example.org\fP |
0ae7597eed11
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
66
diff
changeset
|
226 |
.fi |
0ae7597eed11
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
66
diff
changeset
|
227 |
.TP |
57
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
228 |
\fBaliasdomaindelete\fP (\fBadd\fP) \fIaliasdomain\fP |
59
f2f784667040
* 'man/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
57
diff
changeset
|
229 |
Use this subcommand if the alias domain \fIaliasdomain\fP should be removed. |
57
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
230 |
.PP |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
231 |
.nf |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
232 |
Example: |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
233 |
|
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
234 |
\fBvmm aliasdomaindelete e.g.example.com\fP |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
235 |
.fi |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
236 |
.\" |
22 | 237 |
.SS ACCOUNT SUBCOMMANDS |
238 |
.TP |
|
239 |
\fBuseradd\fP (\fBua\fP) \fIaddress\fP [ \fIpassword\fP ] |
|
23 | 240 |
Use this subcommand to create a new email account for the given \fIaddress\fP. |
241 |
.br |
|
242 |
If the \fIpassword\fP is not provided, \fBvmm\fP will prompt for it |
|
243 |
interactively. |
|
244 |
.PP |
|
245 |
.nf |
|
246 |
Examples: |
|
247 |
||
248 |
\fBvmm ua d.user@example.com 'A 5ecR3t P4s5\\/\\/0rd'\fP |
|
249 |
\fBvmm ua e.user@example.com\fP |
|
250 |
Enter new password: |
|
251 |
Retype new password: |
|
252 |
.fi |
|
22 | 253 |
.TP |
90
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
254 |
\fBuserinfo\fP (\fBui\fP) \fIaddress\fP [ \fIdetails\fP ] |
23 | 255 |
This subcommand displays some information about the account specified by |
256 |
\fIaddress\fP. |
|
257 |
.br |
|
90
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
258 |
If the optional argument \fIdetails\fP is given some more information will be |
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
259 |
displayed. |
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
260 |
.br |
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
261 |
Possible values for \fIdetails\fP are: |
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
262 |
.RS |
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
263 |
.PD 0 |
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
264 |
.TP |
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
265 |
.B aliases |
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
266 |
to list all alias addresses with the destination \fIaddress\fP |
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
267 |
.TP |
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
268 |
.B du |
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
269 |
to display the disk usage of users maildir |
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
270 |
.TP |
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
271 |
.B full |
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
272 |
to list all information mentioned above |
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
273 |
.PD |
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
274 |
.RE |
1734eb5101c6
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
81
diff
changeset
|
275 |
.LP |
22 | 276 |
.TP |
23 | 277 |
\fBusername\fP (\fBun\fP) \fIaddress\fP \fI'Users Name'\fP |
26 | 278 |
The user's real name can be set/updated with this subcommand. |
23 | 279 |
.PP |
280 |
.nf |
|
281 |
Example: |
|
282 |
||
283 |
\fBvmm un d.user@example.com 'John Doe'\fP |
|
284 |
.fi |
|
21 | 285 |
.TP |
22 | 286 |
\fBuserpassword\fP (\fBup\fP) \fIaddress\fP [ \fIpassword\fP ] |
23 | 287 |
The \fIpassword\fP from an account can be updated with this subcommand. |
288 |
.br |
|
289 |
If the \fIpassword\fP is not provided, \fBvmm\fP will prompt for it |
|
290 |
interactively. |
|
291 |
.PP |
|
292 |
.nf |
|
293 |
Example: |
|
294 |
||
295 |
\fBvmm up d.user@example.com 'A |\\/|0r3 5ecur3 P4s5\\/\\/0rd?'\fP |
|
296 |
.fi |
|
22 | 297 |
.TP |
23 | 298 |
\fBusertransport\fP (\fBut\fP) \fIaddress\fP \fItransport\fP |
299 |
A different transport for an account can be specified with this subcommand. |
|
300 |
.PP |
|
301 |
.nf |
|
302 |
Example: |
|
303 |
||
304 |
\fBvmm ut d.user@example.com smtp:pc105.it.example.com\fP |
|
305 |
.fi |
|
22 | 306 |
.TP |
64 | 307 |
\fBuserdisable\fP (\fBu0\fP) \fIaddress\fP [ \fIservice\fP ] |
23 | 308 |
If a user shouldn't have access to one or all services you can restrict the |
309 |
access with this subcommand. |
|
310 |
.br |
|
64 | 311 |
If neither a \fIservice\fP nor the keyword '\fIall\fP' is given all services |
113
e35755191ff3
Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents:
102
diff
changeset
|
312 |
(\fIsmtp\fP, \fIpop3\fP, \fIimap\fP, and \fIsieve\fP) will be disabled for the |
e35755191ff3
Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents:
102
diff
changeset
|
313 |
account with the specified \fIaddress\fP. Otherwise only the specified |
64 | 314 |
\fIservice\fP will be restricted. |
23 | 315 |
.PP |
316 |
.nf |
|
317 |
Examples: |
|
318 |
||
319 |
\fBvmm u0 b.user@example.com imap\fP |
|
320 |
\fBvmm userdisable c.user@example.com\fP |
|
321 |
.fi |
|
22 | 322 |
.TP |
66
995d538a6eb5
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
64
diff
changeset
|
323 |
\fBuserenable\fP (\fBu1\fP) \fIaddress\fP [ \fIservice\fP ] |
23 | 324 |
To allow access to one or all restricted services use this subcommand. |
325 |
.br |
|
64 | 326 |
If neither a \fIservice\fP nor the keyword '\fIall\fP' is given all services |
113
e35755191ff3
Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents:
102
diff
changeset
|
327 |
(\fIsmtp\fP, \fIpop3\fP, \fIimap\fP, and \fIsieve\fP) will be enabled for the |
e35755191ff3
Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents:
102
diff
changeset
|
328 |
account with the specified \fIaddress\fP. Otherwise only the specified |
64 | 329 |
\fIservice\fP will be enabled. |
66
995d538a6eb5
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
64
diff
changeset
|
330 |
.PP |
21 | 331 |
.TP |
66
995d538a6eb5
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
64
diff
changeset
|
332 |
\fBuserdelete\fP (\fBud\fP) \fIaddress\fP [ \fIdelalias\fP ] |
23 | 333 |
Use this subcommand to delete the account with the given \fIaddress\fP. |
66
995d538a6eb5
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
64
diff
changeset
|
334 |
.br |
995d538a6eb5
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
64
diff
changeset
|
335 |
If there are one or more aliases with an identical destination address, |
995d538a6eb5
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
64
diff
changeset
|
336 |
\fBvmm\fP will abort the requested operation and show an error message. To |
995d538a6eb5
* 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
64
diff
changeset
|
337 |
prevent this, specify the optional keyword '\fIdelalias\fP'. |
22 | 338 |
.\" |
339 |
.SS ALIAS SUBCOMMANDS |
|
21 | 340 |
.TP |
22 | 341 |
\fBaliasadd\fP (\fBaa\fP) \fIalias\fP \fItarget\fP |
23 | 342 |
This subcommand is used to create a new alias. |
343 |
.PP |
|
344 |
.nf |
|
345 |
Examples: |
|
346 |
||
347 |
\fBvmm aliasadd john.doe@example.com d.user@example.com\fP |
|
348 |
\fBvmm aa support@example.com d.user@example.com\fP |
|
349 |
\fBvmm aa support@example.com e.user@example.com\fP |
|
350 |
.fi |
|
22 | 351 |
.TP |
352 |
\fBaliasinfo\fP (\fBai\fP) \fIalias\fP |
|
23 | 353 |
Information about an alias can be displayed with this subcommand. |
354 |
.PP |
|
355 |
.nf |
|
356 |
Example: |
|
357 |
||
358 |
\fBvmm aliasinfo support@example.com\fP |
|
359 |
Alias information |
|
360 |
----------------- |
|
57
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
361 |
Mail for support@example.com will be redirected to: |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
362 |
* d.user@example.com |
38c42e09677a
* 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
37
diff
changeset
|
363 |
* e.user@example.com |
23 | 364 |
.fi |
22 | 365 |
.TP |
366 |
\fBaliasdelete\fP (\fBad\fP) \fIalias\fP [ \fItarget\fP ] |
|
23 | 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: |
|
81
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
374 |
|
23 | 375 |
\fBvmm ad support@example.com d.user@example.com\fP |
376 |
.fi |
|
81
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
377 |
.\" |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
378 |
.SS RELOCATED SUBCOMMANDS |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
379 |
.TP |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
380 |
\fBrelocatedadd\fP (\fBra\fP) \fIold_address\fP \fInew_address\fP |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
381 |
A new relocated user can be created with this subcommand. |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
382 |
.br |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
383 |
\fIold_address\fP is the users ex-email address, for example b.user@example.com, |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
384 |
and \fInew_address\fP points to the new email address where the user can be |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
385 |
reached. |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
386 |
.PP |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
387 |
.nf |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
388 |
Example: |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
389 |
|
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
390 |
\fBvmm relocatedadd b.user@example.com b-user@company.tld\fP |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
391 |
.fi |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
392 |
.TP |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
393 |
\fBrelocatedinfo\fP (\fBri\fP) \fIold_address\fP |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
394 |
This subcommand shows the new address of the relocated user with the |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
395 |
\fIold_address\fP. |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
396 |
.PP |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
397 |
.nf |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
398 |
Example: |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
399 |
|
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
400 |
\fBvmm relocatedinfo b.user@example.com\fP |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
401 |
Relocated information |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
402 |
--------------------- |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
403 |
User »b.user@example.com« has moved to »b-user@company.tld« |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
404 |
.fi |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
405 |
.TP |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
406 |
\fBrelocateddelete\fP (\fBrd\fP) \fIold_address\fP |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
407 |
Use this subcommand in order to delete the relocated user with the |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
408 |
\fIold_address\fP. |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
409 |
.PP |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
410 |
.nf |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
411 |
Example: |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
412 |
|
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
413 |
\fBvmm relocateddelete b.user@example.com\fP |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
414 |
.fi |
89b71a9abfcf
* 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
79
diff
changeset
|
415 |
.\" |
21 | 416 |
.SH FILES |
417 |
/usr/local/etc/vmm.cfg |
|
418 |
.SH SEE ALSO |
|
25 | 419 |
vmm.cfg(5), configuration file for vmm |
21 | 420 |
.SH AUTHOR |
22 | 421 |
\fBvmm\fP and its man pages were written by Pascal Volk |
422 |
<\fIp.volk@veb-it.de\fP> and are licensed under the terms of the BSD License. |