# HG changeset patch # User Pascal Volk # Date 1213142722 0 # Node ID 89f952b0f36676943a5446e2935a15a3c23e8b1e # Parent 8a9ce20d2569feef64fe7cb21b8b64e955010b92 * 'install.sh' - removed verbose stuff - fixed (multilingual) man pages installation stuff * 'man/man1/vmm1' - moved vmm.1 to man/man1/vmm1 * 'man/man5/vmm.cfg.5' - moved vmm.cfg.5 to man/man5/vmm.cfg.5 * 'po/de.po' - updated * added to repository - 'man/de/man1/vmm.1' - 'man/de/man5/vmm.cfg.5' diff -r 8a9ce20d2569 -r 89f952b0f366 install.sh --- a/install.sh Mon May 26 22:18:19 2008 +0000 +++ b/install.sh Wed Jun 11 00:05:22 2008 +0000 @@ -11,20 +11,11 @@ PF_GID=$(id -g $(postconf -h mail_owner)) LOCALE_DIR=${PREFIX}/share/locale DOC_DIR=${PREFIX}/share/doc/vmm -MAN1DIR=${PREFIX}/share/man/man1 -MAN5DIR=${PREFIX}/share/man/man5 +MANDIR=${PREFIX}/share/man DOCS="ChangeLog COPYING INSTALL README" -case "$(uname -s)" in - 'OpenBSD' | 'NetBSD') - INSTALL_OPTS="-g 0 -o 0 -p" - INSTALL_OPTS_CF="-b -m 0640 -g ${PF_GID} -o 0 -p" - ;; - *) - INSTALL_OPTS="-g 0 -o 0 -p -v" - INSTALL_OPTS_CF="-b -m 0640 -g ${PF_GID} -o 0 -p -v" - ;; -esac +INSTALL_OPTS="-g 0 -o 0 -p" +INSTALL_OPTS_CF="-b -m 0640 -g ${PF_GID} -o 0 -p" if [ $(id -u) -ne 0 ]; then echo "Run this script as root." @@ -46,13 +37,28 @@ [ -d ${ddir} ] || mkdir -m 0755 -p ${ddir} msgfmt -o ${LOCALE_DIR}/${lang}/LC_MESSAGES/vmm.mo ${po} done -cd - +cd - >/dev/null + +cd man +[ -d ${MANDIR}/man1 ] || mkdir -m 0755 -p ${MANDIR}/man1 +install -m 0644 ${INSTALL_OPTS} man1/vmm.1 ${MANDIR}/man1 + +[ -d ${MANDIR}/man5 ] || mkdir -m 0755 -p ${MANDIR}/man5 +install -m 0644 ${INSTALL_OPTS} man5/vmm.cfg.5 ${MANDIR}/man5 -[ -d ${MAN1DIR} ] || mkdir -m 0755 -p ${MAN1DIR} -install -m 0644 ${INSTALL_OPTS} vmm.1 ${MAN1DIR} - -[ -d ${MAN5DIR} ] || mkdir -m 0755 -p ${MAN5DIR} -install -m 0644 ${INSTALL_OPTS} vmm.cfg.5 ${MAN5DIR} +for l in $(find . -maxdepth 1 -mindepth 1 -type d \! -name man\? \! -name .svn) +do + for s in man1 man5; do + [ -d ${MANDIR}/${l}/${s} ] || mkdir -m 0755 -p ${MANDIR}/${l}/${s} + done + if [ -f ${l}/man1/vmm.1 ]; then + install -m 0644 ${INSTALL_OPTS} ${l}/man1/vmm.1 ${MANDIR}/${l}/man1 + fi + if [ -f ${l}/man5/vmm.cfg.5 ]; then + install -m 0644 ${INSTALL_OPTS} ${l}/man5/vmm.cfg.5 ${MANDIR}/${l}/man5 + fi +done +cd - >/dev/null [ -d ${DOC_DIR} ] || mkdir -m 0755 -p ${DOC_DIR} for DOC in ${DOCS}; do diff -r 8a9ce20d2569 -r 89f952b0f366 man/de/man1/vmm.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/man/de/man1/vmm.1 Wed Jun 11 00:05:22 2008 +0000 @@ -0,0 +1,310 @@ +.\" $Id$ +.TH "VMM" "1" "11. Jun 2008" "Pascal Volk" +.SH NAME +vmm \- Programm für die Kommandozeile, um E-Mail-Domains, -Konten und -Aliase zu +verwalten. +.SH SYNOPSIS +.B vmm +\fIUnterbefehl\fP \fIObjekt\fP [ \fIArgumente\fP ] +.SH BESCHREIBUNG +\fBvmm\fP (Virtual Mail Manager) ist ein Kommandozeilen-Werkzeug für +Administratoren/Postmaster zur Verwaltung von Domains, Konten und Aliase. Es +wurde entwickelt für Dovecot und Postfix mit einem PostgreSQL-Backend. +.SH UNTERBEFEHLE +Von jedem Unterbefehl gibt es jeweils eine lange und kurze Variante. Bei beiden +Formen ist die Groß-/Kleinschreibung zu berücksichtigen. +.SS ALLGEMEINE UNTERBEFEHLE +.TP +\fBconfigure\fP (\fBcf\fP) [ \fIAbschnitt\fP ] +Startet den interaktiven Konfiguration-Modus für alle Konfigurations-Abschnitte. +.br +Wurde das optionale Argument \fIAbschnitt\fP angegeben, werden nur die Optionen +des angegebenen Abschnitts angezeigt und können geändert werden. Folgende +Abschnitte sind vorhanden: +.RS +.PD 0 +.TP +- +.B +database +.TP +- +.B +maildir +.TP +- +.B +services +.TP +- +.B +domdir +.TP +- +.B +bin +.TP +- +.B +misc +.PD +.RE +.LP +.PP +.nf + Beispiel: + + \fBvmm configure services\fP + * Konfigurations Abschnitt: services + Neuer Wert für pop3 [True]: + Neuer Wert für smtp [True]: + Neuer Wert für imap [True]: + Neuer Wert für managesieve [True]: false +.fi +.PP +.TP +\fBgetuser\fP (\fBgu\fP) \fIuserid\fP +Wenn nur eine UserID vorhanden ist, z. B. aus der Prozessliste, kann mit dem +Unterbefehl \fBgetuser\fP die E-Mail-Adresse des Users ermittelt werden. +.PP +.nf + Beispiel: + + \fBvmm getuser 70004\fP + Account Informationen + --------------------- + UID............: 70004 + GID............: 70000 + Address........: c.user@example.com +.fi +.\" +.TP +\fBlistdomains\fP (\fBld\fP) [ \fIMuster\fP ] +Dieser Unterbefehl listet alle verfügbaren Domains auf. Die Ausgabe kann +reduziert werden, indem ein optionales \fIMuster\fP angegeben wird. +.br +Um eine Wildcard-Suche durchzuführen kann das %-Zeichen am Anfang und/oder Ende +des \fIMusters\fP verwendet werden. +.PP +.nf + Beispiel: + + \fBvmm listdomains example%\fP + Übereinstimmende Domains + ------------------------- + example.com + example.net + example.org +.fi +.\" +.TP +\fBhelp\fP (\fBh\fP) +Dieser Unterbefehl gibt alle verfügbaren Kommandos auf stderr aus. Danach +beendet sich \fBvmm\fP. +.TP +\fBversion\fP (\fBv\fP) +Gibt Versions-Informationen zu \fBvmm\fP aus. +.\" +.SS DOMAIN UNTERBEFEHLE +.TP +\fBdomainadd\fP (\fBda\fP) \fIDomain\fP [ \fITransport\fP ] +Fügt eine neue \fIDomain\fP in die Datenbank ein. +.br +Ist das optionale Argument \fITransport\fP angegeben, wird der Vorgabe-Transport +aus \fBvmm.cfg\fP (misc/transport) für diese \fIDomain\fP ignoriert und der +angegebene \fITransport\fP verwendet. Der angegebene \fITransport\fP ist +gleichzeitig der Vorgabe-Transport für alle neuen Konten, die unter dieser +Domain eingerichtet werden. +.PP +.nf + Beispiele: + + \fBvmm domainadd support.example.com smtp:mx1.example.com + vmm domainadd sales.example.com\fP +.fi +.TP +\fBdomaininfo\fP (\fBdi\fP) \fIDomain\fP [ \fIdetailed\fP ] +Dieser Unterbefehl zeigt Information zur angegeben \fIDomain\fP an. +.br +Wurde das optionale Schlüsselwort '\fBdetailed\fP' angegeben, werden zusätzlich +alle eingerichteten Konten und Aliase aufgelistet. +.PP +.nf + Beispiel: + + \fBvmm domaininfo sales.example.com\fP + Domain Informationen + -------------------- + Domainname.....: sales.example.com + GID............: 70002 + Transport......: dovecot: + Domaindir......: /home/mail/5/70002 + Accounts.......: 0 + Aliases........: 0 + +.fi +.TP +\fBdomaintransport\fP (\fBdt\fP) \fIDomain\fP \fITransport\fP [ \fIforce\fP ] +Ein neuer \fITransport\fP für die angegebene \fIDomain\fP kann mit diesem +Unterbefehl festgelegt werden. +.br +Wurde das optionale Schlüsselwort '\fBforce\fP' angegeben, so werden alle +bisherigen Transport-Einstellungen, der in dieser Domain vorhandenen Konten, +mit dem neuen \fITransport\fP überschrieben. +.br +Andernfalls gilt der neue \fITransport\fP nur für Konten, die neu erstellt +werden. +.PP +.nf + Beispiel: + + \fBvmm domaintransport support.example.com dovecot:\fP +.fi +.TP +\fBdomaindelete\fP (\fBdd\fP) \fIDomain\fP [ \fIdelalias\fP | \fIdeluser\fP | \fIdelall\fP ] +Mit diesem Unterbefehl wird die angegebene \fIDomain\fP gelöscht. +.br +Sollten der \fIDomain\fP Konten und/oder Aliase zugeordnet sein, wird \fBvmm\fP +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: '\fBdelalias\fP', '\fBdeluser\fP' oder '\fBdelall\fP' + +Sollten Sie wirklich immer wissen was Sie tun, so editieren Sie Ihre +\fBvmm.cfg\fP und setzen den Wert der Option \fIforcedel\fP, im Abschnitt +\fImisc\fP, auf true. Dann werden Sie beim Löschen von Domains nicht mehr wegen +vorhanden Konten/Aliase gewarnt. +.\" +.SS KONTO UNTERBEFEHLE +.TP +\fBuseradd\fP (\fBua\fP) \fIAdresse\fP [ \fIPasswort\fP ] +Mit diesem Unterbefehl wird ein neues Konto für die angegebene \fIAdresse\fP +angelegt. +.br +Wurde keine \fIPasswort\fP angegeben wird \fBvmm\fP dieses im interaktiven +Modus erfragen. +.PP +.nf + Beispiele: + + \fBvmm ua d.user@example.com 'A 5ecR3t P4s5\\/\\/0rd'\fP + \fBvmm ua e.user@example.com\fP + Neues Passwort eingeben: + Neues Passwort wiederholen: +.fi +.TP +\fBuserinfo\fP (\fBui\fP) \fIAdresse\fP [ \fIdu\fP ] +Dieser Unterbefehl zeigt einige Informationen über das Konto mit der angegebenen +\fIAdresse\fP an. +.br +Wurde das optionale Argument \fIdu\fP angegeben, wird zusätzlich die +Festplattenbelegung des Kontos ermittelt und ausgegeben. +.TP +\fBusername\fP (\fBun\fP) \fIAdresse\fP \fI'Bürgerlicher Name'\fP +Der Bürgerliche Name des Konto-Inhabers mit der angegebenen \fIAdresse\fP kann +mit diesem Unterbefehl gesetzt/aktualisiert werden. +.PP +.nf + Beispiel: + + \fBvmm un d.user@example.com 'John Doe'\fP +.fi +.TP +\fBuserpassword\fP (\fBup\fP) \fIAdresse\fP [ \fIPasswort\fP ] +Das \fIPasswort\fP eines Kontos kann mit diesem Unterbefehl aktualisiert werden. +.br +Wurde keine \fIPasswort\fP angegeben wird \fBvmm\fP dieses im interaktiven +Modus erfragen. +.PP +.nf + Beispiel: + + \fBvmm up d.user@example.com 'A |\\/|0r3 5ecur3 P4s5\\/\\/0rd?'\fP +.fi +.TP +\fBusertransport\fP (\fBut\fP) \fIAdresse\fP \fITransport\fP +Mit diesem Unterbefehl kann ein abweichender \fITransport\fP für das Konto mit +der angegebenen \fIAdresse\fP festgelegt werden. +.PP +.nf + Beispiel: + + \fBvmm ut d.user@example.com smtp:pc105.it.example.com\fP +.fi +.TP +\fBuserdisable\fP (\fBu0\fP) \fIAdresse\fP [ \fIsmtp\fP | \fIpop3\fP | \fIimap\fP | \fImanagesieve\fP | \fIall\fP ] +Soll ein Anwender keinen Zugriff auf einen oder alle Service haben, kann der +Zugriff mit diesem Unterbefehl beschränkt werden. +.br +Wurde weder der Name eines Services noch das Schlüsselwort '\fIall\fP' +angegeben, werden alle Service ('smtp', 'pop3', 'imap', und 'managesieve') für +das Konto mit der angegebenen \fIAdresse\fP deaktiviert. +.br +Andernfalls wird nur der Zugriff auf den angegeben Service gesperrt. +.PP +.nf + Beispiele: + + \fBvmm u0 b.user@example.com imap\fP + \fBvmm userdisable c.user@example.com\fP +.fi +.TP +\fBuserenable\fP (\fBu1\fP) \fIAdresse\fP [ \fIsmtp\fP | \fIpop3\fP | \fIimap\fP | \fImanagesieve\fP | \fIall\fP ] +Um den Zugriff auf bestimmte oder alle gesperrten Service zu gewähren, wird +dieser Unterbefehl verwendet. +.br +Wurde weder der Name eines Services noch das Schlüsselwort '\fIall\fP' +angegeben, werden alle Service ('smtp', 'pop3', 'imap', und 'managesieve') für +das Konto mit der angegebenen \fIAdresse\fP aktiviert. +.br +Andernfalls wird nur der Zugriff auf den angegeben Service gestattet. +.TP +\fBuserdelete\fP (\fBud\fP) \fIAdresse\fP +Verwenden Sie diesen Unterbefehl um, das Konto mit der angegebenen \fIAdresse\fP +zu löschen. +.\" +.SS ALIAS UNTERBEFEHLE +.TP +\fBaliasadd\fP (\fBaa\fP) \fIAlias\fP \fIZiel\fP +Mit diesem Unterbefehl werden neue Aliase erstellt. +.PP +.nf + Beispiele: + + \fBvmm aliasadd john.doe@example.com d.user@example.com\fP + \fBvmm aa support@example.com d.user@example.com\fP + \fBvmm aa support@example.com e.user@example.com\fP +.fi +.TP +\fBaliasinfo\fP (\fBai\fP) \fIAlias\fP +Informationen zu einem Alias können mit diesem Unterbefehl ausgegeben werden. +.PP +.nf + Beispiel: + + \fBvmm aliasinfo support@example.com\fP + Alias Informationen + ------------------- + E-Mails für support@example.com gehen an: + -> d.user@example.com + -> e.user@example.com +.fi +.TP +\fBaliasdelete\fP (\fBad\fP) \fIAlias\fP [ \fIZiel\fP ] +Verwenden Sie diesen Unterbefehl um den angegebenen \fIAlias\fP zu löschen. +.br +Wurde die optionale Ziel-Adresse \fIZiel\fP angegeben, so wird nur diese +Ziel-Adresse vom angegebenen \fIAlias\fP entfernt. +.PP +.nf + Beispiel: + \fBvmm ad support@example.com d.user@example.com\fP +.fi +.SH DATEIEN +/usr/local/etc/vmm.cfg +.SH SIEHE AUCH +vmm.cfg(5), Konfigurationsdatei für vmm +.SH AUTOR +\fBvmm\fP und die dazugehörigen Manualseiten wurden von Pascal Volk +<\fIp.volk@veb-it.de\fP> geschrieben und sind unter den Bedingungen der BSD +Lizenz lizenziert. diff -r 8a9ce20d2569 -r 89f952b0f366 man/de/man5/vmm.cfg.5 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/man/de/man5/vmm.cfg.5 Wed Jun 11 00:05:22 2008 +0000 @@ -0,0 +1,230 @@ +.\" $Id$ +.TH vmm.cfg 5 "11. Jun 2008" "Pascal Volk" +.SH NAME +vmm.cfg \- Konfigurationsdatei für vmm +.SH SYNOPSIS +/usr/local/etc/vmm.cfg +.SH BESCHREIBUNG +\fBvmm\fR(1) liest Konfigurationsparameter aus der Datei +\fI/usr/local/etc/vmm.cfg\fP. +.br +Die Konfigurationsdatei ist in mehrere Abschnitte unterteilt. Jeder Abschnitt +wird mit dem, in eckigen Klammern '[' und ']' eingefassten, Namen des Abschnitts +eingeleitet (z. B. \fB[database]\fP), gefolgt von \'Option = Wert\' Einträgen +(Z. B. \fBhost = 127.0.0.1\fP). +.br +Leerräume um das Gleichheitszeichen '=' und am Ende eine Wertes werden +ignoriert. +.PP +Leerzeilen und Zeilen, die mit einer '#' oder einem ';' anfangen, werden +ignoriert. +.PP +Jeder Wert ist von einem der folgenden Datentypen: +.IP \(bu +.I Boolean +um zu bestimmen, ob etwas eingeschaltet/aktiviert (true) oder +ausgeschaltet/deaktiviert (false) ist. +.br +Mögliche Werte für \fBtrue\fP sind: \fB1\fP, \fByes\fP, \fBtrue\fP und \fBon\fP. +.br +Mögliche Werte für \fBfalse\fP sind: \fB0\fP, \fBno\fP, \fBfalse\fP und +\fBoff\fP. +.IP \(bu +.I Int +eine Integer-Zahl, geschrieben ohne eine gebrochene oder dezimale Komponente. +.br +Beispielsweise sind \fB1\fP, \fB50\fP oder \fB321\fP Integer-Zahlen. +.IP \(bu +.I String +eine Folge von Buchstaben und Zahlen. +.br +Zum Beispiel: '\fBWort\fP', '\fBHallo Welt\fP', oder '\fB/usr/bin/strings\fP' +.\" ----- +.SH DATABASE ABSCHNITT +Der \fBdatabase\fP-Abschnitt wird verwendet, um die für den Datenbankzugriff +benötigten Optionen festzulegen. +.TP +\fBhost\fP (\fIString\fP) +Der Hostname oder die IP-Adresse des Datenbank-Servers. +.TP +\fBuser\fP (\fIString\fP) +Der Name des Datenbank-Benutzers. +.TP +\fBpass\fP (\fIString\fP) +Das Passwort des Datenbank-Benutzers +.TP +\fBname\fP (\fIString\fP) +Name der zu verwendenden Datenbank. +.TP +\fBBeispiel\fP: +[database] +.br +host = localhost +.br +user = vmm +.br +pass = T~_:L4OYyl]TU?) +.br +name = mailsys +.\" ----- +.SH MAILDIR ABSCHNITT +Im \fBmaildir\fP-Abschnitt werden die für die Maildirs erforderlichen Optionen +festgelegt. +.TP +\fBfolder\fP (\fIString\fP) +Standard-Name des Maildir-Verzeichnisses im Verzeichnis des jeweiligen +Anwenders. +.TP +\fBmode\fP (\fIInt\fP) +Zugriffsbits des Maildirs in Dezimal-Schreibweise (Basis 10). +.br +Beispiel: \'drwx------' -> oktal 0700 -> dezimal 448 +.TP +\fBdiskusage\fP (\fIBoolean\fP) +Legt fest, ob die Festplattenbelegung des Maildirs jedes Mal, wenn +Konto-Informationen ausgegeben werden, ermittelt und mit ausgegeben werden +sollen. +.TP +\fBdelete\fP (\fIBoolean\fP) +Bestimmt, ob das Maildir rekursiv gelöscht werden soll, wenn ein Konto gelöscht +wird. +.TP +\fBBeispiel\fP: +[maildir] +.br +folder = Maildir +.br +mode = 448 +.br +diskusage = false +.br +delete = false +.\" ----- +.SH SERVICES ABSCHNITT +Im \fBservices\fP-Abschnitt werden die Standard-Beschränkungen für alle Konten +festgelegt. +.TP +\fBsmtp\fP (\fIBoolean\fP) +Legt fest, ob sich ein Anwender standardmäßig per SMTP einloggen kann. +.TP +\fBpop3\fP (\fIBoolean\fP) +Legt fest, ob sich ein Anwender standardmäßig per POP3 einloggen kann. +.TP +\fBimap\fP (\fIBoolean\fP) +Legt fest, ob sich ein Anwender standardmäßig per IMAP einloggen kann. +.TP +\fBmanagesieve\fP (\fIBoolean\fP) +Legt fest, ob sich ein Anwender standardmäßig per MANAGESIEVE einloggen kann. +.TP +\fBBeispiel\fP: +[services] +.br +smtp = true +.br +pop3 = true +.br +imap = false +.br +managesieve = false +.\" ----- +.SH DOMDIR ABSCHNITT +Im \fBdomdir\fP-Abschnitt werden die Optionen der Domain-Verzeichnisse bestimmt. +.TP +\fBbase\fP (\fIString\fP) +Alle Domain-Verzeichnisse werden unterhalb dieses Basis-Verzeichnisses angelegt. +.TP +\fBmode\fP (\fIInt\fP) +Zugriffsbits des Domain-Verzeichnisses in Dezimal-Schreibweise (Basis 10). +.br +Beispiel: 'drwxrwx---' -> oktal 0770 -> dezimal 504 +.TP +\fBdelete\fP (\fIBoolean\fP) +Bestimmt ob beim Löschen einer Domain das Verzeichnis einer Domain, inklusive +aller Anwender-Verzeichnisse, rekursiv gelöscht werden soll. +.TP +\fBBeispiel\fP: +[domdir] +.br +base = /srv/mail +.br +mode = 504 +.br +delete = false +.\" ----- +.SH BIN ABSCHNITT +Der \fBbin\fP-Abschnitt wird verwendet, um Pfade zu Binaries, die von \fBvmm\fP +benötigt werden, anzugeben. +.TP +\fBdovecotpw\fP (\fIString\fP) +Der absolute Pfad zum dovecotpw-Binary. Diese wird verwendet, wenn als +Passwort-Schema eines der folgenden verwendet wird: 'SMD5', 'SSHA', 'CRAM-MD5', +\'HMAC-MD5', 'LANMAN', 'NTLM' oder 'RPA'. +.TP +\fBdu\fP (\fIString\fP) +Der absolute Pfad zu \fBdu\fR(1). Diese Binary wird verwendet, wenn die +Festplattenbelegung eines Kontos ermittelt wird. +.TP +\fBBeispiel\fP: +[bin] +.br +dovecotpw = /usr/sbin/dovecotpw +.br +du = /usr/bin/du +.\" ----- +.SH MISC ABSCHNITT +Im \fBmisc\fP-Abschnitt werden verschiedene Einstellungen festgelegt. +.TP +\fBpasswdscheme\fP (\fIString\fP) +Das zu verwende Passwort-Schema (siehe auch: dovecotpw -l) +.TP +\fBgid_mail\fP (\fIInt\fP) +Die numerische Gruppen-ID der Gruppe mail, bzw. der Gruppe aus +mail_privileged_group der Datei dovecot.conf. +.TP +\fBforcedel\fP (\fIBoolean\fP) +Legt fest, ob beim Löschen einer Domain alle vorhanden Konten und/oder Aliase, +ohne Nachfrage, gelöscht werden sollen. +.TP +\fBtransport\fP (\fIString\fP) +Der Standard-Transport aller Domains und Konten. +.TP +\fBBeispiel\fP: +[misc] +.br +passwdscheme = CRAM-MD5 +.br +gid_mail = 8 +.br +forcedel = false +.br +transport = dovecot: +.\" ----- +.SH CONFIG ABSCHNITT +Beim \fBconfig\fP-Abschnitt handelt es sich um einen internen +Steuerungs-Abschnitt. +.TP +\fBdone\fP (\fIBoolean\fP) +Diese Option hat den den Wert \fIfalse\fP, wenn vmm zum ersten Mal installiert +wurde. Wenn die Datei \fIvmm.cfg\fP von Hand editiert wird, weißen Sie dieser +Option abschließend den Wert \fItrue\fP zu. +.br +Wird die Konfiguration über das Kommando \fBvmm configure\fP angepasst, wird der +Wert dieser Option automatisch auf \fItrue\fP gesetzt. +.br +Sollte diese Option den Wert \fIfalse\fP zugewiesen haben, so startet \fBvmm\fP +beim nächsten Aufruf im interaktiven Konfigurations-Modus. +.TP +\fBBeispiel\fP: +[config] +.br +done = true +.\" ----- +.SH DATEIEN +/usr/local/etc/vmm.cfg +.SH SIEHE AUCH +vmm(1), Programm für die Kommandozeile, um E-Mail-Domains, -Konten und -Aliase +zu verwalten. +.SH AUTOR +\fBvmm\fP und die dazugehörigen Manualseiten wurden von Pascal Volk +<\fIp.volk@veb-it.de\fP> geschrieben und sind unter den Bedingungen der BSD +Lizenz lizenziert. diff -r 8a9ce20d2569 -r 89f952b0f366 man/man1/vmm.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/man/man1/vmm.1 Wed Jun 11 00:05:22 2008 +0000 @@ -0,0 +1,287 @@ +.\" $Id$ +.TH "VMM" "1" "11. Jun 2008" "Pascal Volk" +.SH NAME +vmm \- command line tool to manage email domains/accounts/aliases +.SH SYNOPSIS +.B vmm +\fIsubcommand\fP \fIobject\fP [ \fIargs\fP ] +.SH DESCRIPTION +\fBvmm\fP (Virtual Mail Manager) is a command line tool for +administrators/postmasters to manage domains, accounts and aliases. It's +designed for Dovecot and Postfix with a PostgreSQL backend. +.SH SUBCOMMANDS +Each subcommand has both a long and a short form. Both forms are case sensitive. +.SS GENERAL SUBCOMMANDS +.TP +\fBconfigure\fP (\fBcf\fP) [ \fIsection\fP ] +Starts the interactive configuration for all configuration sections. +.br +If the optional argument \fIsection\fP is given, only the configuration options +from the given section will be displayed and will be configurable. The following +sections are available: +.RS +.PD 0 +.TP +- +.B +database +.TP +- +.B +maildir +.TP +- +.B +services +.TP +- +.B +domdir +.TP +- +.B +bin +.TP +- +.B +misc +.PD +.RE +.LP +.PP +.nf + Example: + + \fBvmm configure services\fP + * Config section: services + Enter new value for pop3 [True]: + Enter new value for smtp [True]: + Enter new value for imap [True]: + Enter new value for managesieve [True]: false +.fi +.PP +.TP +\fBgetuser\fP (\fBgu\fP) \fIuserid\fP +If only the userid is available, for example from process list, the subcommand +\fBgetuser\fP will show the user's address. +.PP +.nf + Example: + + \fBvmm getuser 70004\fP + Account information + ------------------- + UID............: 70004 + GID............: 70000 + Address........: c.user@example.com +.fi +.\" +.TP +\fBlistdomains\fP (\fBld\fP) [ \fIpattern\fP ] +This subcommand lists all available domains. The output can be limited with an +optional \fIpattern\fP. +.br +To perform a wild card search, the % character can be used at the start and/or +the end of the \fIpattern\fP. +.PP +.nf + Example: + + \fBvmm listdomains example%\fP + Matching domains + ---------------- + example.com + example.net + example.org +.fi +.\" +.TP +\fBhelp\fP (\fBh\fP) +Prints all available commands to stderr. After this \fBvmm\fP exits. +.TP +\fBversion\fP (\fBv\fP) +Prints the version information from \fBvmm\fP. +.\" +.SS DOMAIN SUBCOMMANDS +.TP +\fBdomainadd\fP (\fBda\fP) \fIdomain\fP [ \fItransport\fP ] +Adds the new \fIdomain\fP into the database. +.br +If the optional argument \fItransport\fP is given, it will overwrite the +default transport from \fBvmm.cfg\fP (misc/transport). The specified transport +will be the default transport for all new accounts in this domain. +.PP +.nf + Examples: + + \fBvmm domainadd support.example.com smtp:mx1.example.com + vmm domainadd sales.example.com\fP +.fi +.TP +\fBdomaininfo\fP (\fBdi\fP) \fIdomain\fP [ \fIdetailed\fP ] +This subcommand shows some information about the given domain. +.br +If the keyword '\fBdetailed\fP' is specified as optional argument, all +available accounts and aliases will be listed. +.PP +.nf + Example: + + \fBvmm domaininfo sales.example.com\fP + Domain information + ------------------ + Domainname.....: sales.example.com + GID............: 70002 + Transport......: dovecot: + Domaindir......: /home/mail/5/70002 + Accounts.......: 0 + Aliases........: 0 + +.fi +.TP +\fBdomaintransport\fP (\fBdt\fP) \fIdomain\fP \fItransport\fP [ \fIforce\fP ] +A new transport for the indicated domain can be set with this subcommand. +.br +If the additional keyword '\fBforce\fP' is given all account specific transport +settings will be overwritten. +.br +Otherwise this setting will affect only new created accounts. +.PP +.nf + Example: + + \fBvmm domaintransport support.example.com dovecot:\fP +.fi +.TP +\fBdomaindelete\fP (\fBdd\fP) \fIdomain\fP [ \fIdelalias\fP | \fIdeluser\fP | \fIdelall\fP ] +This subcommand deletes the specified \fIdomain\fP. +.br +If there are accounts and/or aliases assigned to the given domain, \fBvmm\fP +will abort the requested operation and show a error message. If you know, what +you are doing, you can specify one of the following keywords: '\fBdelalias\fP', '\fBdeluser\fP' or '\fBdelall\fP'. +.br + +If you really always know what you are doing, edit your \fBvmm.cfg\fP and set +the option \fIforcedel\fP, in section \fImisc\fP, to true. +.\" +.SS ACCOUNT SUBCOMMANDS +.TP +\fBuseradd\fP (\fBua\fP) \fIaddress\fP [ \fIpassword\fP ] +Use this subcommand to create a new email account for the given \fIaddress\fP. +.br +If the \fIpassword\fP is not provided, \fBvmm\fP will prompt for it +interactively. +.PP +.nf + Examples: + + \fBvmm ua d.user@example.com 'A 5ecR3t P4s5\\/\\/0rd'\fP + \fBvmm ua e.user@example.com\fP + Enter new password: + Retype new password: +.fi +.TP +\fBuserinfo\fP (\fBui\fP) \fIaddress\fP [ \fIdu\fP ] +This subcommand displays some information about the account specified by +\fIaddress\fP. +.br +If the optional argument \fIdu\fP is given, the disk usage of users maildir will +be summarized and displayed too. +.TP +\fBusername\fP (\fBun\fP) \fIaddress\fP \fI'Users Name'\fP +The user's real name can be set/updated with this subcommand. +.PP +.nf + Example: + + \fBvmm un d.user@example.com 'John Doe'\fP +.fi +.TP +\fBuserpassword\fP (\fBup\fP) \fIaddress\fP [ \fIpassword\fP ] +The \fIpassword\fP from an account can be updated with this subcommand. +.br +If the \fIpassword\fP is not provided, \fBvmm\fP will prompt for it +interactively. +.PP +.nf + Example: + + \fBvmm up d.user@example.com 'A |\\/|0r3 5ecur3 P4s5\\/\\/0rd?'\fP +.fi +.TP +\fBusertransport\fP (\fBut\fP) \fIaddress\fP \fItransport\fP +A different transport for an account can be specified with this subcommand. +.PP +.nf + Example: + + \fBvmm ut d.user@example.com smtp:pc105.it.example.com\fP +.fi +.TP +\fBuserdisable\fP (\fBu0\fP) \fIaddress\fP [ \fIsmtp\fP | \fIpop3\fP | \fIimap\fP | \fImanagesieve\fP | \fIall\fP ] +If a user shouldn't have access to one or all services you can restrict the +access with this subcommand. +.br +If neither a service nor the keyword '\fIall\fP' is given all services ('smtp', 'pop3', 'imap', and 'managesieve') will be disabled for the account with the specified +\fIaddress\fP. Otherwise only the specified service will be restricted. +.PP +.nf + Examples: + + \fBvmm u0 b.user@example.com imap\fP + \fBvmm userdisable c.user@example.com\fP +.fi +.TP +\fBuserenable\fP (\fBu1\fP) \fIaddress\fP [ \fIsmtp\fP | \fIpop3\fP | \fIimap\fP | \fImanagesieve\fP | \fIall\fP ] +To allow access to one or all restricted services use this subcommand. +.br +If neither a service nor the keyword '\fIall\fP' is given all services ('smtp', 'pop3', 'imap', and 'managesieve') will be enabled for the account with the specified +\fIaddress\fP. Otherwise only the specified service will be enabled. +.TP +\fBuserdelete\fP (\fBud\fP) \fIaddress\fP +Use this subcommand to delete the account with the given \fIaddress\fP. +.\" +.SS ALIAS SUBCOMMANDS +.TP +\fBaliasadd\fP (\fBaa\fP) \fIalias\fP \fItarget\fP +This subcommand is used to create a new alias. +.PP +.nf + Examples: + + \fBvmm aliasadd john.doe@example.com d.user@example.com\fP + \fBvmm aa support@example.com d.user@example.com\fP + \fBvmm aa support@example.com e.user@example.com\fP +.fi +.TP +\fBaliasinfo\fP (\fBai\fP) \fIalias\fP +Information about an alias can be displayed with this subcommand. +.PP +.nf + Example: + + \fBvmm aliasinfo support@example.com\fP + Alias information + ----------------- + Mail for support@example.com goes to: + -> d.user@example.com + -> e.user@example.com +.fi +.TP +\fBaliasdelete\fP (\fBad\fP) \fIalias\fP [ \fItarget\fP ] +Use this subcommand to delete the \fIalias\fP. +.br +If the optional destination address \fItarget\fP is given, only this +destination will be removed from the \fIalias\fP. +.PP +.nf + Example: + \fBvmm ad support@example.com d.user@example.com\fP +.fi +.SH FILES +/usr/local/etc/vmm.cfg +.SH SEE ALSO +vmm.cfg(5), configuration file for vmm +.SH AUTHOR +\fBvmm\fP and its man pages were written by Pascal Volk +<\fIp.volk@veb-it.de\fP> and are licensed under the terms of the BSD License. diff -r 8a9ce20d2569 -r 89f952b0f366 man/man5/vmm.cfg.5 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/man/man5/vmm.cfg.5 Wed Jun 11 00:05:22 2008 +0000 @@ -0,0 +1,212 @@ +.\" $Id$ +.TH vmm.cfg 5 "11. Jun 2008" "Pascal Volk" +.SH NAME +vmm.cfg \- configuration file for vmm +.SH SYNOPSIS +/usr/local/etc/vmm.cfg +.SH DESCRIPTION +\fBvmm\fR(1) reads configuration data from \fI/usr/local/etc/vmm.cfg\fP. +.br +The configuration file is split in multiple sections. A section starts with the +section name, enclosed in square brackets '[' and ']' (e.g. \fB[database]\fP), +followed by \'option=value' pairs (e.g. \fBhost = 127.0.0.1\fP). +.br +Whitespace around the '=' and at the end of a value is ignored. +.PP +Empty lines and lines starting with '#' or ';' will be ignored. +.PP +Each value uses one of the following data types: +.IP \(bu +.I Boolean +to indicate if something is enabled/activated (true) or disabled/deactivated +(false). +.br +Accepted values for \fBtrue\fP are: \fB1\fP, \fByes\fP, \fBtrue\fP and \fBon\fP. +.br +Accepted values for \fBfalse\fP are: \fB0\fP, \fBno\fP, \fBfalse\fP and +\fBoff\fP. +.IP \(bu +.I Int +an integer number, written without a fractional or decimal component. For +example \fB1\fP, \fB50\fP or \fB321\fP are integers. +.IP \(bu +.I String +a sequence of characters and numbers. For example '\fBword\fP', '\fBhello +world\fP', or '\fB/usr/bin/strings\fP' +.\" ----- +.SH DATABASE SECTION +The \fBdatabase\fP section is used to specify some options required to +connect to the database. +.TP +\fBhost\fP (\fIString\fP) +Hostname or IP address of the database server. +.TP +\fBuser\fP (\fIString\fP) +Name of the database user. +.TP +\fBpass\fP (\fIString\fP) +Database password +.TP +\fBname\fP (\fIString\fP) +Name of the database. +.TP +\fBExample\fP: +[database] +.br +host = localhost +.br +user = vmm +.br +pass = T~_:L4OYyl]TU?) +.br +name = mailsys +.\" ----- +.SH MAILDIR SECTION +The \fBmaildir\fP section is used to specify some options for the Maildirs. +.TP +\fBfolder\fP (\fIString\fP) +Default name of the maildir folder in users home directory. +.TP +\fBmode\fP (\fIInt\fP) +Access mode for the maildir in decimal (base 10) notation. For example: +\'drwx------' -> octal 0700 -> decimal 448 +.TP +\fBdiskusage\fP (\fIBoolean\fP) +Decides if the disk usage of users maildir always should be summarized and +displayed with account information. +.TP +\fBdelete\fP (\fIBoolean\fP) +Decides if the maildir should be deleted recursive when the account is deleted. +.TP +\fBExample\fP: +[maildir] +.br +folder = Maildir +.br +mode = 448 +.br +diskusage = false +.br +delete = false +.\" ----- +.SH SERVICES SECTION +The \fBservices\fP section is used to specify the default restrictions for +all accounts. +.TP +\fBsmtp\fP (\fIBoolean\fP) +Decides if users can login via smtp by default. +.TP +\fBpop3\fP (\fIBoolean\fP) +Decides if users can login via pop3 by default. +.TP +\fBimap\fP (\fIBoolean\fP) +Decides if users can login via imap by default. +.TP +\fBmanagesieve\fP (\fIBoolean\fP) +Decides if users can login via managesieve by default. +.TP +\fBExample\fP: +[services] +.br +smtp = true +.br +pop3 = true +.br +imap = false +.br +managesieve = false +.\" ----- +.SH DOMDIR SECTION +The \fBdomdir\fP section is used to specify options for the directories of the +domains. +.TP +\fBbase\fP (\fIString\fP) +All domain directories will be created inside this directory. +.TP +\fBmode\fP (\fIInt\fP) +Access mode for the domain directory in decimal (base 10) notation. For +example: 'drwxrwx---' -> octal 0770 -> decimal 504 +.TP +\fBdelete\fP (\fIBoolean\fP) +Decides if the domain directory and all user directories inside should be +deleted when a domain is deleted. +.TP +\fBExample\fP: +[domdir] +.br +base = /srv/mail +.br +mode = 504 +.br +delete = false +.\" ----- +.SH BIN SECTION +The \fBbin\fP section is used to specify some paths to some binaries required +by \fBvmm\fP. +.TP +\fBdovecotpw\fP (\fIString\fP) +The absolute path to the dovecotpw binary. This binary is used to generate a +password hash, if the \fIpasswdscheme\fP is one of 'SMD5', 'SSHA', 'CRAM-MD5', +\'HMAC-MD5', 'LANMAN', 'NTLM' or 'RPA'. +.TP +\fBdu\fP (\fIString\fP) +The absolute path to \fBdu\fR(1). This binary is used to summarize the disk +usage of a maildir. +.TP +\fBExample\fP: +[bin] +.br +dovecotpw = /usr/sbin/dovecotpw +.br +du = /usr/bin/du +.\" ----- +.SH MISC SECTION +The \fBmisc\fP section is used to define miscellaneous settings. +.TP +\fBpasswdscheme\fP (\fIString\fP) +Password scheme to use (see also: dovecotpw -l) +.TP +\fBgid_mail\fP (\fIInt\fP) +Numeric group ID of group mail (mail_privileged_group from dovecot.conf) +.TP +\fBforcedel\fP (\fIBoolean\fP) +Force deletion of accounts and aliases when a domain is deleted. +.TP +\fBtransport\fP (\fIString\fP) +Default transport for domains and accounts. +.TP +\fBExample\fP: +[misc] +.br +passwdscheme = CRAM-MD5 +.br +gid_mail = 8 +.br +forcedel = false +.br +transport = dovecot: +.\" ----- +.SH CONFIG SECTION +The \fBconfig\fP section is a internal used control section. +.TP +\fBdone\fP (\fIBoolean\fP) +This option is set to \fIfalse\fP when \fBvmm\fP is installed for the first +time. When you edit \fIvmm.cfg\fP, set this option to \fItrue\fP. This option is +also set to \fItrue\fP when you configure vmm with the command \fBvmm +configure\fP. +.br +If this option is set to \fIfalse\fP, \fBvmm\fP will start in the interactive +configurations mode. +.TP +\fBExample\fP: +[config] +.br +done = true +.\" ----- +.SH FILES +/usr/local/etc/vmm.cfg +.SH SEE ALSO +vmm(1), command line tool to manage email domains/accounts/aliases +.SH AUTHOR +\fBvmm\fP and its man pages were written by Pascal Volk +<\fIp.volk@veb-it.de\fP> and are licensed under the terms of the BSD License. diff -r 8a9ce20d2569 -r 89f952b0f366 po/de.po --- a/po/de.po Mon May 26 22:18:19 2008 +0000 +++ b/po/de.po Wed Jun 11 00:05:22 2008 +0000 @@ -67,11 +67,11 @@ #: VirtualMailManager/Config.py:101 msgid "missing section: %s\n" -msgstr "Fehlender Bereich: %s\n" +msgstr "Fehlender Abschnitt: %s\n" #: VirtualMailManager/Config.py:103 msgid "missing options in section %s:\n" -msgstr "Fehlende Optionen im Bereich %s:\n" +msgstr "Fehlende Optionen im Abschnitt %s:\n" #: VirtualMailManager/Config.py:119 msgid "Argument 'sections' is not a list." @@ -79,7 +79,7 @@ #: VirtualMailManager/Config.py:132 msgid "* Config section: %s" -msgstr "* Konfigurations Bereich: »%s«" +msgstr "* Konfigurations Abschnitt: %s" #: VirtualMailManager/Config.py:134 msgid "Enter new value for %s [%s]: " @@ -209,12 +209,12 @@ "see also: vmm.cfg(5)\n" msgstr "" "Konfigurations Fehler: \"%s\"\n" -"(im Bereich \"connfig\", Option \"done\")'\n" +"(im Abschnitt \"connfig\", Option \"done\")'\n" "Siehe auch: vmm.cfg(5)\n" #: VirtualMailManager/VirtualMailManager.py:413 msgid "Invalid section: »%s«" -msgstr "Ungültiger Bereich: »%s«" +msgstr "Ungültiger Abschnitt: »%s«" #: VirtualMailManager/VirtualMailManager.py:427 #: VirtualMailManager/VirtualMailManager.py:437 diff -r 8a9ce20d2569 -r 89f952b0f366 vmm.1 --- a/vmm.1 Mon May 26 22:18:19 2008 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,290 +0,0 @@ -.\" $Id$ -.TH "VMM" "1" "27. May 2008" "Pascal Volk" -.SH NAME -vmm \- command line tool to manage email domains/accounts/aliases -.SH SYNOPSIS -.B vmm -\fIsubcommand\fP \fIobject\fP [ \fIargs\fP ] -.SH DESCRIPTION -\fBvmm\fP (Virtual Mail Manager) is a command line tool for -administrators/postmasters to manage domains, accounts and aliases. It's -designed for Dovecot and Postfix with a PostgreSQL backend. -.SH SUBCOMMANDS -Each subcommand has both a long and a short form. Both forms are case sensitive. -.SS GENERAL SUBCOMMANDS -.TP -\fBconfigure\fP (\fBcf\fP) [ \fIsection\fP ] -Starts the interactive configuration for all configuration sections. -.br -If the optional argument \fIsection\fP is given, only the configuration options -from the given section will be displayed and will be configurable. The following -sections are available: -.RS -.PD 0 -.TP -- -.B -database -.TP -- -.B -maildir -.TP -- -.B -services -.TP -- -.B -domdir -.TP -- -.B -bin -.TP -- -.B -misc -.PD -.RE -.LP -.PP -.nf - Example: - - \fBvmm configure services\fP - * Config section: services - Enter new value for pop3 [True]: - Enter new value for smtp [True]: - Enter new value for imap [True]: - Enter new value for managesieve [True]: false -.fi -.PP -.TP -\fBgetuser\fP (\fBgu\fP) \fIuserid\fP -If only the userid is available, for example from process list, the subcommand -\fBgetuser\fP will show the user's address. -.PP -.nf - Example: - - \fBvmm getuser 70004\fP - Account information - ------------------- - Gid............: 70000 - Uid............: 70004 - Address........: c.user@example.com -.fi -.\" -.TP -\fBlistdomains\fP (\fBld\fP) [ \fIpattern\fP ] -This subcommand lists all available domains. The output can be limited with an -optional \fIpattern\fP. -.br -To perform a wild card search, the % character can be used at the start and/or -the end of the \fIpattern\fP. -.PP -.nf - Example: - - \fBvmm listdomains example%\fP - Matching domains - ---------------- - example.com - example.net - example.org -.fi -.\" -.TP -\fBhelp\fP (\fBh\fP) -Prints all available commands to stderr. After this \fBvmm\fP exits. -.TP -\fBversion\fP (\fBv\fP) -Prints the version information from \fBvmm\fB. -.\" -.SS DOMAIN SUBCOMMANDS -.TP -\fBdomainadd\fP (\fBda\fP) \fIdomain\fP [ \fItransport\fP ] -Adds the new \fIdomain\fP into the database. -.br -If the optional argument \fItransport\fP is given, it will overwrite the -default transport from \fBvmm.cfg\fP (misc/transport). The specified transport -will be the default transport for all new accounts in this domain. -.PP -.nf - Examples: - - \fBvmm domainadd support.example.com smtp:mx1.example.com - vmm domainadd sales.example.com\fP -.fi -.TP -\fBdomaininfo\fP (\fBdi\fP) \fIdomain\fP [ \fIdetailed\fP ] -This subcommand shows some information about the given domain. -.br -If the keyword '\fBdetailed\fP' is specified as optional argument, all -available accounts and aliases will be listed. -.PP -.nf - Example: - - \fBvmm domaininfo sales.example.com\fP - Domain information - ------------------ - Domainname.....: sales.example.com - Domaindir......: /home/mail/5/70002 - Gid............: 70002 - Accounts.......: 0 - Transport......: dovecot: - Aliases........: 0 - -.fi -.TP -\fBdomaintransport\fP (\fBdt\fP) \fIdomain\fP \fItransport\fP [ \fIforce\fP ] -A new transport for the indicated domain can be set with this subcommand. -.br -If the additional keyword '\fBforce\fP' is given all account specific transport -settings will be overwritten. -.br -Otherwise this setting will affect only new created accounts. -.PP -.nf - Example: - - \fBvmm domaintransport support.example.com dovecot:\fP -.fi -.TP -\fBdomaindelete\fP (\fBdd\fP) \fIdomain\fP [ \fIdelalias\fP | \fIdeluser\fP |\ - \fIdelall\fP ] -This subcommand deletes the specified \fIdomain\fP. -.br -If there are accounts and/or aliases assigned to the given domain, \fBvmm\fP -will abort the requested operation and show a error message. If you know, what -you are doing, you can specify one of the following keywords: '\fPdelalias\fP', '\fBdeluser\fP' or '\fBdelall\fP'. -.br - -If you really always know what you are doing, edit your \fBvmm.cfg\fP and set -the option \fIforcedel\fP, in section \fImisc\fP, to true. -.\" -.SS ACCOUNT SUBCOMMANDS -.TP -\fBuseradd\fP (\fBua\fP) \fIaddress\fP [ \fIpassword\fP ] -Use this subcommand to create a new email account for the given \fIaddress\fP. -.br -If the \fIpassword\fP is not provided, \fBvmm\fP will prompt for it -interactively. -.PP -.nf - Examples: - - \fBvmm ua d.user@example.com 'A 5ecR3t P4s5\\/\\/0rd'\fP - \fBvmm ua e.user@example.com\fP - Enter new password: - Retype new password: -.fi -.TP -\fBuserinfo\fP (\fBui\fP) \fIaddress\fP [ \fIdu\fP ] -This subcommand displays some information about the account specified by -\fIaddress\fP. -.br -If the optional argument \fIdu\fP is given, the disk usage of users maildir will -be summarized and displayed too. -.TP -\fBusername\fP (\fBun\fP) \fIaddress\fP \fI'Users Name'\fP -The user's real name can be set/updated with this subcommand. -.PP -.nf - Example: - - \fBvmm un d.user@example.com 'John Doe'\fP -.fi -.TP -\fBuserpassword\fP (\fBup\fP) \fIaddress\fP [ \fIpassword\fP ] -The \fIpassword\fP from an account can be updated with this subcommand. -.br -If the \fIpassword\fP is not provided, \fBvmm\fP will prompt for it -interactively. -.PP -.nf - Example: - - \fBvmm up d.user@example.com 'A |\\/|0r3 5ecur3 P4s5\\/\\/0rd?'\fP -.fi -.TP -\fBusertransport\fP (\fBut\fP) \fIaddress\fP \fItransport\fP -A different transport for an account can be specified with this subcommand. -.PP -.nf - Example: - - \fBvmm ut d.user@example.com smtp:pc105.it.example.com\fP -.fi -.TP -\fBuserdisable\fP (\fBu0\fP) \fIaddress\fP [ \fIsmtp\fP | \fIpop3\fP |\ - \fIimap\fP | \fImanagesieve\fP | \fIall\fP ] -If a user shouldn't have access to one or all services you can restrict the -access with this subcommand. -.br -If neither a service nor the keyword '\fIall\fP' is given all services ('smtp', 'pop3', 'imap', and 'managesieve') will be disabled for the account with the specified -\fIaddress\fP. Otherwise only the specified service will be restricted. -.PP -.nf - Examples: - - \fBvmm u0 b.user@example.com imap\fP - \fBvmm userdisable c.user@example.com\fP -.fi -.TP -\fBuserenable\fP (\fBu1\fP) \fIaddress\fP [ \fIsmtp\fP | \fIpop3\fP |\ - \fIimap\fP | \fImanagesieve\fP | \fIall\fP ] -To allow access to one or all restricted services use this subcommand. -.br -If neither a service nor the keyword '\fIall\fP' is given all services ('smtp', 'pop3', 'imap', and 'managesieve') will be enabled for the account with the specified -\fIaddress\fP. Otherwise only the specified service will be enabled. -.TP -\fBuserdelete\fP (\fBud\fP) \fIaddress\fP -Use this subcommand to delete the account with the given \fIaddress\fP. -.\" -.SS ALIAS SUBCOMMANDS -.TP -\fBaliasadd\fP (\fBaa\fP) \fIalias\fP \fItarget\fP -This subcommand is used to create a new alias. -.PP -.nf - Examples: - - \fBvmm aliasadd john.doe@example.com d.user@example.com\fP - \fBvmm aa support@example.com d.user@example.com\fP - \fBvmm aa support@example.com e.user@example.com\fP -.fi -.TP -\fBaliasinfo\fP (\fBai\fP) \fIalias\fP -Information about an alias can be displayed with this subcommand. -.PP -.nf - Example: - - \fBvmm aliasinfo support@example.com\fP - Alias information - ----------------- - Mail for support@example.com goes to: - -> d.user@example.com - -> e.user@example.com -.fi -.TP -\fBaliasdelete\fP (\fBad\fP) \fIalias\fP [ \fItarget\fP ] -Use this subcommand to delete the \fIalias\fP. -.br -If the optional destination address \fItarget\fP is given, only this -destination will be removed from the \fIalias\fP. -.PP -.nf - Example: - \fBvmm ad support@example.com d.user@example.com\fP -.fi -.SH FILES -/usr/local/etc/vmm.cfg -.SH SEE ALSO -vmm.cfg(5), configuration file for vmm -.SH AUTHOR -\fBvmm\fP and its man pages were written by Pascal Volk -<\fIp.volk@veb-it.de\fP> and are licensed under the terms of the BSD License. diff -r 8a9ce20d2569 -r 89f952b0f366 vmm.cfg.5 --- a/vmm.cfg.5 Mon May 26 22:18:19 2008 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,213 +0,0 @@ -.\" $Id$ -.TH vmm.cfg 5 "30. April 2008" "Pascal Volk" -.SH NAME -vmm.cfg \- configuration file for vmm -.SH SYNOPSIS -/usr/local/etc/vmm.cfg -.SH DESCRIPTION -\fBvmm\fR(1) reads configuration data from \fI/usr/local/etc/vmm.cfg\fP. -.br -The configuration file is split in multiple sections. A section starts with the -section name, enclosed in square brackets '[' and ']' (e.g. \fB[database]\fP), -followed by \'option=value' pairs (e.g. \fBhost = 127.0.0.1\fP). -.br -Whitespace around the '=' and at the end of a value is ignored. -.PP -Empty lines and lines starting with '#' or ';' will be ignored. -.PP -Each value uses one of the following data types: -.IP \(bu -.I Boolean -to indicate if something is enabled/activated (true) or disabled/deactivated -(false). -.br -Accepted values for \fBtrue\fP are: \fB1\fP, \fByes\fP, \fBtrue\fP and -\fBon\fP. -.br -Accepted values for \fBfalse\fP are: \fB0\fP, \fBno\fP, \fBfalse\fP and -\fBoff\fP. -.IP \(bu -.I Int -a integer number, written without a fractional or decimal component. For example -\fB1\fP, \fB50\fP or \fB321\fP are integers. -.IP \(bu -.I String -a sequence of characters and numbers. For example '\fBword\fP', '\fBhello -world\fP', or '\fB/usr/bin/strings\fP' -.\" ----- -.SH DATABASE SECTION -The \fBdatabase\fP section is used to specify some options required to -connect to the database. -.TP -\fBhost\fP (\fIString\fP) -Hostname or IP address of the database server. -.TP -\fBuser\fP (\fIString\fP) -Name of the database user. -.TP -\fBpass\fP (\fIString\fP) -Database password -.TP -\fBname\fP (\fIString\fP) -Name of the database. -.TP -\fBExample\fP: -[database] -.br -host = localhost -.br -user = vmm -.br -pass = T~_:L4OYyl]TU?) -.br -name = mailsys -.\" ----- -.SH MAILDIR SECTION -The \fBmaildir\fP section is used to specify some options for the Maildirs. -.TP -\fBfolder\fP (\fIString\fP) -Default name of the maildir folder in users home directory. -.TP -\fBmode\fP (\fIInt\fP) -Access mode for the maildir in decimal (base 10) notation. For example: -\'drwx------' -> octal 0700 -> decimal 448 -.TP -\fBdiskusage\fP (\fIBoolean\fP) -Decides if the disk usage of users maildir always should be summarized an -displayed with account information. -.TP -\fBdelete\fP (\fIBoolean\fP) -Decides if the maildir should be deleted recursive when the account is deleted. -.TP -\fBExample\fP: -[maildir] -.br -folder = Maildir -.br -mode = 448 -.br -diskusage = false -.br -delete = false -.\" ----- -.SH SERVICES SECTION -The \fBservices\fP section is used to specify the default restrictions for -all accounts. -.TP -\fBsmtp\fP (\fIBoolean\fP) -Decides if users can login via smtp by default. -.TP -\fBpop3\fP (\fIBoolean\fP) -Decides if users can login via pop3 by default. -.TP -\fBimap\fP (\fIBoolean\fP) -Decides if users can login via imap by default. -.TP -\fBmanagesieve\fP (\fIBoolean\fP) -Decides if users can login via managesieve by default. -.TP -\fBExample\fP: -[services] -.br -smtp = true -.br -pop3 = true -.br -imap = false -.br -managesieve = false -.\" ----- -.SH DOMDIR SECTION -The \fBdomdir\fP section is used to specify options for the directories of the -domains. -.TP -\fBbase\fP (\fIString\fP) -All domain directories will be created inside this directory. -.TP -\fBmode\fP (\fIInt\fP) -Access mode for the domain directory in decimal (base 10) notation. For -example: 'drwxrwx---' -> octal 0770 -> decimal 504 -.TP -\fBdelete\fP (\fIBoolean\fP) -Decides if the domain directory and all user directories inside should be -deleted when a domain is deleted. -.TP -\fBExample\fP: -[domdir] -.br -base = /home/mail -.br -mode = 504 -.br -delete = false -.\" ----- -.SH BIN SECTION -The \fBbin\fP section is used to specify some paths to some binaries required -by \fBvmm\fP. -.TP -\fBdovecotpw\fP (\fIString\fP) -The absolute path to the dovecotpw binary. This binary is used to generate a -password hash, if the \fIpasswdscheme\fP is one of 'SMD5', 'SSHA', 'CRAM-MD5', -\'HMAC-MD5', 'LANMAN', 'NTLM' or 'RPA'. -.TP -\fBdu\fP (\fIString\fP) -The absolute path to \fBdu\fR(1). This binary is used to summarize the disk -usage of a maildir. -.TP -\fBExample\fP: -[bin] -.br -dovecotpw = /usr/sbin/dovecotpw -.br -du = /usr/bin/du -.\" ----- -.SH MISC SECTION -The \fBmisc\fP section is used to define miscellaneous settings. -.TP -\fBpasswdscheme\fP (\fIString\fP) -Password scheme to use (see also: dovecotpw -l) -.TP -\fBgid_mail\fP (\fIInt\fP) -Numeric group ID of group mail (mail_privileged_group from dovecot.conf) -.TP -\fBforcedel\fP (\fIBoolean\fP) -Force deletion of accounts and aliases when a domain is deleted. -.TP -\fBtransport\fP (\fIString\fP) -Default transport for domains and accounts. -.TP -\fBExample\fP: -[misc] -.br -passwdscheme = CRAM-MD5 -.br -gid_mail = 8 -.br -forcedel = false -.br -transport = dovecot: -.\" ----- -.SH CONFIG SECTION -The \fBconfig\fP section is a internal used control section. -.TP -\fBdone\fP (\fIBoolean\fP) -This option is set to \fIfalse\fP when \fBvmm\fP is installed for the first -time. When you edit \fIvmm.cfg\fP, set this option to \fItrue\fP. This option is -also set to \fItrue\fP when you configure vmm with the command \fBvmm -configure\fP. -.br -If this option is set to \fIfalse\fP, \fBvmm\fP will start in the interactive -configurations mode. -.TP -\fBExample\fP: -[config] -.br -done = true -.\" ----- -.SH FILES -/usr/local/etc/vmm.cfg -.SH SEE ALSO -vmm(1), command line tool to manage email domains/accounts/aliases -.SH AUTHOR -\fBvmm\fP and its man pages were written by Pascal Volk -<\fIp.volk@veb-it.de\fP> and are licensed under the terms of the BSD License.