|
1 .\" $Id$ |
|
2 .TH "VMM" "1" "11. Jun 2008" "Pascal Volk" |
|
3 .SH NAME |
|
4 vmm \- Programm für die Kommandozeile, um E-Mail-Domains, -Konten und -Aliase zu |
|
5 verwalten. |
|
6 .SH SYNOPSIS |
|
7 .B vmm |
|
8 \fIUnterbefehl\fP \fIObjekt\fP [ \fIArgumente\fP ] |
|
9 .SH BESCHREIBUNG |
|
10 \fBvmm\fP (Virtual Mail Manager) ist ein Kommandozeilen-Werkzeug für |
|
11 Administratoren/Postmaster zur Verwaltung von Domains, Konten und Aliase. Es |
|
12 wurde entwickelt für Dovecot und Postfix mit einem PostgreSQL-Backend. |
|
13 .SH UNTERBEFEHLE |
|
14 Von jedem Unterbefehl gibt es jeweils eine lange und kurze Variante. Bei beiden |
|
15 Formen ist die Groß-/Kleinschreibung zu berücksichtigen. |
|
16 .SS ALLGEMEINE UNTERBEFEHLE |
|
17 .TP |
|
18 \fBconfigure\fP (\fBcf\fP) [ \fIAbschnitt\fP ] |
|
19 Startet den interaktiven Konfiguration-Modus für alle Konfigurations-Abschnitte. |
|
20 .br |
|
21 Wurde das optionale Argument \fIAbschnitt\fP angegeben, werden nur die Optionen |
|
22 des angegebenen Abschnitts angezeigt und können geändert werden. Folgende |
|
23 Abschnitte sind vorhanden: |
|
24 .RS |
|
25 .PD 0 |
|
26 .TP |
|
27 - |
|
28 .B |
|
29 database |
|
30 .TP |
|
31 - |
|
32 .B |
|
33 maildir |
|
34 .TP |
|
35 - |
|
36 .B |
|
37 services |
|
38 .TP |
|
39 - |
|
40 .B |
|
41 domdir |
|
42 .TP |
|
43 - |
|
44 .B |
|
45 bin |
|
46 .TP |
|
47 - |
|
48 .B |
|
49 misc |
|
50 .PD |
|
51 .RE |
|
52 .LP |
|
53 .PP |
|
54 .nf |
|
55 Beispiel: |
|
56 |
|
57 \fBvmm configure services\fP |
|
58 * Konfigurations Abschnitt: services |
|
59 Neuer Wert für pop3 [True]: |
|
60 Neuer Wert für smtp [True]: |
|
61 Neuer Wert für imap [True]: |
|
62 Neuer Wert für managesieve [True]: false |
|
63 .fi |
|
64 .PP |
|
65 .TP |
|
66 \fBgetuser\fP (\fBgu\fP) \fIuserid\fP |
|
67 Wenn nur eine UserID vorhanden ist, z. B. aus der Prozessliste, kann mit dem |
|
68 Unterbefehl \fBgetuser\fP die E-Mail-Adresse des Users ermittelt werden. |
|
69 .PP |
|
70 .nf |
|
71 Beispiel: |
|
72 |
|
73 \fBvmm getuser 70004\fP |
|
74 Account Informationen |
|
75 --------------------- |
|
76 UID............: 70004 |
|
77 GID............: 70000 |
|
78 Address........: c.user@example.com |
|
79 .fi |
|
80 .\" |
|
81 .TP |
|
82 \fBlistdomains\fP (\fBld\fP) [ \fIMuster\fP ] |
|
83 Dieser Unterbefehl listet alle verfügbaren Domains auf. Die Ausgabe kann |
|
84 reduziert werden, indem ein optionales \fIMuster\fP angegeben wird. |
|
85 .br |
|
86 Um eine Wildcard-Suche durchzuführen kann das %-Zeichen am Anfang und/oder Ende |
|
87 des \fIMusters\fP verwendet werden. |
|
88 .PP |
|
89 .nf |
|
90 Beispiel: |
|
91 |
|
92 \fBvmm listdomains example%\fP |
|
93 Übereinstimmende Domains |
|
94 ------------------------- |
|
95 example.com |
|
96 example.net |
|
97 example.org |
|
98 .fi |
|
99 .\" |
|
100 .TP |
|
101 \fBhelp\fP (\fBh\fP) |
|
102 Dieser Unterbefehl gibt alle verfügbaren Kommandos auf stderr aus. Danach |
|
103 beendet sich \fBvmm\fP. |
|
104 .TP |
|
105 \fBversion\fP (\fBv\fP) |
|
106 Gibt Versions-Informationen zu \fBvmm\fP aus. |
|
107 .\" |
|
108 .SS DOMAIN UNTERBEFEHLE |
|
109 .TP |
|
110 \fBdomainadd\fP (\fBda\fP) \fIDomain\fP [ \fITransport\fP ] |
|
111 Fügt eine neue \fIDomain\fP in die Datenbank ein. |
|
112 .br |
|
113 Ist das optionale Argument \fITransport\fP angegeben, wird der Vorgabe-Transport |
|
114 aus \fBvmm.cfg\fP (misc/transport) für diese \fIDomain\fP ignoriert und der |
|
115 angegebene \fITransport\fP verwendet. Der angegebene \fITransport\fP ist |
|
116 gleichzeitig der Vorgabe-Transport für alle neuen Konten, die unter dieser |
|
117 Domain eingerichtet werden. |
|
118 .PP |
|
119 .nf |
|
120 Beispiele: |
|
121 |
|
122 \fBvmm domainadd support.example.com smtp:mx1.example.com |
|
123 vmm domainadd sales.example.com\fP |
|
124 .fi |
|
125 .TP |
|
126 \fBdomaininfo\fP (\fBdi\fP) \fIDomain\fP [ \fIdetailed\fP ] |
|
127 Dieser Unterbefehl zeigt Information zur angegeben \fIDomain\fP an. |
|
128 .br |
|
129 Wurde das optionale Schlüsselwort '\fBdetailed\fP' angegeben, werden zusätzlich |
|
130 alle eingerichteten Konten und Aliase aufgelistet. |
|
131 .PP |
|
132 .nf |
|
133 Beispiel: |
|
134 |
|
135 \fBvmm domaininfo sales.example.com\fP |
|
136 Domain Informationen |
|
137 -------------------- |
|
138 Domainname.....: sales.example.com |
|
139 GID............: 70002 |
|
140 Transport......: dovecot: |
|
141 Domaindir......: /home/mail/5/70002 |
|
142 Accounts.......: 0 |
|
143 Aliases........: 0 |
|
144 |
|
145 .fi |
|
146 .TP |
|
147 \fBdomaintransport\fP (\fBdt\fP) \fIDomain\fP \fITransport\fP [ \fIforce\fP ] |
|
148 Ein neuer \fITransport\fP für die angegebene \fIDomain\fP kann mit diesem |
|
149 Unterbefehl festgelegt werden. |
|
150 .br |
|
151 Wurde das optionale Schlüsselwort '\fBforce\fP' angegeben, so werden alle |
|
152 bisherigen Transport-Einstellungen, der in dieser Domain vorhandenen Konten, |
|
153 mit dem neuen \fITransport\fP überschrieben. |
|
154 .br |
|
155 Andernfalls gilt der neue \fITransport\fP nur für Konten, die neu erstellt |
|
156 werden. |
|
157 .PP |
|
158 .nf |
|
159 Beispiel: |
|
160 |
|
161 \fBvmm domaintransport support.example.com dovecot:\fP |
|
162 .fi |
|
163 .TP |
|
164 \fBdomaindelete\fP (\fBdd\fP) \fIDomain\fP [ \fIdelalias\fP | \fIdeluser\fP | \fIdelall\fP ] |
|
165 Mit diesem Unterbefehl wird die angegebene \fIDomain\fP gelöscht. |
|
166 .br |
|
167 Sollten der \fIDomain\fP Konten und/oder Aliase zugeordnet sein, wird \fBvmm\fP |
|
168 die Ausführung des Befehls mit einer entsprechenden Fehlermeldung beenden. |
|
169 |
|
170 Sollten Sie sich Ihres Vorhabens sicher sein, so kann optional eines der |
|
171 folgenden Schlüsselwörter angegeben werden: '\fBdelalias\fP', '\fBdeluser\fP' oder '\fBdelall\fP' |
|
172 |
|
173 Sollten Sie wirklich immer wissen was Sie tun, so editieren Sie Ihre |
|
174 \fBvmm.cfg\fP und setzen den Wert der Option \fIforcedel\fP, im Abschnitt |
|
175 \fImisc\fP, auf true. Dann werden Sie beim Löschen von Domains nicht mehr wegen |
|
176 vorhanden Konten/Aliase gewarnt. |
|
177 .\" |
|
178 .SS KONTO UNTERBEFEHLE |
|
179 .TP |
|
180 \fBuseradd\fP (\fBua\fP) \fIAdresse\fP [ \fIPasswort\fP ] |
|
181 Mit diesem Unterbefehl wird ein neues Konto für die angegebene \fIAdresse\fP |
|
182 angelegt. |
|
183 .br |
|
184 Wurde keine \fIPasswort\fP angegeben wird \fBvmm\fP dieses im interaktiven |
|
185 Modus erfragen. |
|
186 .PP |
|
187 .nf |
|
188 Beispiele: |
|
189 |
|
190 \fBvmm ua d.user@example.com 'A 5ecR3t P4s5\\/\\/0rd'\fP |
|
191 \fBvmm ua e.user@example.com\fP |
|
192 Neues Passwort eingeben: |
|
193 Neues Passwort wiederholen: |
|
194 .fi |
|
195 .TP |
|
196 \fBuserinfo\fP (\fBui\fP) \fIAdresse\fP [ \fIdu\fP ] |
|
197 Dieser Unterbefehl zeigt einige Informationen über das Konto mit der angegebenen |
|
198 \fIAdresse\fP an. |
|
199 .br |
|
200 Wurde das optionale Argument \fIdu\fP angegeben, wird zusätzlich die |
|
201 Festplattenbelegung des Kontos ermittelt und ausgegeben. |
|
202 .TP |
|
203 \fBusername\fP (\fBun\fP) \fIAdresse\fP \fI'Bürgerlicher Name'\fP |
|
204 Der Bürgerliche Name des Konto-Inhabers mit der angegebenen \fIAdresse\fP kann |
|
205 mit diesem Unterbefehl gesetzt/aktualisiert werden. |
|
206 .PP |
|
207 .nf |
|
208 Beispiel: |
|
209 |
|
210 \fBvmm un d.user@example.com 'John Doe'\fP |
|
211 .fi |
|
212 .TP |
|
213 \fBuserpassword\fP (\fBup\fP) \fIAdresse\fP [ \fIPasswort\fP ] |
|
214 Das \fIPasswort\fP eines Kontos kann mit diesem Unterbefehl aktualisiert werden. |
|
215 .br |
|
216 Wurde keine \fIPasswort\fP angegeben wird \fBvmm\fP dieses im interaktiven |
|
217 Modus erfragen. |
|
218 .PP |
|
219 .nf |
|
220 Beispiel: |
|
221 |
|
222 \fBvmm up d.user@example.com 'A |\\/|0r3 5ecur3 P4s5\\/\\/0rd?'\fP |
|
223 .fi |
|
224 .TP |
|
225 \fBusertransport\fP (\fBut\fP) \fIAdresse\fP \fITransport\fP |
|
226 Mit diesem Unterbefehl kann ein abweichender \fITransport\fP für das Konto mit |
|
227 der angegebenen \fIAdresse\fP festgelegt werden. |
|
228 .PP |
|
229 .nf |
|
230 Beispiel: |
|
231 |
|
232 \fBvmm ut d.user@example.com smtp:pc105.it.example.com\fP |
|
233 .fi |
|
234 .TP |
|
235 \fBuserdisable\fP (\fBu0\fP) \fIAdresse\fP [ \fIsmtp\fP | \fIpop3\fP | \fIimap\fP | \fImanagesieve\fP | \fIall\fP ] |
|
236 Soll ein Anwender keinen Zugriff auf einen oder alle Service haben, kann der |
|
237 Zugriff mit diesem Unterbefehl beschränkt werden. |
|
238 .br |
|
239 Wurde weder der Name eines Services noch das Schlüsselwort '\fIall\fP' |
|
240 angegeben, werden alle Service ('smtp', 'pop3', 'imap', und 'managesieve') für |
|
241 das Konto mit der angegebenen \fIAdresse\fP deaktiviert. |
|
242 .br |
|
243 Andernfalls wird nur der Zugriff auf den angegeben Service gesperrt. |
|
244 .PP |
|
245 .nf |
|
246 Beispiele: |
|
247 |
|
248 \fBvmm u0 b.user@example.com imap\fP |
|
249 \fBvmm userdisable c.user@example.com\fP |
|
250 .fi |
|
251 .TP |
|
252 \fBuserenable\fP (\fBu1\fP) \fIAdresse\fP [ \fIsmtp\fP | \fIpop3\fP | \fIimap\fP | \fImanagesieve\fP | \fIall\fP ] |
|
253 Um den Zugriff auf bestimmte oder alle gesperrten Service zu gewähren, wird |
|
254 dieser Unterbefehl verwendet. |
|
255 .br |
|
256 Wurde weder der Name eines Services noch das Schlüsselwort '\fIall\fP' |
|
257 angegeben, werden alle Service ('smtp', 'pop3', 'imap', und 'managesieve') für |
|
258 das Konto mit der angegebenen \fIAdresse\fP aktiviert. |
|
259 .br |
|
260 Andernfalls wird nur der Zugriff auf den angegeben Service gestattet. |
|
261 .TP |
|
262 \fBuserdelete\fP (\fBud\fP) \fIAdresse\fP |
|
263 Verwenden Sie diesen Unterbefehl um, das Konto mit der angegebenen \fIAdresse\fP |
|
264 zu löschen. |
|
265 .\" |
|
266 .SS ALIAS UNTERBEFEHLE |
|
267 .TP |
|
268 \fBaliasadd\fP (\fBaa\fP) \fIAlias\fP \fIZiel\fP |
|
269 Mit diesem Unterbefehl werden neue Aliase erstellt. |
|
270 .PP |
|
271 .nf |
|
272 Beispiele: |
|
273 |
|
274 \fBvmm aliasadd john.doe@example.com d.user@example.com\fP |
|
275 \fBvmm aa support@example.com d.user@example.com\fP |
|
276 \fBvmm aa support@example.com e.user@example.com\fP |
|
277 .fi |
|
278 .TP |
|
279 \fBaliasinfo\fP (\fBai\fP) \fIAlias\fP |
|
280 Informationen zu einem Alias können mit diesem Unterbefehl ausgegeben werden. |
|
281 .PP |
|
282 .nf |
|
283 Beispiel: |
|
284 |
|
285 \fBvmm aliasinfo support@example.com\fP |
|
286 Alias Informationen |
|
287 ------------------- |
|
288 E-Mails für support@example.com gehen an: |
|
289 -> d.user@example.com |
|
290 -> e.user@example.com |
|
291 .fi |
|
292 .TP |
|
293 \fBaliasdelete\fP (\fBad\fP) \fIAlias\fP [ \fIZiel\fP ] |
|
294 Verwenden Sie diesen Unterbefehl um den angegebenen \fIAlias\fP zu löschen. |
|
295 .br |
|
296 Wurde die optionale Ziel-Adresse \fIZiel\fP angegeben, so wird nur diese |
|
297 Ziel-Adresse vom angegebenen \fIAlias\fP entfernt. |
|
298 .PP |
|
299 .nf |
|
300 Beispiel: |
|
301 \fBvmm ad support@example.com d.user@example.com\fP |
|
302 .fi |
|
303 .SH DATEIEN |
|
304 /usr/local/etc/vmm.cfg |
|
305 .SH SIEHE AUCH |
|
306 vmm.cfg(5), Konfigurationsdatei für vmm |
|
307 .SH AUTOR |
|
308 \fBvmm\fP und die dazugehörigen Manualseiten wurden von Pascal Volk |
|
309 <\fIp.volk@veb-it.de\fP> geschrieben und sind unter den Bedingungen der BSD |
|
310 Lizenz lizenziert. |