# HG changeset patch # User Pascal Volk # Date 1264828521 0 # Node ID 3d09c657e9e5d1a24905715c49e5183c94a6064f # Parent 9480f2b151299e42d1fd276a95a6952d46a50da7 man: updated documentation … diff -r 9480f2b15129 -r 3d09c657e9e5 man/de/man1/vmm.1.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/man/de/man1/vmm.1.rst Sat Jan 30 05:15:21 2010 +0000 @@ -0,0 +1,474 @@ +===== + vmm +===== + +----------------------------------------------------------------------------- +Kommandozeilenprogramm zur Verwaltung von E-Mail-Domains, -Konten und -Aliase +----------------------------------------------------------------------------- + +:Author: Pascal Volk +:Date: 2010-01-30 +:Version: vmm-0.6.0 +:Manual group: vmm Manual +:Manual section: 1 + +.. contents:: + :backlinks: top + :class: htmlout + +SYNOPSIS +======== +vmm *Unterbefehl* *Objekt* [ *Argumente* ] + + +BESCHREIBUNG +============ +**vmm** (a virtual mail manager) ist ein Kommandozeilenprogramm für +Administratoren/Postmaster zur Verwaltung von (Alias-) Domains, Konten und +Alias-Adressen. Es wurde entwickelt für Dovecot und Postfix mit einem +PostgreSQL-Backend. + + +UNTERBEFEHLE +============ +Von jedem Unterbefehl gibt es jeweils eine lange und kurze Variante. Die +Kurzform ist in Klammern geschrieben. Bei beiden Formen ist die +Groß-/Kleinschreibung zu berücksichtigen. + + +ALLGEMEINE UNTERBEFEHLE +----------------------- +.. _configure: + +``configure (cf) [ Sektion ]`` + Startet den interaktiven Konfiguration-Modus für alle Sektionen der + Konfiguration. + + Dabei wird der aktuell konfigurierte Wert einer jeden Option in eckigen + Klammern ausgegeben. Sollte kein Wert konfiguriert sein, wird der + Vorgabewert der jeweiligen Option in in eckigen Klammern angezeigt. Um den + angezeigten Wert unverändert zu übernehmen, ist dieser mit der + Eingabe-Taste zu bestätigen. + + Wurde das optionale Argument *Sektion* angegeben, werden nur die Optionen + der angegebenen Sektion angezeigt und können geändert werden. Folgende + Sektionen sind vorhanden: + + | - **account** + | - **bin** + | - **database** + | - **domain** + | - **maildir** + | - **misc** + + Beispiel:: + + vmm configure domain + Verwende Konfigurationsdatei: /usr/local/etc/vmm.cfg + + * Konfigurations Sektion: „domain“ + Neuer Wert für Option directory_mode [504]: + Neuer Wert für Option delete_directory [False]: 1 + Neuer Wert für Option auto_postmaster [True]: + Neuer Wert für Option force_deletion [False]: on + +.. _getuser: + +``getuser (gu) userid`` + Wenn nur eine UserID vorhanden ist, zum Beispiel aus der Prozessliste, + kann mit dem Unterbefehl **getuser** die E-Mail-Adresse des Users + ermittelt werden. + + Beispiel:: + + vmm getuser 70004 + Account Informationen + --------------------- + UID............: 70004 + GID............: 70000 + Address........: c.user@example.com + +.. _listdomains: + +``listdomains (ld) [ Muster ]`` + Dieser Unterbefehl listet alle verfügbaren Domains auf. Allen Domains wird + ein Präfix vorangestellt. Entweder ein '[+]', falls es sich um eine + primäre Domain handelt, oder ein '[-]', falls es sich um eine Alias-Domain + handelt. Die Ausgabe kann reduziert werden, indem ein optionales *Muster* + angegeben wird. + + Um eine Wildcard-Suche durchzuführen kann das **%**-Zeichen am Anfang + und/oder Ende des *Musters* verwendet werden. + + Beispiel:: + + vmm listdomains %example% + Übereinstimmende Domains + ------------------------ + [+] example.com + [-] e.g.example.com + [-] example.name + [+] example.net + [+] example.org + +.. _help: + +``help (h)`` + Dieser Unterbefehl gibt alle verfügbaren Kommandos auf der Standardausgabe + (stdout) aus. Danach beendet sich **vmm**. + +.. _version: + +``version (v)`` + Gibt Versionsinformationen zu **vmm** aus. + +DOMAIN UNTERBEFEHLE +------------------- +.. _domainadd: + +``domainadd (da) Domain [ Transport ]`` + Fügt eine neue *Domain* in die Datenbank ein und erstellt das + Domain-Verzeichnis. + + Ist das optionale Argument *Transport* angegeben, wird der + Vorgabe-Transport (|misc.transport|_) aus |vmm.cfg(5)|_ für diese *Domain* + ignoriert und der angegebene *Transport* verwendet. Der angegebene + *Transport* ist gleichzeitig der Vorgabe-Transport für alle neuen Konten, + die unter dieser Domain eingerichtet werden. + + Beispiele:: + + vmm domainadd support.example.com smtp:mx1.example.com + vmm domainadd sales.example.com + +.. _domaininfo: + +``domaininfo (di) Domain [ Details ]`` + Dieser Unterbefehl zeigt Information zur angegeben *Domain* an. + + Um detaillierte Informationen über die *Domain* zu erhalten, kann das + optionale Argument *Details* angegeben werden. Ein möglicher Wert für + *Details* kann eines der folgenden fünf Schlüsselwörter sein: + + ``accounts`` + um alle existierenden Konten aufzulisten + ``aliasdomains`` + um alle zugeordneten Alias-Domains aufzulisten + ``aliases`` + um alle verfügbaren Alias-Adressen aufzulisten + ``relocated`` + um alle Adressen der relocated Users aufzulisten + ``full`` + um alle oben genannten Informationen aufzulisten + + Beispiel:: + + vmm domaininfo sales.example.com + Domain Informationen + -------------------- + Domainname.....: sales.example.com + GID............: 70002 + Transport......: dovecot: + Domaindir......: /home/mail/5/70002 + Aliasdomains...: 0 + Accounts.......: 0 + Aliases........: 0 + Relocated......: 0 + +.. _domaintransport: + +``domaintransport (dt) Domain Transport [ force ]`` + Ein neuer *Transport* für die angegebene *Domain* kann mit diesem + Unterbefehl festgelegt werden. + + Wurde das optionale Schlüsselwort **force** angegeben, so werden alle + bisherigen Transport-Einstellungen, der in dieser Domain vorhandenen + Konten, mit dem neuen *Transport* überschrieben. + + Andernfalls gilt der neue *Transport* nur für Konten, die zukünftig + erstellt werden. + + Beispiel:: + + vmm domaintransport support.example.com dovecot: + +.. _domaindelete: + +``domaindelete (dd) Domain [ delalias | deluser | delall ]`` + Mit diesem Unterbefehl wird die angegebene *Domain* gelöscht. + + Sollten der *Domain* Konten und/oder Aliase zugeordnet sein, wird **vmm** + die Ausführung des Befehls mit einer entsprechenden Fehlermeldung beenden. + + Sollten Sie sich Ihres Vorhabens sicher sein, so kann optional eines der + folgenden Schlüsselwörter angegeben werden: **delalias**, **deluser** + oder **delall**. + + Sollten Sie wirklich immer wissen was Sie tun, so editieren Sie Ihre + *vmm.cfg* und setzen den Wert der Option |domain.force_deletion|_ auf + true. Dann werden Sie beim Löschen von Domains nicht mehr wegen vorhanden + Konten/Aliase gewarnt. + + +ALIAS-DOMAIN UNTERBEFEHLE +------------------------- +.. _aliasdomainadd: + +``aliasdomainadd (ada) Aliasdomain Zieldomain`` + Mit diesem Unterbefehl wird der *Zieldomain* die Alias-Domain + *Aliasdomain* zugewiesen. + + Beispiel:: + + vmm aliasdomainadd example.name example.com + +.. _aliasdomaininfo: + +``aliasdomaininfo (adi) Aliasdomain`` + Dieser Unterbefehl informiert darüber, welcher Domain die Alias-Domain + *Aliasdomain* zugeordnet ist. + + Beispiel:: + + vmm aliasdomaininfo example.name + Alias-Domain Informationen + -------------------------- + Die Alias-Domain example.name gehört zu: + * example.com + +.. _aliasdomainswitch: + +``aliasdomainswitch (ads) Aliasdomain Zieldomain`` + Wenn das Ziel der vorhandenen *Aliasdomain* auf eine andere *Zieldomain* + geändert werden soll, ist dieser Unterbefehl zu verwenden. + + Beispiel:: + + vmm aliasdomainswitch example.name example.org + +.. _aliasdomaindelete: + +``aliasdomaindelete (add) Aliasdomain`` + Wenn die Alias-Domain mit dem Namen *Aliasdomain* gelöscht werden soll, + ist dieser Unterbefehl zu verwenden. + + Beispiel:: + + vmm aliasdomaindelete e.g.example.com + + +KONTO UNTERBEFEHLE +------------------ +.. _useradd: + +``useradd (ua) Adresse [ Passwort ]`` + Mit diesem Unterbefehl wird ein neues Konto für die angegebene *Adresse* + angelegt. + + Wurde kein *Passwort* angegeben wird **vmm** dieses im interaktiven Modus + erfragen. + + Beispiele:: + + vmm ua d.user@example.com 'A 5ecR3t P4s5\\/\\/0rd' + vmm ua e.user@example.com + Neues Passwort eingeben: + Neues Passwort wiederholen: + +.. _userinfo: + +``userinfo (ui) Adresse [ Details ]`` + Dieser Unterbefehl zeigt einige Informationen über das Konto mit der + angegebenen *Adresse* an. + + Wurde das optionale Argument *Details* angegeben, werden weitere + Informationen ausgegeben. Mögliche Werte für *Details* sind: + + ``aliases`` + um alle Alias-Adressen, mit dem Ziel *Adresse*, aufzulisten + ``du`` + um zusätzlich die Festplattenbelegung des Maildirs eines Kontos + anzuzeigen. Soll die Festplattenbelegung jedes Mal mit der **userinfo** + ermittelt werden, ist in der *vmm.cfg* der Wert der Option + |account.disk_usage|_ auf true zu setzen. + ``full`` + um alle oben genannten Informationen anzuzeigen + +.. _username: + +``username (un) Adresse 'Bürgerlicher Name'`` + Der Bürgerliche Name des Konto-Inhabers mit der angegebenen *Adresse* kann + mit diesem Unterbefehl gesetzt/aktualisiert werden. + + Beispiel:: + + vmm un d.user@example.com 'John Doe' + +.. _userpassword: + +``userpassword (up) Adresse [ Passwort ]`` + Das *Passwort* eines Kontos kann mit diesem Unterbefehl aktualisiert + werden. + + Wurde kein *Passwort* angegeben wird **vmm** dieses im interaktiven Modus + erfragen. + + Beispiel:: + + vmm up d.user@example.com 'A |\\/|0r3 5ecur3 P4s5\\/\\/0rd?' + +.. _usertransport: + +``usertransport (ut) Adresse Transport`` + Mit diesem Unterbefehl kann ein abweichender *Transport* für das Konto mit + der angegebenen *Adresse* bestimmt werden. + + Beispiel:: + + vmm ut d.user@example.com smtp:pc105.it.example.com + +.. _userdisable: + +``userdisable (u0) Adresse [ Service ]`` + Soll ein Anwender keinen Zugriff auf einen oder alle Service haben, kann + der Zugriff mit diesem Unterbefehl beschränkt werden. + + Wurde weder ein *Service* noch das Schlüsselwort **all** angegeben, werden + alle Services (**smtp**, **pop3**, **imap**, und **sieve**) für das Konto + mit der angegebenen *Adresse* deaktiviert. + + Andernfalls wird nur der Zugriff auf den angegeben *Service* gesperrt. + + Beispiele:: + + vmm u0 b.user@example.com imap + vmm userdisable c.user@example.com + +.. _userenable: + +``userenable (u1) Adresse [ Service ]`` + Um den Zugriff auf bestimmte oder alle gesperrten Service zu gewähren, + wird dieser Unterbefehl verwendet. + + Wurde weder ein *Service* noch das Schlüsselwort **all** angegeben, werden + alle Services (**smtp**, **pop3**, **imap**, und **sieve**) für das Konto + mit der angegebenen *Adresse* aktiviert. + + Andernfalls wird nur der Zugriff auf den angegeben *Service* gestattet. + +.. _userdelete: + +``userdelete (ud) Adresse [ delalias ]`` + Verwenden Sie diesen Unterbefehl um, das Konto mit der angegebenen + *Adresse* zu löschen. + + Sollte es einen oder mehrere Aliase geben, deren Zieladresse mit der + *Adresse* des zu löschenden Kontos identisch ist, wird **vmm** die + Ausführung des Befehls mit einer entsprechenden Fehlermeldung beenden. Um + dieses zu umgehen, kann das optionale Schlüsselwort **delalias** + angegebenen werden. + + +ALIAS UNTERBEFEHLE +------------------ +.. _aliasadd: + +``aliasadd (aa) Alias Ziel`` + Mit diesem Unterbefehl werden neue Aliase erstellt. + + Beispiele:: + + vmm aliasadd john.doe@example.com d.user@example.com + vmm aa support@example.com d.user@example.com + vmm aa support@example.com e.user@example.com + +.. _aliasinfo: + +``aliasinfo (ai) Alias`` + Informationen zu einem Alias können mit diesem Unterbefehl ausgegeben + werden. + + Beispiel:: + + vmm aliasinfo support@example.com + Alias Informationen + ------------------- + E-Mails für support@example.com werden weitergeleitet an: + * d.user@example.com + * e.user@example.com + +.. _aliasdelete: + +``aliasdelete (ad) Alias [ Ziel ]`` + Verwenden Sie diesen Unterbefehl um den angegebenen *Alias* zu löschen. + + Wurde die optionale Zieladresse *Ziel* angegeben, so wird nur diese + Zieladresse vom angegebenen *Alias* entfernt. + + Beispiel:: + + vmm ad support@example.com d.user@example.com + + +RELOCATED UNTERBEFEHLE +---------------------- +.. _relocatedadd: + +``relocatedadd (ra) alte_adresse neue_adresse`` + Um einen neuen relocated User anzulegen kann dieser Unterbefehl verwendet + werden. + + Dabei ist *alte_adresse* die ehemalige Adresse des Benutzers, zum Beispiel + b.user@example.com, und *neue_adresse* die neue Adresse, unter der + Benutzer erreichbar ist. + + Beispiel:: + + vmm relocatedadd b.user@example.com b-user@company.tld + +.. _relocatedinfo: + +``relocatedinfo (ri) alte_adresse`` + Dieser Unterbefehl zeigt die neue Adresse des relocated Users mit + *alte_adresse*. + + Beispiel:: + + vmm relocatedinfo b.user@example.com + Relocated Informationen + ----------------------- + Der Benutzer „b.user@example.com“ ist erreichbar unter „b-user@company.tld“ + +.. _relocateddelete: + +``relocateddelete (rd) alte_adresse`` + Mit diesem Unterbefehl kann der relocated User mit *alte_adresse* + gelöscht werden. + + Beispiel:: + + vmm relocateddelete b.user@example.com + + +DATEIEN +======= +*/root/vmm.cfg* + | Wird verwendet, falls vorhanden. +*/usr/local/etc/vmm.cfg* + | Wird verwendet, sollte obige Datei nicht gefunden werden. +*/etc/vmm.cfg* + | Wird verwendet, falls obengenannte Dateien nicht existieren. + + +SIEHE AUCH +========== +|vmm.cfg(5)|_ + + +COPYING +======= +vmm und die dazugehörigen Manualseiten wurden von Pascal Volk geschrieben +und sind unter den Bedingungen der BSD Lizenz lizenziert. + +.. include:: ../../substitute_links.rst +.. include:: ../../substitute_links_1.rst diff -r 9480f2b15129 -r 3d09c657e9e5 man/de/man5/vmm.cfg.5.rst --- a/man/de/man5/vmm.cfg.5.rst Fri Jan 29 23:56:45 2010 +0000 +++ b/man/de/man5/vmm.cfg.5.rst Sat Jan 30 05:15:21 2010 +0000 @@ -7,22 +7,23 @@ --------------------------- :Author: Pascal Volk -:Date: 2010-01-26 +:Date: 2010-01-30 :Version: vmm-0.6.0 :Manual group: vmm Manual :Manual section: 5 .. contents:: - :backlinks: top - :class: htmlout + :backlinks: top + :class: htmlout SYNOPSIS ======== vmm.cfg + BESCHREIBUNG ============ -**vmm**\(1) liest seine Konfigurationsparameter aus der Datei *vmm.cfg*. +|vmm(1)|_ liest seine Konfigurationsparameter aus der Datei *vmm.cfg*. Die Konfigurationsdatei ist in mehrere Sektionen unterteilt. Jede Sektion wird mit dem in eckigen Klammern '**[**' und '**]**' eingefassten Namen der @@ -58,274 +59,360 @@ Eine minimale *vmm.cfg* könnte so aussehen:: - [database] - user = ich - pass = xxxxxxxx + [database] + user = ich + pass = xxxxxxxx - [config] - done = true + [config] + done = true + SUCHREIHENFOLGE --------------- -Standardmäßig sucht **vmm**\(1) die *vmm.cfg* in folgenden Verzeichnissen, +Standardmäßig sucht |vmm(1)|_ die *vmm.cfg* in folgenden Verzeichnissen, in der angegebenen Reihenfolge: - | */root* - | */usr/local/etc* - | */etc* + | */root* + | */usr/local/etc* + | */etc* Die zuerst gefundene Datei wird verwendet. + SEKTIONEN ========= Im Folgenden werden die Sektionen der *vmm.cfg* und deren Optionen beschrieben. + ACCOUNT ------- -Die Optionen der Sektion **account** legen Konto-spezifische -Einstellungen fest. +Die Optionen der Sektion **account** legen Konto-spezifische Einstellungen +fest. + +.. _account.delete_directory: ``delete_directory (Vorgabe: false)`` : *Boolean* - Bestimmt das Verhalten von **vmm**\(1) beim Löschen eines Kontos. - Wenn der Wert dieser Option *true* ist, wird das Home-Verzeichnis des - zu löschenden Anwenders rekursiv gelöscht. + Bestimmt das Verhalten von |vmm(1)|_ beim Löschen eines Kontos + (|userdelete|_). Wenn der Wert dieser Option *true* ist, wird das + Home-Verzeichnis des zu löschenden Anwenders rekursiv gelöscht. + +.. _account.directory_mode: ``directory_mode (Vorgabe: 448)`` : *Int* - Zugriffsbits des Home-Verzeichnisses, sowie aller enthaltenen - Verzeichnisse, in Dezimal-Schreibweise (Basis 10). + Zugriffsbits des Home-Verzeichnisses, sowie aller enthaltenen + Verzeichnisse, in Dezimal-Schreibweise (Basis 10). - | Beispiel: 'drwx------' -> oktal 0700 -> dezimal 448 + | Beispiel: 'drwx------' -> oktal 0700 -> dezimal 448 + +.. _account.disk_usage: ``disk_usage (Vorgabe: false)`` : *Boolean* - Legt fest, ob die Festplattenbelegung des Maildirs eines Benutzers jedes - Mal mit **du**\(1) ermittelt und mit den Konto-Informationen ausgegeben - werden soll. + Legt fest, ob die Festplattenbelegung des Maildirs eines Benutzers jedes + Mal mit **du**\(1) ermittelt und mit den Konto-Informationen ausgegeben + werden soll. - Bei umfangreichen Maildirs kann das langsam sein. Falls Sie Quotas - aktiviert haben, wird der **vmm**-Unterbefehl **userinfo** ebenfalls - die aktuelle Quota-Nutzung des Kontos mit ausgegeben. Sie können auch - eines der optionalen Argumente **du** oder **full** an **userinfo** - übergeben, um sich die aktuelle Festplattenbelegung anzeigen zu lassen. + Bei umfangreichen Maildirs kann das langsam sein. Falls Sie Quotas + aktiviert haben, wird der **vmm**-Unterbefehl |userinfo|_ ebenfalls die + aktuelle Quota-Nutzung des Kontos mit ausgegeben. Sie können auch eines + der optionalen Argumente **du** oder **full** an |userinfo|_ übergeben, + um sich die aktuelle Festplattenbelegung anzeigen zu lassen. + +.. _account.imap: ``imap (Vorgabe: true)`` : *Boolean* - Bestimmt, ob sich neu angelegte Benutzer per IMAP anmelden können sollen. + Bestimmt, ob sich neu angelegte Benutzer per IMAP anmelden können sollen. + +.. _account.password_length: ``password_length (Vorgabe: 8)`` : *Int* - Diese Option legt die Anzahl der Zeichen für automatisch erzeugte - Passwörter fest. Alle Werte kleiner als 8 werden auf 8 erhöht. + Diese Option legt die Anzahl der Zeichen für automatisch erzeugte + Passwörter fest. Alle Werte kleiner als 8 werden auf 8 erhöht. + +.. _account.pop3: ``pop3 (Vorgabe: true)`` : *Boolean* - Bestimmt, ob sich neu angelegte Benutzer per POP3 anmelden können sollen. + Bestimmt, ob sich neu angelegte Benutzer per POP3 anmelden können sollen. + +.. _account.random_password: ``random_password (Vorgabe: false)`` : *Boolean* - Mit dieser Option wird bestimmt , ob **vmm**\(1) ein zufälliges Passwort - generieren soll, wenn kein Passwort an den **useradd** Unterbefehl - übergeben wurde. Ist der Wert dieser Option *false*, wird **vmm** Sie - auffordern, ein Passwort für den neun Account einzugeben. + Mit dieser Option wird bestimmt , ob **vmm** ein zufälliges Passwort + generieren soll, wenn kein Passwort an den Unterbefehl |useradd|_ + übergeben wurde. Ist der Wert dieser Option *false*, wird **vmm** Sie + auffordern, ein Passwort für den neun Account einzugeben. - Sie können die Länge für automatisch generierte Passwörter mit der - Option **password_length** konfigurieren. + Sie können die Länge für automatisch generierte Passwörter mit der Option + |account.password_length|_ konfigurieren. + +.. _account.sieve: ``sieve (Vorgabe: true)`` : *Boolean* - Bestimmt, ob sich neu angelegte Benutzer per ManageSieve anmelden - können sollen. + Bestimmt, ob sich neu angelegte Benutzer per ManageSieve anmelden können + sollen. + +.. _account.smtp: ``smtp (Vorgabe: true)`` : *Boolean* - Bestimmt, ob sich neu angelegte Benutzer per SMTP (SMTP AUTH) anmelden - können sollen. + Bestimmt, ob sich neu angelegte Benutzer per SMTP (SMTP AUTH) anmelden + können sollen. Beispiel:: - [account] - delete_directory = false - directory_mode = 448 - disk_usage = false - random_password = true - password_length = 10 - smtp = true - pop3 = true - imap = true - sieve = true + [account] + delete_directory = false + directory_mode = 448 + disk_usage = false + random_password = true + password_length = 10 + smtp = true + pop3 = true + imap = true + sieve = true + BIN --- -In der **bin**-Sektion werden die Pfade zu den von **vmm**\(1) benötigten +In der **bin**-Sektion werden die Pfade zu den von |vmm(1)|_ benötigten Binaries angegeben. +.. _bin.dovecotpw: + ``dovecotpw (Vorgabe: /usr/sbin/dovecotpw)`` : *String* - Der absolute Pfad zum dovecotpw Binary. Dieses Binary wird zur - Hash-Erzeugung verwendet, wenn **misc.password_scheme** einen der - nachfolgenden Werte hat: 'SMD5', 'SSHA', 'CRAM-MD5', 'HMAC-MD5', - 'LANMAN', 'NTLM' oder 'RPA'. + Der absolute Pfad zum dovecotpw Binary. Dieses Binary wird zur + Hash-Erzeugung verwendet, wenn |misc.password_scheme|_ einen der + nachfolgenden Werte hat: 'SMD5', 'SSHA', 'CRAM-MD5', 'HMAC-MD5', 'LANMAN', + 'NTLM' oder 'RPA'. + +.. _bin.du: ``du (Vorgabe: /usr/bin/du)`` : *String* - Der absolute Pfad zu **du**\(1). Dieses Binary wird verwendet, wenn - die Festplattenbelegung eines Kontos ermittelt wird. + Der absolute Pfad zu **du**\(1). Dieses Binary wird verwendet, wenn die + Festplattenbelegung eines Kontos ermittelt wird. + +.. _bin.postconf: ``postconf (Vorgabe: /usr/sbin/postconf)`` : *String* - Der absolute Pfad zu Postfix' **postconf**\(1). Dieses Binary wird - verwendet, wenn **vmm**\(1) diverse Postfix-Einstellungen prüft, zum - Beispiel das `virtual_alias_expansion_limit`. + Der absolute Pfad zu Postfix' |postconf(1)|_. Dieses Binary wird + verwendet, wenn |vmm(1)|_ diverse Postfix-Einstellungen prüft, zum + Beispiel das |virtual_alias_expansion_limit|_. Beispiel:: - [bin] - dovecotpw = /usr/sbin/dovecotpw - du = /usr/bin/du - postconf = /usr/sbin/postconf + [bin] + dovecotpw = /usr/sbin/dovecotpw + du = /usr/bin/du + postconf = /usr/sbin/postconf + CONFIG ------ -Bei der **config**-Sektion handelt es sich um einen internen +Bei der **config**-Sektion handelt es sich um eine interne Steuerungs-Sektion. +.. _config.done: + ``done (Vorgabe: false)`` : *Boolean* - Diese Option hat den Wert *false*, wenn **vmm**\(1) zum ersten Mal - installiert wurde. Wenn Sie die Datei *vmm.cfg* von Hand editieren, - weisen Sie dieser Option abschließend den Wert *true* zu. Wird die - Konfiguration über das Kommando **vmm configure** angepasst, wird der - Wert dieser Option automatisch auf *true* gesetzt. + Diese Option hat den Wert *false*, wenn |vmm(1)|_ zum ersten Mal + installiert wurde. Wenn Sie die Datei *vmm.cfg* von Hand editieren, weisen + Sie dieser Option abschließend den Wert *true* zu. Wird die Konfiguration + über das Kommando |vmm configure|_ angepasst, wird der Wert dieser Option + automatisch auf *true* gesetzt. - Ist der Wert dieser Option *false*, so startet **vmm**\(1) beim - nächsten Aufruf im interaktiven Konfigurations-Modus. + Ist der Wert dieser Option *false*, so startet |vmm(1)|_ beim nächsten + Aufruf im interaktiven Konfigurations-Modus. Beispiel:: - [config] - done = true + [config] + done = true + DATABASE -------- Die **database**-Sektion wird verwendet, um die für den Datenbankzugriff benötigten Optionen festzulegen. +.. _database.host: + ``host (Vorgabe: localhost)`` : *String* - Der Hostname oder die IP-Adresse des Datenbank-Servers. + Der Hostname oder die IP-Adresse des Datenbank-Servers. + +.. _database.name: ``name (Vorgabe: mailsys)`` : *String* - Der Name der zu verwendenden Datenbank. + Der Name der zu verwendenden Datenbank. + +.. _database.pass: ``pass (Vorgabe: Nichts)`` : *String* - Das Passwort des Datenbank-Benutzers. + Das Passwort des Datenbank-Benutzers. + +.. _database.user: ``user (Vorgabe: Nichts)`` : *String* - Der Name des Datenbank-Benutzers. + Der Name des Datenbank-Benutzers. Beispiel:: - [database] - host = localhost - user = vmm - pass = PY_SRJ}L/0p-oOk - name = mailsys + [database] + host = localhost + user = vmm + pass = PY_SRJ}L/0p-oOk + name = mailsys + DOMAIN ------ In der **domain**-Sektion werden Domain-spezifische Informationen konfiguriert. +.. _domain.auto_postmaster: + ``auto_postmaster (Vorgabe: true)`` : *Boolean* - Ist der Wert dieser Option *true*, wird **vmm**\(1) beim Anlegen einer - Domain automatisch einen postmaster-Account erstellen. + Ist der Wert dieser Option *true*, wird |vmm(1)|_ beim Anlegen einer + Domain (|domainadd|_) automatisch einen postmaster-Account erstellen. + +.. _domain.delete_directory: ``delete_directory (Vorgabe: false)`` : *Boolean* - Bestimmt, ob beim Löschen einer Domain das Verzeichnis einer Domain, - inklusive aller Anwender-Verzeichnisse, rekursiv gelöscht werden soll. + Bestimmt, ob beim Löschen einer Domain (|domaindelete|_) das Verzeichnis + der zu löschenden Domain, inklusive aller Anwender-Verzeichnisse, rekursiv + gelöscht werden soll. + +.. _domain.directory_mode: ``directory_mode (Vorgabe: 504)`` : *Int* - Zugriffsbits des Domain-Verzeichnisses in Dezimal-Schreibweise (Basis - 10). + Zugriffsbits des Domain-Verzeichnisses in Dezimal-Schreibweise (Basis 10). - | Beispiel: 'drwxrwx---' -> oktal 0770 -> dezimal 504 + | Beispiel: 'drwxrwx---' -> oktal 0770 -> dezimal 504 + +.. _domain.force_deletion: ``force_deletion (Vorgabe: false)`` : *Boolean* - Erzwingt das Löschen aller zugeordneten Konten und Aliase beim Löschen - einer Domain. + Erzwingt das Löschen aller zugeordneten Konten und Aliase beim Löschen + einer Domain (|domaindelete|_). Beispiel:: - [domain] - auto_postmaster = true - delete_directory = false - directory_mode = 504 - force_deletion = false + [domain] + auto_postmaster = true + delete_directory = false + directory_mode = 504 + force_deletion = false + MAILDIR ------- In der **maildir**-Sektion werden die für die Maildirs erforderlichen Optionen festgelegt. +.. _maildir.folders: + ``folders (Vorgabe: Drafts:Sent:Templates:Trash)`` : *String* - Eine durch Doppelpunkten getrennte Liste mit Verzeichnisnamen, die - innerhalb des Maildirs erstellt werden sollen. Sollen innerhalb des - Maildirs keine Verzeichnisse angelegt werden, ist dieser Optionen ein - einzelner Doppelpunkt ('**:**') als Wert zuzuweisen. + Eine durch Doppelpunkten getrennte Liste mit Verzeichnisnamen, die + innerhalb des Maildirs erstellt werden sollen. Sollen innerhalb des + Maildirs keine Verzeichnisse angelegt werden, ist dieser Optionen ein + einzelner Doppelpunkt ('**:**') als Wert zuzuweisen. - Sollen Verzeichnisse mit Unterverzeichnissen angelegt werden, ist ein - einzelner Punkt ('**.**') als Separator zu verwenden. + Sollen Verzeichnisse mit Unterverzeichnissen angelegt werden, ist ein + einzelner Punkt ('**.**') als Separator zu verwenden. + +.. _maildir.name: ``name (Vorgabe: Maildir)`` : *String* - Der Standard-Name des Maildir-Verzeichnisses im Verzeichnis des - jeweiligen Anwenders. + Der Standard-Name des Maildir-Verzeichnisses im Verzeichnis des jeweiligen + Anwenders. Beispiel:: - [maildir] - folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix - name = Maildir + [maildir] + folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix + name = Maildir + +.. _imap_uft7: + +.. note:: Sollen in der **folders**-Einstellung internationalisierte Namen + für Maildir-Verzeichnisse verwendet werden, sind diese in einer + modifizierten Variante des UTF-7-Zeichensatzes (siehe :RFC:`3501`, Sektion + 5.1.3) anzugeben. + + Dovecot stellt seit Version 1.2.0 das nützlich Hilfsprogramm **imap-utf7** + zur Verfügung. Dieses dient zur mUTF-7 <-> UTF-8 Konvertierung. +.. + +imap-utf7 Beispiel:: + + user@host:~$ /usr/local/libexec/dovecot/imap-utf7 -r Wysłane + Wys&AUI-ane + user@host:~$ /usr/local/libexec/dovecot/imap-utf7 "&AVo-mietnik" + Śmietnik + MISC ---- In der **misc**-Sektion werden verschiedene Einstellungen festgelegt. +.. _misc.base_directory: + ``base_directory (Vorgabe: /srv/mail)`` : *String* - Alle Domain-Verzeichnisse werden innerhalb dieses Basis-Verzeichnisses - angelegt. + Alle Domain-Verzeichnisse werden innerhalb dieses Basis-Verzeichnisses + angelegt. + +.. _misc.password_scheme: ``password_scheme (Vorgabe: CRAM-MD5)`` : *String* - Das zu verwendende Passwort-Schema (siehe auch: **dovecotpw -l**). + Das zu verwendende Passwort-Schema (siehe auch: **dovecotpw -l**). + +.. _misc.gid_mail: ``gid_mail (Vorgabe: 8)`` : *Int* - Die numerische Gruppen-ID der Gruppe mail, bzw. der Gruppe aus - `mail_privileged_group` der Datei *dovecot.conf*. + Die numerische Gruppen-ID der Gruppe mail, bzw. der Gruppe aus + `mail_privileged_group` der Datei *dovecot.conf*. + +.. _misc.transport: ``transport (Vorgabe: dovecot:)`` : *String* - Der Standard-Transport aller Domains und Konten. Siehe auch: - **transport**\(5) + Der Standard-Transport aller Domains und Konten. Siehe auch: + |transport(5)|_ + +.. _misc.dovecot_version: ``dovecot_version (Vorgabe: 12)`` : *Int* - Die verketteten Major- und Minor-Teile der eingesetzten Dovecot-Version - (siehe: **dovecot --version**). + Die verketteten Major- und Minor-Teile der eingesetzten Dovecot-Version + (siehe: **dovecot --version**). - Wenn das Kommando **dovecot --version** zum Beispiel *1.1.18* ausgibt, - ist dieser Option der Wert **11** zuzuweisen. + Wenn das Kommando **dovecot --version** zum Beispiel *1.1.18* ausgibt, ist + dieser Option der Wert **11** zuzuweisen. Beispiel:: - [misc] - base_directory = /srv/mail - password_scheme = PLAIN - gid_mail = 8 - transport = dovecot: - dovecot_version = 11 + [misc] + base_directory = /srv/mail + password_scheme = PLAIN + gid_mail = 8 + transport = dovecot: + dovecot_version = 11 + DATEIEN ======= */root/vmm.cfg* - | Wird verwendet, falls vorhanden. + | Wird verwendet, falls vorhanden. */usr/local/etc/vmm.cfg* - | Wird verwendet, sollte obige Datei nicht gefunden werden. + | Wird verwendet, sollte obige Datei nicht gefunden werden. */etc/vmm.cfg* - | Wird verwendet, falls obengenannte Dateien nicht existieren. + | Wird verwendet, falls obengenannte Dateien nicht existieren. SIEHE AUCH ========== -vmm(1), Programm für die Kommandozeile, um E-Mail-Domains, -Konten und -Aliase -zu verwalten. +|vmm(1)|_ + COPYING ======= vmm und die dazugehörigen Manualseiten wurden von Pascal Volk geschrieben und sind unter den Bedingungen der BSD Lizenz lizenziert. +.. include:: ../../substitute_links.rst +.. include:: ../../substitute_links_5.rst diff -r 9480f2b15129 -r 3d09c657e9e5 man/man1/vmm.1.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/man/man1/vmm.1.rst Sat Jan 30 05:15:21 2010 +0000 @@ -0,0 +1,445 @@ +===== + vmm +===== + +---------------------------------------------------------- +command line tool to manage email domains/accounts/aliases +---------------------------------------------------------- + +:Author: Pascal Volk +:Date: 2010-01-30 +:Version: vmm-0.6.0 +:Manual group: vmm Manual +:Manual section: 1 + +.. contents:: + :backlinks: top + :class: htmlout + +SYNOPSIS +======== +**vmm** *subcommand* *object* [ *arguments* ] + + +DESCRIPTION +=========== +**vmm** (a virtual mail manager) is a command line tool for +administrators/postmasters to manage (alias) domains, accounts and alias +addresses. It's designed for Dovecot and Postfix with a PostgreSQL backend. + + +SUBCOMMANDS +=========== +Each subcommand has both a long and a short form. The short form is shown +enclosed in parentheses. Both forms are case sensitive. + + +GENERAL SUBCOMMANDS +------------------- +.. _configure: + +``configure (cf) [ section ]`` + Starts the interactive configuration for all configuration sections. + + In this process the currently set value of each option will be shown in + square brackets. If no value is configured, the default value of each + option will be displayed in square brackets. Pres the enter key, to accept + the displayed value. + + If the optional argument *section* is given, only the configuration + options from the given section will be displayed and will be + configurable. The following sections are available: + + | - **account** + | - **bin** + | - **database** + | - **domain** + | - **maildir** + | - **misc** + + Example:: + + vmm configure domain + Using configuration file: /usr/local/etc/vmm.cfg + + * Configuration section: “domain” + Enter new value for option directory_mode [504]: + Enter new value for option delete_directory [True]: no + Enter new value for option auto_postmaster [True]: + Enter new value for option force_deletion [True]: off + +.. _getuser: + +``getuser (gu) userid`` + If only the *userid* is available, for example from process list, the + subcommand **getuser** will show the user's address. + + Example:: + + vmm getuser 70004 + Account information + ------------------- + UID............: 70004 + GID............: 70000 + Address........: c.user@example.com + +.. _listdomains: + +``listdomains (ld) [ pattern ]`` + This subcommand lists all available domains. All domain names will be + prefixed either with '[+]', if the domain is a primary domain, or with + '[-]', if it is an alias domain name. The output can be limited with an + optional *pattern*. + + To perform a wild card search, the **%** character can be used at the + start and/or the end of the *pattern*. + + Example:: + + vmm listdomains %example% + Matching domains + ---------------- + [+] example.com + [-] e.g.example.com + [-] example.name + [+] example.net + [+] example.org + +.. _help: + +``help (h)`` + Prints all available subcommands to stdout. After this **vmm** exits. + +.. _version: + +``version (v)`` + Prints the version information from **vmm**. + + +DOMAIN SUBCOMMANDS +------------------ +.. _domainadd: + +``domainadd (da) domain [ transport ]`` + Adds the new *domain* into the database and creates the domain directory. + + If the optional argument *transport* is given, it will overwrite the + default transport (|misc.transport|_) from |vmm.cfg(5)|_. The specified + *transport* will be the default transport for all new accounts in this + domain. + + Examples:: + + vmm domainadd support.example.com smtp:mx1.example.com + vmm domainadd sales.example.com + +.. _domaininfo: + +``domaininfo (di) domain [ details ]`` + This subcommand shows some information about the given *domain*. + + For a more detailed information about the *domain* the optional argument + *details* can be specified. A possible *details* value may be one of the + following five keywords: + + ``accounts`` + to list all existing accounts + ``aliasdomains`` + to list all assigned alias domains + ``aliases`` + to list all available aliases addresses + ``relocated`` + to list all relocated users + ``full`` + to list all information mentioned above + + Example:: + + vmm domaininfo sales.example.com + Domain information + ------------------ + Domainname.....: sales.example.com + GID............: 70002 + Transport......: dovecot: + Domaindir......: /home/mail/5/70002 + Aliasdomains...: 0 + Accounts.......: 0 + Aliases........: 0 + Relocated......: 0 + +.. _domaintransport: + +``domaintransport (dt) domain transport [ force ]`` + A new *transport* for the indicated *domain* can be set with this + subcommand. + + If the additional keyword **force** is given all account specific + transport settings will be overwritten. Otherwise this setting will affect + only new created accounts. + + Example:: + + vmm domaintransport support.example.com dovecot: + +.. _domaindelete: + +``domaindelete (dd) domain [ delalias | deluser | delall ]`` + This subcommand deletes the specified *domain*. + + If there are accounts and/or aliases assigned to the given domain, **vmm** + will abort the requested operation and show an error message. If you know, + what you are doing, you can specify one of the following keywords: + **delalias**, **deluser** or **delall**. + + If you really always know what you are doing, edit your *vmm.cfg* and set + the option |domain.force_deletion|_ to true. + + +ALIAS DOMAIN SUBCOMMANDS +------------------------ +.. _aliasdomainadd: + +``aliasdomainadd (ada) aliasdomain targetdomain`` + This subcommand adds the new *aliasdomain* to the *targetdomain* that + should be aliased. + + Example:: + + vmm aliasdomainadd example.name example.com + +.. _aliasdomaininfo: + +``aliasdomaininfo (adi) aliasdomain`` + This subcommand shows to which domain the *aliasdomain* is assigned to. + + Example:: + + vmm aliasdomaininfo example.name + Alias domain information + ------------------------ + The alias domain example.name belongs to: + * example.com + +.. _aliasdomainswitch: + +``aliasdomainswitch (ads) aliasdomain targetdomain`` + If the target of the existing *aliasdomain* should be switched to another + *targetdomain* use this subcommand. + + Example:: + + vmm aliasdomainswitch example.name example.org + +.. _aliasdomaindelete: + +``aliasdomaindelete (add) aliasdomain`` + Use this subcommand if the alias domain *aliasdomain* should be removed. + + Example:: + + vmm aliasdomaindelete e.g.example.com + + +ACCOUNT SUBCOMMANDS +------------------- +.. _useradd: + +``useradd (ua) address [ password ]`` + Use this subcommand to create a new email account for the given *address*. + + If the *password* is not provided, **vmm** will prompt for it + interactively. + + Examples:: + + vmm ua d.user@example.com 'A 5ecR3t P4s5\\/\\/0rd' + vmm ua e.user@example.com + Enter new password: + Retype new password: + +.. _userinfo: + +``userinfo (ui) address [ details ]`` + This subcommand displays some information about the account specified by + *address*. + + If the optional argument *details* is given some more information will be + displayed. Possible values for *details* are: + + ``aliases`` + to list all alias addresses with the destination *address* + ``du`` + to display the disk usage of a user's Maildir. In order to summarize the + disk usage each time the this subcommand is executed automatically, set + |account.disk_usage|_ in the *vmm.cfg* to true. + ``full`` + to list all information mentioned above + +.. _username: + +``username (un) address "User's Name"`` + The user's real name can be set/updated with this subcommand. + + Example:: + + vmm un d.user@example.com 'John Doe' + +.. _userpassword: + +``userpassword (up) address [ password ]`` + The *password* from an account can be updated with this subcommand. + + If the *password* is not provided, **vmm** will prompt for it + interactively. + + Example:: + + vmm up d.user@example.com 'A |\\/|0r3 5ecur3 P4s5\\/\\/0rd?' + +.. _usertransport: + +``usertransport (ut) address transport`` + A different *transport* for an account can be specified with this + subcommand. + + Example:: + + vmm ut d.user@example.com smtp:pc105.it.example.com + +.. _userdisable: + +``userdisable (u0) address [ service ]`` + If a user shouldn't have access to one or all services you can restrict + the access with this subcommand. + + If neither a *service* nor the keyword **all** is given all services + (**smtp**, **pop3**, **imap**, and **sieve**) will be disabled for the + account with the specified *address*. Otherwise only the specified + *service* will be restricted. + + Examples:: + + vmm u0 b.user@example.com imap + vmm userdisable c.user@example.com + +.. _userenable: + +``userenable (u1) address [ service ]`` + To allow access to one or all restricted services use this subcommand. + + If neither a *service* nor the keyword **all** is given all services + (**smtp**, **pop3**, **imap**, and **sieve**) will be enabled for the + account with the specified *address*. Otherwise only the specified + *service* will be enabled. + +.. _userdelete: + +``userdelete (ud) address [ delalias ]`` + Use this subcommand to delete the account with the given *address*. + + If there are one or more aliases with an identical destination *address*, + **vmm** will abort the requested operation and show an error message. To + prevent this, specify the optional keyword **delalias**. + + +ALIAS SUBCOMMANDS +----------------- +.. _aliasadd: + +``aliasadd (aa) alias target`` + This subcommand is used to create a new alias. + + Examples:: + + vmm aliasadd john.doe@example.com d.user@example.com + vmm aa support@example.com d.user@example.com + vmm aa support@example.com e.user@example.com + +.. _aliasinfo: + +``aliasinfo (ai) alias`` + Information about an alias can be displayed with this subcommand. + + Example:: + + vmm aliasinfo support@example.com + Alias information + ----------------- + Mail for support@example.com will be redirected to: + * d.user@example.com + * e.user@example.com + +.. _aliasdelete: + +``aliasdelete (ad) alias [ target ]`` + Use this subcommand to delete the *alias*. + + If the optional destination address *target* is given, only this + destination will be removed from the *alias*. + + Example:: + + vmm ad support@example.com d.user@example.com + + +RELOCATED SUBCOMMANDS +--------------------- +.. _relocatedadd: + +``relocatedadd (ra) old_address new_address`` + A new relocated user can be created with this subcommand. + + *old_address* is the users ex-email address, for example + b.user@example.com, and *new_address* points to the new email address + where the user can be reached. + + Example:: + + vmm relocatedadd b.user@example.com b-user@company.tld + +.. _relocatedinfo: + +``relocatedinfo (ri) old_address`` + This subcommand shows the new address of the relocated user with the + *old_address*. + + Example:: + + vmm relocatedinfo b.user@example.com + Relocated information + --------------------- + User “b.user@example.com” has moved to “b-user@company.tld” + +.. _relocateddelete: + +``relocateddelete (rd) old_address`` + Use this subcommand in order to delete the relocated user with the + *old_address*. + + Example:: + + vmm relocateddelete b.user@example.com + + +FILES +===== +*/root/vmm.cfg* + | will be used when found. +*/usr/local/etc/vmm.cfg* + | will be used when the above file doesn't exist. +*/etc/vmm.cfg* + | will be used when none of the both above mentioned files exists. + + +SEE ALSO +======== +|vmm.cfg(5)|_ + + +COPYING +======= +vmm and its manual pages were written by Pascal Volk and are licensed under +the terms of the BSD License. + +.. include:: ../substitute_links.rst +.. include:: ../substitute_links_1.rst diff -r 9480f2b15129 -r 3d09c657e9e5 man/man5/vmm.cfg.5.rst --- a/man/man5/vmm.cfg.5.rst Fri Jan 29 23:56:45 2010 +0000 +++ b/man/man5/vmm.cfg.5.rst Sat Jan 30 05:15:21 2010 +0000 @@ -7,22 +7,23 @@ -------------------------- :Author: Pascal Volk -:Date: 2010-01-26 +:Date: 2010-01-30 :Version: vmm-0.6.0 :Manual group: vmm Manual :Manual section: 5 .. contents:: - :backlinks: top - :class: htmlout + :backlinks: top + :class: htmlout SYNOPSIS ======== vmm.cfg + DESCRIPTION =========== -**vmm**\(1) reads its configuration data from *vmm.cfg*. +|vmm(1)|_ reads its configuration data from *vmm.cfg*. The configuration file is split into multiple sections. A section starts with the section name, enclosed in square brackets '**[**' and '**]**', followed @@ -54,261 +55,347 @@ A minimal *vmm.cfg* would be:: - [database] - user = me - pass = xxxxxxxx + [database] + user = me + pass = xxxxxxxx - [config] - done = true + [config] + done = true + SEARCH ORDER ------------- -By default **vmm**\(1) looks for *vmm.cfg* in the following directories in the +By default |vmm(1)|_ looks for *vmm.cfg* in the following directories in the order listed: - | */root* - | */usr/local/etc* - | */etc* + | */root* + | */usr/local/etc* + | */etc* The first configuration file found will be used. + SECTIONS ======== This section describes all sections and their options of the *vmm.cfg*. + ACCOUNT ------- The options in the section **account** are used to specify user account related settings. +.. _account.delete_directory: + ``delete_directory (default: false)`` : *Boolean* - Determines the behavior of **vmm**\(1) when an account is deleted. If - this option is set to *true* the user's home directory will be deleted - recursively. + Determines the behavior of |vmm(1)|_ when an account is deleted + (|userdelete|_). If this option is set to *true* the user's home directory + will be deleted recursively. + +.. _account.directory_mode: ``directory_mode (default: 448)`` : *Int* - Access mode for a user's home directory and all directories inside. - The value has to be specified in decimal (base 10) notation. + Access mode for a user's home directory and all directories inside. The + value has to be specified in decimal (base 10) notation. - | For example: 'drwx------' -> octal 0700 -> decimal 448 + | For example: 'drwx------' -> octal 0700 -> decimal 448 + +.. _account.disk_usage: ``disk_usage (default: false)`` : *Boolean* - Determines whether the disk usage of a user's Maildir always should be - summarized, using **du**\(1), and displayed with account information. + Determines whether the disk usage of a user's Maildir always should be + summarized, using **du**\(1), and displayed with account information. - This could be slow on large Maildirs. When you have enabled quotas, - **vmm**'s **userinfo** subcomammand will also display the current quota - usage of the account. You may also use **userinfo**'s optional argument - **du** or **full**, in order to display the current disk usage of an - account. + This could be slow on large Maildirs. When you have enabled quotas, + **vmm**'s |userinfo|_ subcomammand will also display the current quota + usage of the account. You may also use |userinfo|_'s optional argument + **du** or **full**, in order to display the current disk usage of an + account's Maildir. + +.. _account.imap: ``imap (default: true)`` : *Boolean* - Determines whether a newly created user can log in via IMAP. + Determines whether a newly created user can log in via IMAP. + +.. _account.password_length: ``password_length (default: 8)`` : *Int* - Determines how many characters and/or numbers should be used for - randomly generated passwords. Any value less than 8 will be - increased to 8. + Determines how many characters and/or numbers should be used for randomly + generated passwords. Any value less than 8 will be increased to 8. + +.. _account.pop3: ``pop3 (default: true)`` : *Boolean* Determines whether a newly created user can log in via POP3. +.. _account.random_password: + ``random_password (default: false)`` : *Boolean* - Determines whether **vmm** should generate a random password when no - password was given for the **useradd** subcommand. If this option is - set to *false* **vmm** will prompt you to enter a password for the new - account. + Determines whether **vmm** should generate a random password when no + password was given for the |useradd|_ subcommand. If this option is set to + *false* **vmm** will prompt you to enter a password for the new account. - You can specify the password length of generated passwords with the - **password_length** option. + You can specify the password length of generated passwords with the + |account.password_length|_ option. + +.. _account.sieve: ``sieve (default: true)`` : *Boolean* - Determines whether a newly created user can log in via ManageSieve. + Determines whether a newly created user can log in via ManageSieve. + +.. _account.smtp: ``smtp (default: true)`` : *Boolean* - Determines whether a newly created user can log in via SMTP (SMTP AUTH). + Determines whether a newly created user can log in via SMTP (SMTP AUTH). Example:: - [account] - delete_directory = false - directory_mode = 448 - disk_usage = false - random_password = true - password_length = 10 - smtp = true - pop3 = true - imap = true - sieve = true + [account] + delete_directory = false + directory_mode = 448 + disk_usage = false + random_password = true + password_length = 10 + smtp = true + pop3 = true + imap = true + sieve = true + BIN --- The **bin** section is used to specify some paths to some binaries required -by **vmm**\(1). +by |vmm(1)|_. + +.. _bin.dovecotpw: ``dovecotpw (default: /usr/sbin/dovecotpw)`` : *String* - The absolute path to the dovecotpw binary. This binary is used to - generate a password hash, if **misc.password_scheme** is set to one of - 'SMD5', 'SSHA', 'CRAM-MD5', 'HMAC-MD5', 'LANMAN', 'NTLM' or 'RPA'. + The absolute path to the dovecotpw binary. This binary is used to + generate a password hash, if |misc.password_scheme|_ is set to one of + 'SMD5', 'SSHA', 'CRAM-MD5', 'HMAC-MD5', 'LANMAN', 'NTLM' or 'RPA'. + +.. _bin.du: ``du (default: /usr/bin/du)`` : *String* - The absolute path to **du**\(1). This binary is used to summarize the - disk usage of a user's Maildir. + The absolute path to **du**\(1). This binary is used to summarize the disk + usage of a user's Maildir. + +.. _bin.postconf: ``postconf (default: /usr/sbin/postconf)`` : *String* - The absolute path to Postfix' **postconf**\(1). This binary is required - when **vmm**\(1) has to check for some Postfix settings, e.g. - `virtual_alias_expansion_limit`. + The absolute path to Postfix' |postconf(1)|_. This binary is required when + |vmm(1)|_ has to check for some Postfix settings, e.g. + |virtual_alias_expansion_limit|_. Example:: - [bin] - dovecotpw = /usr/sbin/dovecotpw - du = /usr/bin/du - postconf = /usr/sbin/postconf + [bin] + dovecotpw = /usr/sbin/dovecotpw + du = /usr/bin/du + postconf = /usr/sbin/postconf + CONFIG ------ The **config** section is an internal used control section. +.. _config.done: + ``done (default: false)`` : *Boolean* - This option is set to *false* when **vmm**\(1) is installed for the first - time. When you edit *vmm.cfg*, set this option to *true*. This option is - also set to *true* when you configure **vmm**\(1) with the command **vmm - configure**. + This option is set to *false* when |vmm(1)|_ is installed for the first + time. When you edit *vmm.cfg*, set this option to *true*. This option is + also set to *true* when you configure |vmm(1)|_ with the command |vmm + configure|_. - If this option is set to *false*, **vmm**\(1) will start in the - interactive configurations mode. + If this option is set to *false*, |vmm(1)|_ will start in the interactive + configurations mode. Example:: - [config] - done = true + [config] + done = true + DATABASE -------- The **database** section is used to specify some options required to connect to the database. +.. _database.host: + ``host (default: localhost)`` : *String* - Hostname or IP address of the database server. + Hostname or IP address of the database server. + +.. _database.name: ``name (default: mailsys)`` : *String* - Name of the database. + Name of the database. + +.. _database.pass: ``pass (default: None)`` : *String* - Database password. + Database password. + +.. _database.user: ``user (default: None)`` : *String* - Name of the database user. + Name of the database user. Example:: - [database] - host = localhost - user = vmm - pass = PY_SRJ}L/0p-oOk - name = mailsys + [database] + host = localhost + user = vmm + pass = PY_SRJ}L/0p-oOk + name = mailsys + DOMAIN ------ The **domain** section specifies some domain related settings. +.. _domain.auto_postmaster: + ``auto_postmaster (default: true)`` : *Boolean* - Determines if **vmm**\(1) should create also a postmaster account when a - new domain is created. + Determines if |vmm(1)|_ should create also a postmaster account when a new + domain is created (|domainadd|_). + +.. _domain.delete_directory: ``delete_directory (default: false)`` : *Boolean* - Specifies whether the domain directory and all user directories inside - should be deleted when a domain is deleted. + Specifies whether the domain directory and all user directories inside + should be deleted when a domain is deleted (|domaindelete|_). + +.. _domain.directory_mode: ``directory_mode (default: 504)`` : *Int* - Access mode for the domain directory in decimal (base 10) notation. + Access mode for the domain directory in decimal (base 10) notation. - | For example: 'drwxrwx---' -> octal 0770 -> decimal 504 + | For example: 'drwxrwx---' -> octal 0770 -> decimal 504 + +.. _domain.force_deletion: ``force_deletion (default: false)`` : *Boolean* - Force deletion of accounts and aliases when a domain is deleted. + Force deletion of accounts and aliases when a domain is deleted + (|domaindelete|_). Example:: - [domain] - auto_postmaster = true - delete_directory = false - directory_mode = 504 - force_deletion = false + [domain] + auto_postmaster = true + delete_directory = false + directory_mode = 504 + force_deletion = false + MAILDIR ------- The **maildir** section is used to specify some default options for new created Maildirs and folders inside. +.. _maildir.folders: + ``folders (default: Drafts:Sent:Templates:Trash)`` : *String* - A colon separated list of folder names, that should be created. If no - folders should be created inside the Maildir, set the value of this - option to a single colon ('**:**'). + A colon separated list of folder names, that should be created. If no + folders should be created inside the Maildir, set the value of this option + to a single colon ('**:**'). - If you want to create folders containing one or more subfolders, separate - them with a single dot ('**.**'). + If you want to create folders containing one or more subfolders, separate + them with a single dot ('**.**'). + +.. _maildir.name: ``name (default: Maildir)`` : *String* - Default name of the Maildir folder in users home directories. + Default name of the Maildir folder in users home directories. Example:: - [maildir] - folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix - name = Maildir + [maildir] + folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix + name = Maildir + +.. _imap_uft7: + +.. note:: If you want to use internationalized mailbox names in the + **folders** setting, you have to specify them in a modified version of the + UTF-7 encoding (see :RFC:`3501`, section 5.1.3). + + Dovecot provides a useful utility for mUTF-7 <-> UTF-8 conversion: + **imap-utf7**, it's available since Dovecot version 1.2.0. +.. + +imap-utf7 example:: + + user@host:~$ /usr/local/libexec/dovecot/imap-utf7 -r Wysłane + Wys&AUI-ane + user@host:~$ /usr/local/libexec/dovecot/imap-utf7 "&AVo-mietnik" + Śmietnik + MISC ---- The **misc** section is used to define miscellaneous settings. +.. _misc.base_directory: + ``base_directory (default: /srv/mail)`` : *String* - All domain directories will be created inside this directory. + All domain directories will be created inside this directory. + +.. _misc.password_scheme: ``password_scheme (default: CRAM-MD5)`` : *String* - Password scheme to use (see also: **dovecotpw -l**). + Password scheme to use (see also: **dovecotpw -l**). + +.. _misc.gid_mail: ``gid_mail (default: 8)`` : *Int* - Numeric group ID of group mail (`mail_privileged_group` from - *dovecot.conf*) + Numeric group ID of group mail (`mail_privileged_group` from + *dovecot.conf*) + +.. _misc.transport: ``transport (default: dovecot:)`` : *String* - Default transport for domains and accounts. For details see - **transport**\(5). + Default transport for domains and accounts. For details see + |transport(5)|_. + +.. _misc.dovecot_version: ``dovecot_version (default: 12)`` : *Int* - The concatenated major and minor version number of the currently used - Dovecot version. (see: **dovecot --version**). + The concatenated major and minor version number of the currently used + Dovecot version. (see: **dovecot --version**). - When, for example, the command **dovecot --version** prints *1.1.18*, set - the value of this option to **11**. + When, for example, the command **dovecot --version** prints *1.1.18*, set + the value of this option to **11**. Example:: - [misc] - base_directory = /srv/mail - password_scheme = PLAIN - gid_mail = 8 - transport = dovecot: - dovecot_version = 11 + [misc] + base_directory = /srv/mail + password_scheme = PLAIN + gid_mail = 8 + transport = dovecot: + dovecot_version = 11 + FILES ===== */root/vmm.cfg* - | will be used when found. + | will be used when found. */usr/local/etc/vmm.cfg* - | will be used when the above file doesn't exist. + | will be used when the above file doesn't exist. */etc/vmm.cfg* - | will be used when none of the both above mentioned files exists. + | will be used when none of the both above mentioned files exists. + SEE ALSO ======== -vmm(1), command line tool to manage email domains/accounts/aliases +|vmm(1)|_ + COPYING ======= vmm and its manual pages were written by Pascal Volk and are licensed under the terms of the BSD License. +.. include:: ../substitute_links.rst +.. include:: ../substitute_links_5.rst diff -r 9480f2b15129 -r 3d09c657e9e5 man/substitute_links.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/man/substitute_links.rst Sat Jan 30 05:15:21 2010 +0000 @@ -0,0 +1,19 @@ +.. set references to other manpages and set links in the html output + +.. |vmm(1)| replace:: **vmm**\(1) +.. _vmm(1): vmm.1 + +.. |vmm.cfg(5)| replace:: **vmm.cfg**\(5) +.. _vmm.cfg(5): vmm.cfg.5 + + +.. non vmm + +.. |postconf(1)| replace:: **postconf**\(1) +.. _postconf(1): http://www.postfix.org/postconf.1.html + +.. |transport(5)| replace:: **transport**\(5) +.. _transport(5): http://www.postfix.org/transport.5.html + +.. #EOF + diff -r 9480f2b15129 -r 3d09c657e9e5 man/substitute_links_1.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/man/substitute_links_1.rst Sat Jan 30 05:15:21 2010 +0000 @@ -0,0 +1,12 @@ +.. Substitutions in section 1 + +.. |account.disk_usage| replace:: `account.disk_usage` +.. _account.disk_usage: vmm.cfg.5#account-disk-usage + +.. |domain.force_deletion| replace:: `domain.force_deletion` +.. _domain.force_deletion: vmm.cfg.5#domain-force-deletion + +.. |misc.transport| replace:: `misc.transport` +.. _misc.transport: vmm.cfg.5#misc-transport + +.. #EOF diff -r 9480f2b15129 -r 3d09c657e9e5 man/substitute_links_5.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/man/substitute_links_5.rst Sat Jan 30 05:15:21 2010 +0000 @@ -0,0 +1,29 @@ +.. Substitutions in section 5 + +.. |account.password_length| replace:: **password_length** +.. |misc.password_scheme| replace:: **misc.password_scheme** + +.. |vmm configure| replace:: **vmm configure** +.. _`vmm configure`: vmm.1#configure + +.. |domainadd| replace:: **domainadd** +.. _domainadd: vmm.1#domainadd + +.. |domaindelete| replace:: **domaindelete** +.. _domaindelete: vmm.1#domaindelete + +.. |useradd| replace:: **useradd** +.. _useradd: vmm.1#useradd + +.. |userdelete| replace:: **userdelete** +.. _userdelete: vmm.1#userdelete + +.. |userinfo| replace:: **userinfo** +.. _userinfo: vmm.1#userinfo + +.. non vmm +.. |virtual_alias_expansion_limit| replace:: `virtual_alias_expansion_limit` +.. _virtual_alias_expansion_limit: + http://www.postfix.org/postconf.5.html#virtual_alias_expansion_limit + +.. #EOF diff -r 9480f2b15129 -r 3d09c657e9e5 po/de.po --- a/po/de.po Fri Jan 29 23:56:45 2010 +0000 +++ b/po/de.po Sat Jan 30 05:15:21 2010 +0000 @@ -507,7 +507,7 @@ " Unterbefehl Objekt args (* = optional)\n" #: vmm:65 vmm:76 -#, fuzzy, python-format +#, python-format msgid "Error: %s\n" msgstr "Fehler: %s\n" @@ -705,5 +705,5 @@ #: vmm:543 #, python-format msgid "Error: %s" -msgstr "Fehler %s" +msgstr "Fehler: %s"