|
1 ===== |
|
2 vmm |
|
3 ===== |
|
4 |
|
5 ----------------------------------------------------------------------------- |
|
6 Kommandozeilenprogramm zur Verwaltung von E-Mail-Domains, -Konten und -Aliase |
|
7 ----------------------------------------------------------------------------- |
|
8 |
|
9 :Author: Pascal Volk <neverseen@users.sourceforge.net> |
|
10 :Date: 2010-01-30 |
|
11 :Version: vmm-0.6.0 |
|
12 :Manual group: vmm Manual |
|
13 :Manual section: 1 |
|
14 |
|
15 .. contents:: |
|
16 :backlinks: top |
|
17 :class: htmlout |
|
18 |
|
19 SYNOPSIS |
|
20 ======== |
|
21 vmm *Unterbefehl* *Objekt* [ *Argumente* ] |
|
22 |
|
23 |
|
24 BESCHREIBUNG |
|
25 ============ |
|
26 **vmm** (a virtual mail manager) ist ein Kommandozeilenprogramm für |
|
27 Administratoren/Postmaster zur Verwaltung von (Alias-) Domains, Konten und |
|
28 Alias-Adressen. Es wurde entwickelt für Dovecot und Postfix mit einem |
|
29 PostgreSQL-Backend. |
|
30 |
|
31 |
|
32 UNTERBEFEHLE |
|
33 ============ |
|
34 Von jedem Unterbefehl gibt es jeweils eine lange und kurze Variante. Die |
|
35 Kurzform ist in Klammern geschrieben. Bei beiden Formen ist die |
|
36 Groß-/Kleinschreibung zu berücksichtigen. |
|
37 |
|
38 |
|
39 ALLGEMEINE UNTERBEFEHLE |
|
40 ----------------------- |
|
41 .. _configure: |
|
42 |
|
43 ``configure (cf) [ Sektion ]`` |
|
44 Startet den interaktiven Konfiguration-Modus für alle Sektionen der |
|
45 Konfiguration. |
|
46 |
|
47 Dabei wird der aktuell konfigurierte Wert einer jeden Option in eckigen |
|
48 Klammern ausgegeben. Sollte kein Wert konfiguriert sein, wird der |
|
49 Vorgabewert der jeweiligen Option in in eckigen Klammern angezeigt. Um den |
|
50 angezeigten Wert unverändert zu übernehmen, ist dieser mit der |
|
51 Eingabe-Taste zu bestätigen. |
|
52 |
|
53 Wurde das optionale Argument *Sektion* angegeben, werden nur die Optionen |
|
54 der angegebenen Sektion angezeigt und können geändert werden. Folgende |
|
55 Sektionen sind vorhanden: |
|
56 |
|
57 | - **account** |
|
58 | - **bin** |
|
59 | - **database** |
|
60 | - **domain** |
|
61 | - **maildir** |
|
62 | - **misc** |
|
63 |
|
64 Beispiel:: |
|
65 |
|
66 vmm configure domain |
|
67 Verwende Konfigurationsdatei: /usr/local/etc/vmm.cfg |
|
68 |
|
69 * Konfigurations Sektion: „domain“ |
|
70 Neuer Wert für Option directory_mode [504]: |
|
71 Neuer Wert für Option delete_directory [False]: 1 |
|
72 Neuer Wert für Option auto_postmaster [True]: |
|
73 Neuer Wert für Option force_deletion [False]: on |
|
74 |
|
75 .. _getuser: |
|
76 |
|
77 ``getuser (gu) userid`` |
|
78 Wenn nur eine UserID vorhanden ist, zum Beispiel aus der Prozessliste, |
|
79 kann mit dem Unterbefehl **getuser** die E-Mail-Adresse des Users |
|
80 ermittelt werden. |
|
81 |
|
82 Beispiel:: |
|
83 |
|
84 vmm getuser 70004 |
|
85 Account Informationen |
|
86 --------------------- |
|
87 UID............: 70004 |
|
88 GID............: 70000 |
|
89 Address........: c.user@example.com |
|
90 |
|
91 .. _listdomains: |
|
92 |
|
93 ``listdomains (ld) [ Muster ]`` |
|
94 Dieser Unterbefehl listet alle verfügbaren Domains auf. Allen Domains wird |
|
95 ein Präfix vorangestellt. Entweder ein '[+]', falls es sich um eine |
|
96 primäre Domain handelt, oder ein '[-]', falls es sich um eine Alias-Domain |
|
97 handelt. Die Ausgabe kann reduziert werden, indem ein optionales *Muster* |
|
98 angegeben wird. |
|
99 |
|
100 Um eine Wildcard-Suche durchzuführen kann das **%**-Zeichen am Anfang |
|
101 und/oder Ende des *Musters* verwendet werden. |
|
102 |
|
103 Beispiel:: |
|
104 |
|
105 vmm listdomains %example% |
|
106 Übereinstimmende Domains |
|
107 ------------------------ |
|
108 [+] example.com |
|
109 [-] e.g.example.com |
|
110 [-] example.name |
|
111 [+] example.net |
|
112 [+] example.org |
|
113 |
|
114 .. _help: |
|
115 |
|
116 ``help (h)`` |
|
117 Dieser Unterbefehl gibt alle verfügbaren Kommandos auf der Standardausgabe |
|
118 (stdout) aus. Danach beendet sich **vmm**. |
|
119 |
|
120 .. _version: |
|
121 |
|
122 ``version (v)`` |
|
123 Gibt Versionsinformationen zu **vmm** aus. |
|
124 |
|
125 DOMAIN UNTERBEFEHLE |
|
126 ------------------- |
|
127 .. _domainadd: |
|
128 |
|
129 ``domainadd (da) Domain [ Transport ]`` |
|
130 Fügt eine neue *Domain* in die Datenbank ein und erstellt das |
|
131 Domain-Verzeichnis. |
|
132 |
|
133 Ist das optionale Argument *Transport* angegeben, wird der |
|
134 Vorgabe-Transport (|misc.transport|_) aus |vmm.cfg(5)|_ für diese *Domain* |
|
135 ignoriert und der angegebene *Transport* verwendet. Der angegebene |
|
136 *Transport* ist gleichzeitig der Vorgabe-Transport für alle neuen Konten, |
|
137 die unter dieser Domain eingerichtet werden. |
|
138 |
|
139 Beispiele:: |
|
140 |
|
141 vmm domainadd support.example.com smtp:mx1.example.com |
|
142 vmm domainadd sales.example.com |
|
143 |
|
144 .. _domaininfo: |
|
145 |
|
146 ``domaininfo (di) Domain [ Details ]`` |
|
147 Dieser Unterbefehl zeigt Information zur angegeben *Domain* an. |
|
148 |
|
149 Um detaillierte Informationen über die *Domain* zu erhalten, kann das |
|
150 optionale Argument *Details* angegeben werden. Ein möglicher Wert für |
|
151 *Details* kann eines der folgenden fünf Schlüsselwörter sein: |
|
152 |
|
153 ``accounts`` |
|
154 um alle existierenden Konten aufzulisten |
|
155 ``aliasdomains`` |
|
156 um alle zugeordneten Alias-Domains aufzulisten |
|
157 ``aliases`` |
|
158 um alle verfügbaren Alias-Adressen aufzulisten |
|
159 ``relocated`` |
|
160 um alle Adressen der relocated Users aufzulisten |
|
161 ``full`` |
|
162 um alle oben genannten Informationen aufzulisten |
|
163 |
|
164 Beispiel:: |
|
165 |
|
166 vmm domaininfo sales.example.com |
|
167 Domain Informationen |
|
168 -------------------- |
|
169 Domainname.....: sales.example.com |
|
170 GID............: 70002 |
|
171 Transport......: dovecot: |
|
172 Domaindir......: /home/mail/5/70002 |
|
173 Aliasdomains...: 0 |
|
174 Accounts.......: 0 |
|
175 Aliases........: 0 |
|
176 Relocated......: 0 |
|
177 |
|
178 .. _domaintransport: |
|
179 |
|
180 ``domaintransport (dt) Domain Transport [ force ]`` |
|
181 Ein neuer *Transport* für die angegebene *Domain* kann mit diesem |
|
182 Unterbefehl festgelegt werden. |
|
183 |
|
184 Wurde das optionale Schlüsselwort **force** angegeben, so werden alle |
|
185 bisherigen Transport-Einstellungen, der in dieser Domain vorhandenen |
|
186 Konten, mit dem neuen *Transport* überschrieben. |
|
187 |
|
188 Andernfalls gilt der neue *Transport* nur für Konten, die zukünftig |
|
189 erstellt werden. |
|
190 |
|
191 Beispiel:: |
|
192 |
|
193 vmm domaintransport support.example.com dovecot: |
|
194 |
|
195 .. _domaindelete: |
|
196 |
|
197 ``domaindelete (dd) Domain [ delalias | deluser | delall ]`` |
|
198 Mit diesem Unterbefehl wird die angegebene *Domain* gelöscht. |
|
199 |
|
200 Sollten der *Domain* Konten und/oder Aliase zugeordnet sein, wird **vmm** |
|
201 die Ausführung des Befehls mit einer entsprechenden Fehlermeldung beenden. |
|
202 |
|
203 Sollten Sie sich Ihres Vorhabens sicher sein, so kann optional eines der |
|
204 folgenden Schlüsselwörter angegeben werden: **delalias**, **deluser** |
|
205 oder **delall**. |
|
206 |
|
207 Sollten Sie wirklich immer wissen was Sie tun, so editieren Sie Ihre |
|
208 *vmm.cfg* und setzen den Wert der Option |domain.force_deletion|_ auf |
|
209 true. Dann werden Sie beim Löschen von Domains nicht mehr wegen vorhanden |
|
210 Konten/Aliase gewarnt. |
|
211 |
|
212 |
|
213 ALIAS-DOMAIN UNTERBEFEHLE |
|
214 ------------------------- |
|
215 .. _aliasdomainadd: |
|
216 |
|
217 ``aliasdomainadd (ada) Aliasdomain Zieldomain`` |
|
218 Mit diesem Unterbefehl wird der *Zieldomain* die Alias-Domain |
|
219 *Aliasdomain* zugewiesen. |
|
220 |
|
221 Beispiel:: |
|
222 |
|
223 vmm aliasdomainadd example.name example.com |
|
224 |
|
225 .. _aliasdomaininfo: |
|
226 |
|
227 ``aliasdomaininfo (adi) Aliasdomain`` |
|
228 Dieser Unterbefehl informiert darüber, welcher Domain die Alias-Domain |
|
229 *Aliasdomain* zugeordnet ist. |
|
230 |
|
231 Beispiel:: |
|
232 |
|
233 vmm aliasdomaininfo example.name |
|
234 Alias-Domain Informationen |
|
235 -------------------------- |
|
236 Die Alias-Domain example.name gehört zu: |
|
237 * example.com |
|
238 |
|
239 .. _aliasdomainswitch: |
|
240 |
|
241 ``aliasdomainswitch (ads) Aliasdomain Zieldomain`` |
|
242 Wenn das Ziel der vorhandenen *Aliasdomain* auf eine andere *Zieldomain* |
|
243 geändert werden soll, ist dieser Unterbefehl zu verwenden. |
|
244 |
|
245 Beispiel:: |
|
246 |
|
247 vmm aliasdomainswitch example.name example.org |
|
248 |
|
249 .. _aliasdomaindelete: |
|
250 |
|
251 ``aliasdomaindelete (add) Aliasdomain`` |
|
252 Wenn die Alias-Domain mit dem Namen *Aliasdomain* gelöscht werden soll, |
|
253 ist dieser Unterbefehl zu verwenden. |
|
254 |
|
255 Beispiel:: |
|
256 |
|
257 vmm aliasdomaindelete e.g.example.com |
|
258 |
|
259 |
|
260 KONTO UNTERBEFEHLE |
|
261 ------------------ |
|
262 .. _useradd: |
|
263 |
|
264 ``useradd (ua) Adresse [ Passwort ]`` |
|
265 Mit diesem Unterbefehl wird ein neues Konto für die angegebene *Adresse* |
|
266 angelegt. |
|
267 |
|
268 Wurde kein *Passwort* angegeben wird **vmm** dieses im interaktiven Modus |
|
269 erfragen. |
|
270 |
|
271 Beispiele:: |
|
272 |
|
273 vmm ua d.user@example.com 'A 5ecR3t P4s5\\/\\/0rd' |
|
274 vmm ua e.user@example.com |
|
275 Neues Passwort eingeben: |
|
276 Neues Passwort wiederholen: |
|
277 |
|
278 .. _userinfo: |
|
279 |
|
280 ``userinfo (ui) Adresse [ Details ]`` |
|
281 Dieser Unterbefehl zeigt einige Informationen über das Konto mit der |
|
282 angegebenen *Adresse* an. |
|
283 |
|
284 Wurde das optionale Argument *Details* angegeben, werden weitere |
|
285 Informationen ausgegeben. Mögliche Werte für *Details* sind: |
|
286 |
|
287 ``aliases`` |
|
288 um alle Alias-Adressen, mit dem Ziel *Adresse*, aufzulisten |
|
289 ``du`` |
|
290 um zusätzlich die Festplattenbelegung des Maildirs eines Kontos |
|
291 anzuzeigen. Soll die Festplattenbelegung jedes Mal mit der **userinfo** |
|
292 ermittelt werden, ist in der *vmm.cfg* der Wert der Option |
|
293 |account.disk_usage|_ auf true zu setzen. |
|
294 ``full`` |
|
295 um alle oben genannten Informationen anzuzeigen |
|
296 |
|
297 .. _username: |
|
298 |
|
299 ``username (un) Adresse 'Bürgerlicher Name'`` |
|
300 Der Bürgerliche Name des Konto-Inhabers mit der angegebenen *Adresse* kann |
|
301 mit diesem Unterbefehl gesetzt/aktualisiert werden. |
|
302 |
|
303 Beispiel:: |
|
304 |
|
305 vmm un d.user@example.com 'John Doe' |
|
306 |
|
307 .. _userpassword: |
|
308 |
|
309 ``userpassword (up) Adresse [ Passwort ]`` |
|
310 Das *Passwort* eines Kontos kann mit diesem Unterbefehl aktualisiert |
|
311 werden. |
|
312 |
|
313 Wurde kein *Passwort* angegeben wird **vmm** dieses im interaktiven Modus |
|
314 erfragen. |
|
315 |
|
316 Beispiel:: |
|
317 |
|
318 vmm up d.user@example.com 'A |\\/|0r3 5ecur3 P4s5\\/\\/0rd?' |
|
319 |
|
320 .. _usertransport: |
|
321 |
|
322 ``usertransport (ut) Adresse Transport`` |
|
323 Mit diesem Unterbefehl kann ein abweichender *Transport* für das Konto mit |
|
324 der angegebenen *Adresse* bestimmt werden. |
|
325 |
|
326 Beispiel:: |
|
327 |
|
328 vmm ut d.user@example.com smtp:pc105.it.example.com |
|
329 |
|
330 .. _userdisable: |
|
331 |
|
332 ``userdisable (u0) Adresse [ Service ]`` |
|
333 Soll ein Anwender keinen Zugriff auf einen oder alle Service haben, kann |
|
334 der Zugriff mit diesem Unterbefehl beschränkt werden. |
|
335 |
|
336 Wurde weder ein *Service* noch das Schlüsselwort **all** angegeben, werden |
|
337 alle Services (**smtp**, **pop3**, **imap**, und **sieve**) für das Konto |
|
338 mit der angegebenen *Adresse* deaktiviert. |
|
339 |
|
340 Andernfalls wird nur der Zugriff auf den angegeben *Service* gesperrt. |
|
341 |
|
342 Beispiele:: |
|
343 |
|
344 vmm u0 b.user@example.com imap |
|
345 vmm userdisable c.user@example.com |
|
346 |
|
347 .. _userenable: |
|
348 |
|
349 ``userenable (u1) Adresse [ Service ]`` |
|
350 Um den Zugriff auf bestimmte oder alle gesperrten Service zu gewähren, |
|
351 wird dieser Unterbefehl verwendet. |
|
352 |
|
353 Wurde weder ein *Service* noch das Schlüsselwort **all** angegeben, werden |
|
354 alle Services (**smtp**, **pop3**, **imap**, und **sieve**) für das Konto |
|
355 mit der angegebenen *Adresse* aktiviert. |
|
356 |
|
357 Andernfalls wird nur der Zugriff auf den angegeben *Service* gestattet. |
|
358 |
|
359 .. _userdelete: |
|
360 |
|
361 ``userdelete (ud) Adresse [ delalias ]`` |
|
362 Verwenden Sie diesen Unterbefehl um, das Konto mit der angegebenen |
|
363 *Adresse* zu löschen. |
|
364 |
|
365 Sollte es einen oder mehrere Aliase geben, deren Zieladresse mit der |
|
366 *Adresse* des zu löschenden Kontos identisch ist, wird **vmm** die |
|
367 Ausführung des Befehls mit einer entsprechenden Fehlermeldung beenden. Um |
|
368 dieses zu umgehen, kann das optionale Schlüsselwort **delalias** |
|
369 angegebenen werden. |
|
370 |
|
371 |
|
372 ALIAS UNTERBEFEHLE |
|
373 ------------------ |
|
374 .. _aliasadd: |
|
375 |
|
376 ``aliasadd (aa) Alias Ziel`` |
|
377 Mit diesem Unterbefehl werden neue Aliase erstellt. |
|
378 |
|
379 Beispiele:: |
|
380 |
|
381 vmm aliasadd john.doe@example.com d.user@example.com |
|
382 vmm aa support@example.com d.user@example.com |
|
383 vmm aa support@example.com e.user@example.com |
|
384 |
|
385 .. _aliasinfo: |
|
386 |
|
387 ``aliasinfo (ai) Alias`` |
|
388 Informationen zu einem Alias können mit diesem Unterbefehl ausgegeben |
|
389 werden. |
|
390 |
|
391 Beispiel:: |
|
392 |
|
393 vmm aliasinfo support@example.com |
|
394 Alias Informationen |
|
395 ------------------- |
|
396 E-Mails für support@example.com werden weitergeleitet an: |
|
397 * d.user@example.com |
|
398 * e.user@example.com |
|
399 |
|
400 .. _aliasdelete: |
|
401 |
|
402 ``aliasdelete (ad) Alias [ Ziel ]`` |
|
403 Verwenden Sie diesen Unterbefehl um den angegebenen *Alias* zu löschen. |
|
404 |
|
405 Wurde die optionale Zieladresse *Ziel* angegeben, so wird nur diese |
|
406 Zieladresse vom angegebenen *Alias* entfernt. |
|
407 |
|
408 Beispiel:: |
|
409 |
|
410 vmm ad support@example.com d.user@example.com |
|
411 |
|
412 |
|
413 RELOCATED UNTERBEFEHLE |
|
414 ---------------------- |
|
415 .. _relocatedadd: |
|
416 |
|
417 ``relocatedadd (ra) alte_adresse neue_adresse`` |
|
418 Um einen neuen relocated User anzulegen kann dieser Unterbefehl verwendet |
|
419 werden. |
|
420 |
|
421 Dabei ist *alte_adresse* die ehemalige Adresse des Benutzers, zum Beispiel |
|
422 b.user@example.com, und *neue_adresse* die neue Adresse, unter der |
|
423 Benutzer erreichbar ist. |
|
424 |
|
425 Beispiel:: |
|
426 |
|
427 vmm relocatedadd b.user@example.com b-user@company.tld |
|
428 |
|
429 .. _relocatedinfo: |
|
430 |
|
431 ``relocatedinfo (ri) alte_adresse`` |
|
432 Dieser Unterbefehl zeigt die neue Adresse des relocated Users mit |
|
433 *alte_adresse*. |
|
434 |
|
435 Beispiel:: |
|
436 |
|
437 vmm relocatedinfo b.user@example.com |
|
438 Relocated Informationen |
|
439 ----------------------- |
|
440 Der Benutzer „b.user@example.com“ ist erreichbar unter „b-user@company.tld“ |
|
441 |
|
442 .. _relocateddelete: |
|
443 |
|
444 ``relocateddelete (rd) alte_adresse`` |
|
445 Mit diesem Unterbefehl kann der relocated User mit *alte_adresse* |
|
446 gelöscht werden. |
|
447 |
|
448 Beispiel:: |
|
449 |
|
450 vmm relocateddelete b.user@example.com |
|
451 |
|
452 |
|
453 DATEIEN |
|
454 ======= |
|
455 */root/vmm.cfg* |
|
456 | Wird verwendet, falls vorhanden. |
|
457 */usr/local/etc/vmm.cfg* |
|
458 | Wird verwendet, sollte obige Datei nicht gefunden werden. |
|
459 */etc/vmm.cfg* |
|
460 | Wird verwendet, falls obengenannte Dateien nicht existieren. |
|
461 |
|
462 |
|
463 SIEHE AUCH |
|
464 ========== |
|
465 |vmm.cfg(5)|_ |
|
466 |
|
467 |
|
468 COPYING |
|
469 ======= |
|
470 vmm und die dazugehörigen Manualseiten wurden von Pascal Volk geschrieben |
|
471 und sind unter den Bedingungen der BSD Lizenz lizenziert. |
|
472 |
|
473 .. include:: ../../substitute_links.rst |
|
474 .. include:: ../../substitute_links_1.rst |