# HG changeset patch # User Pascal Volk # Date 1263785030 0 # Node ID a72908248153e241f1b85d644846536931a859ae # Parent fd496561acc60acbbdba1e00024260fccc779517 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now diff -r fd496561acc6 -r a72908248153 man/de/man5/vmm.cfg.5 --- a/man/de/man5/vmm.cfg.5 Thu Jan 14 06:18:34 2010 +0000 +++ b/man/de/man5/vmm.cfg.5 Mon Jan 18 03:23:50 2010 +0000 @@ -1,273 +1,462 @@ -.TH vmm.cfg 5 "17 Aug 2009" "Pascal Volk" +.\" Man page generated from reStructeredText. +. +.TH VMM.CFG 5 "2010-01-18" "vmm-0.6.0" "vmm Manual" .SH NAME vmm.cfg \- Konfigurationsdatei für vmm +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. .SH SYNOPSIS +.sp vmm.cfg .SH BESCHREIBUNG -\fBvmm\fR(1) liest Konfigurationsparameter aus der Datei \fIvmm.cfg\fP. -.br +.sp +\fBvmm\fP(1) liest seine Konfigurationsparameter aus der Datei \fIvmm.cfg\fP. +.sp 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 +wird mit dem, in eckigen Klammern \(aq\fB[\fP\(aq und \(aq\fB]\fP\(aq eingefassten, Namen des +Abschnitts eingeleitet, gefolgt von \(aq\fIOption\fP = \fIWert\fP\(aq Einträgen: +.sp +.nf +.ft C +[database] +host = 127.0.0.1 +.ft P +.fi +.sp +Leerräume um das Gleichheitszeichen \(aq=\(aq und am Ende eines Wertes werden ignoriert. -.PP -Leerzeilen und Zeilen, die mit einer '#' oder einem ';' anfangen, werden +.sp +Leerzeilen und Zeilen, die mit einer \(aq#\(aq oder einem \(aq;\(aq anfangen, werden ignoriert. -.PP +.sp Jeder Wert ist von einem der folgenden Datentypen: -.IP \(bu -.I Boolean -um zu bestimmen, ob etwas eingeschaltet/aktiviert (true) oder +.INDENT 0.0 +.IP \(bu 2 +. +\fIBoolean\fP 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' +.nf +Mögliche Werte für \fItrue\fP sind: \fB1\fP, \fByes\fP, \fBtrue\fP und \fBon\fP. +Mögliche Werte für \fIfalse\fP sind: \fB0\fP, \fBno\fP, \fBfalse\fP und \fBoff\fP. +.fi +.sp +.IP \(bu 2 +. +\fIInt\fP eine Integer\-Zahl, geschrieben ohne eine gebrochene oder dezimale +Komponente. +.nf +Beispielsweise \fB1\fP, \fB50\fP oder \fB321\fP sind Integer\-Zahlen. +.fi +.sp +.IP \(bu 2 +. +\fIString\fP eine Folge von Buchstaben und Zahlen. +.nf +Zum Beispiel: \(aq\fBWort\fP\(aq, \(aq\fBHallo Welt\fP\(aq oder \(aq\fB/usr/bin/strings\fP\(aq +.fi +.sp +.UNINDENT .SS SUCHREIHENFOLGE -Standardmäßig sucht vmm die \fIvmm.cfg\fP in folgenden Verzeichnissen, in dieser -Reihenfolge: -.RS -.PD 0 +.sp +Standardmäßig sucht \fBvmm\fP(1) die \fIvmm.cfg\fP in folgenden Verzeichnissen, +in der angegebenen Reihenfolge: +.INDENT 0.0 +.INDENT 3.5 +.nf +\fI/root\fP +\fI/usr/local/etc\fP +\fI/etc\fP +.fi +.sp +.UNINDENT +.UNINDENT +.sp +Die zuerst gefundene Datei wird verwendet. +.SH ABSCHNITTE +.sp +Dieser Abschnitt beschreibt alle Abschnitte, sowie deren Optionen, der +\fIvmm.cfg\fP. +.SS ACCOUNT +.sp +Die Optionen des Abschnitts \fBaccount\fP legen Konto\-spezifische +Einstellungen fest. +.INDENT 0.0 +.TP +.B \fCdelete_directory\fP +\fIBoolean\fP +.sp +Bestimmt das Verhalten von \fBvmm\fP(1) beim Löschen eines Kontos. +Wenn der Wert dieser Option \fItrue\fP ist, wird das Home\-Verzeichnis des +zu löschenden Anwenders rekursiv gelöscht. .TP -.I -/root +.B \fCdirectory_mode\fP +\fIInt\fP +.sp +Zugriffsbits des Home\-Verzeichnisses, sowie aller enthaltenen +Verzeichnisse, in Dezimal\-Schreibweise (Basis 10). +.nf +Beispiel: \(aqdrwx\-\-\-\-\-\-\(aq \-> oktal 0700 \-> dezimal 448 +.fi +.sp +.TP +.B \fCdisk_usage\fP +\fIBoolean\fP +.sp +Legt fest, ob die Festplattenbelegung des Maildirs eines Benutzers jedes +Mal mit \fBdu\fP(1) ermittelt und mit den Konto\-Informationen ausgegeben +werden soll. +.sp +Bei umfangreichen Maildirs kann das langsam sein. Falls Sie Quotas +aktiviert haben, wird der \fBvmm\fP\-Unterbefehl \fBuserinfo\fP ebenfalls +die aktuelle Quota\-Nutzung des Kontos mit ausgegeben. Sie können auch +eines der optionalen Argumente \fBdu\fP oder \fBfull\fP an \fBuserinfo\fP +übergeben, um sich die aktuelle Festplattenbelegung anzeigen zu lassen. +.TP +.B \fCimap\fP +\fIBoolean\fP +.sp +Bestimmt, ob sich neu angelegte Benutzer per IMAP anmelden können sollen. +.TP +.B \fCpassword_length\fP +\fIInt\fP +.sp +Legt fest, wie viele Zahlen und/oder Buchstaben für ein automatisch +erzeugtes Passwort verwendet werden sollen. Alle Werte kleiner als 8 +werden auf 8 erhöht. +.TP +.B \fCpop3\fP +.sp +Bestimmt, ob sich neu angelegte Benutzer per POP3 anmelden können sollen. +.TP +.B \fCrandom_password\fP +\fIBoolean\fP +.sp +Mit dieser Option bestimmen Sie, ob \fBvmm\fP(1) ein zufälliges Passwort +generieren soll, wenn kein Passwort an den \fBuseradd\fP Unterbefehl +übergeben wurde. Ist der Wert dieser Option \fIfalse\fP, wird \fBvmm\fP Sie +auffordern, ein Passwort für den neun Account einzugeben. +.sp +Sie können die Länge für automatisch generierte Passwörter mit der +Option \fBpassword_length\fP konfigurieren. .TP -.I -/usr/local/etc +.B \fCsieve\fP +\fIBoolean\fP +.sp +Bestimmt, ob sich neu angelegte Benutzer per ManageSieve anmelden +können sollen. +.TP +.B \fCsmtp\fP +\fIBoolean\fP +.sp +Bestimmt, ob sich neu angelegte Benutzer per SMTP (SMTP AUTH) anmelden +können sollen. +.UNINDENT +.sp +Beispiel: +.sp +.nf +.ft C +[account] +delete_directory = false +directory_mode = 448 +disk_usage = false +random_password = true +password_length = 10 +smtp = true +pop3 = true +imap = true +sieve = true +.ft P +.fi +.SS BIN +.sp +Im \fBbin\fP\-Abschnitt werden Pfade zu Binaries angegeben, die von +\fBvmm\fP(1) benötigt werden. +.INDENT 0.0 +.TP +.B \fCdovecotpw\fP +\fIString\fP +.sp +Der absolute Pfad zum dovecotpw Binary. Dieses Binary wird zur +Hash\-Erzeugung verwendet, wenn \fBmisc.password_scheme\fP einen der +nachfolgenden Werte hat: \(aqSMD5\(aq, \(aqSSHA\(aq, \(aqCRAM\-MD5\(aq, \(aqHMAC\-MD5\(aq, +\(aqLANMAN\(aq, \(aqNTLM\(aq oder \(aqRPA\(aq. +.TP +.B \fCdu\fP +\fIString\fP +.sp +Der absolute Pfad zu \fBdu\fP(1). Dieses Binary wird verwendet, wenn +die Festplattenbelegung eines Kontos ermittelt wird. .TP -.I -/etc -.PD -.RE -.PP -Die zuerst gefundene Datei wird verwendet. -.\" ----- -.SH DATABASE ABSCHNITT -Der \fBdatabase\fP-Abschnitt wird verwendet, um die für den Datenbankzugriff -benötigten Optionen festzulegen. +.B \fCpostconf\fP +\fIString\fP +.sp +Der absolute Pfad zu Postfix\(aq \fBpostconf\fP(1). Dieses Binary wird +verwendet, wenn \fBvmm\fP(1) diverse Postfix\-Einstellungen prüft, zum +Beispiel das \fIvirtual_alias_expansion_limit\fP. +.UNINDENT +.sp +Beispiel: +.sp +.nf +.ft C +[bin] +dovecotpw = /usr/sbin/dovecotpw +du = /usr/bin/du +postconf = /usr/sbin/postconf +.ft P +.fi +.SS CONFIG +.sp +Beim \fBconfig\fP\-Abschnitt handelt es sich um einen internen +Steuerungs\-Abschnitt. +.INDENT 0.0 .TP -\fBhost\fP (\fIString\fP) -Der Hostname oder die IP-Adresse des Datenbank-Servers. +.B \fCdone\fP +\fIBoolean\fP +.sp +Diese Option hat den den Wert \fIfalse\fP, wenn \fBvmm\fP(1) zum ersten Mal +installiert wurde. Wenn Sie die Datei \fIvmm.cfg\fP von Hand editieren, +weisen Sie dieser Option abschließend den Wert \fItrue\fP zu. Wird die +Konfiguration über das Kommando \fBvmm configure\fP angepasst, wird der +Wert dieser Option automatisch auf \fItrue\fP gesetzt. +.sp +Sollte diese Option den Wert \fIfalse\fP zugewiesen haben, so startet +\fBvmm\fP(1) beim nächsten Aufruf im interaktiven Konfigurations\-Modus. +.UNINDENT +.sp +Beispiel: +.sp +.nf +.ft C +[config] +done = true +.ft P +.fi +.SS DATABASE +.sp +Der \fBdatabase\fP\-Abschnitt wird verwendet, um die für den Datenbankzugriff +benötigten Optionen festzulegen. +.INDENT 0.0 .TP -\fBuser\fP (\fIString\fP) -Der Name des Datenbank-Benutzers. +.B \fChost\fP +\fIString\fP +.sp +Der Hostname oder die IP\-Adresse des Datenbank\-Servers. .TP -\fBpass\fP (\fIString\fP) -Das Passwort des Datenbank-Benutzers -.TP -\fBname\fP (\fIString\fP) +.B \fCname\fP +\fIString\fP +.sp 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 -\fBname\fP (\fIString\fP) -Standard-Name des Maildir-Verzeichnisses im Verzeichnis des jeweiligen -Anwenders. +.B \fCpass\fP +\fIString\fP +.sp +Das Passwort des Datenbank\-Benutzers. .TP -\fBfolders\fP (\fIString\fP) -Eine durch Doppelpunkten getrennte Liste mit Verzeichnisnamen, die innerhalb des -Maildirs erstellt werden sollen. -.br -Sollen innerhalb des Maildirs keine Verzeichnisse angelegt werden, ist dieser -Optionen ein einzelner Doppelpunkt (':') als Wert zuzuweisen. +.B \fCuser\fP +\fIString\fP +.sp +Der Name des Datenbank\-Benutzers. +.UNINDENT +.sp +Beispiel: +.sp +.nf +.ft C +[database] +host = localhost +user = vmm +pass = PY_SRJ}L/0p\-oOk +name = mailsys +.ft P +.fi +.SS DOMAIN +.sp +Im \fBdomain\fP\-Abschnitt werden Domain\-spezifische Informationen konfiguriert. +.INDENT 0.0 .TP -\fBmode\fP (\fIInt\fP) -Zugriffsbits des Maildirs in Dezimal-Schreibweise (Basis 10). -.br -Beispiel: \'drwx------' -> oktal 0700 -> dezimal 448 +.B \fCauto_postmaster\fP +\fIBoolean\fP +.sp +Setzen Sie den Wert dieser Option auf \fItrue\fP, wenn \fBvmm\fP(1) +automatisch einen postmaster\-Account erstellen soll, wenn Sie eine neue +Domain anlegen. .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. +.B \fCdelete_directory\fP +\fIBoolean\fP +.sp +Bestimmt, ob beim Löschen einer Domain das Verzeichnis einer Domain, +inklusive aller Anwender\-Verzeichnisse, rekursiv gelöscht werden soll. .TP -\fBBeispiel\fP: -[maildir] -.br -name = Maildir -.br -folders = Drafts:Sent:Templates:Trash:INBOX.News -.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. +.B \fCdirectory_mode\fP +\fIInt\fP +.sp +Zugriffsbits des Domain\-Verzeichnisses in Dezimal\-Schreibweise (Basis +10). +.nf +Beispiel: \(aqdrwxrwx\-\-\-\(aq \-> oktal 0770 \-> dezimal 504 +.fi +.sp .TP -\fBsieve\fP (\fIBoolean\fP) -Legt fest, ob sich ein Anwender standardmäßig per MANAGESIEVE einloggen kann. +.B \fCforce_deletion\fP +\fIBoolean\fP +.sp +Legt fest, ob beim Löschen einer Domain alle vorhanden Konten und/oder +Aliase, ohne Nachfrage, gelöscht werden sollen. +.UNINDENT +.sp +Beispiel: +.sp +.nf +.ft C +[domain] +auto_postmaster = true +delete_directory = false +directory_mode = 504 +force_deletion = false +.ft P +.fi +.SS MAILDIR +.sp +Im \fBmaildir\fP\-Abschnitt werden die für die Maildirs erforderlichen Optionen +festgelegt. +.INDENT 0.0 .TP -\fBBeispiel\fP: -[services] -.br -smtp = true -.br -pop3 = true -.br -imap = false -.br -sieve = 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. +.B \fCfolders\fP +\fIString\fP +.sp +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 (\(aq\fB:\fP\(aq) als Wert zuzuweisen. +.sp +Wenn Sie Verzeichnisse mit Unterverzeichnissen anlegen wollen, +verwendenden Sie einen einzelnen Punkt (\(aq\fB.\fP\(aq) als Separator. .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. Dieses 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). Dieses Binary wird verwendet, wenn die -Festplattenbelegung eines Kontos ermittelt wird. +.B \fCname\fP +\fIString\fP +.sp +Standard\-Name des Maildir\-Verzeichnisses im Verzeichnis des jeweiligen +Anwenders. +.UNINDENT +.sp +Beispiel: +.sp +.nf +.ft C +[maildir] +folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix +name = Maildir +.ft P +.fi +.SS MISC +.sp +Im \fBmisc\fP\-Abschnitt werden verschiedene Einstellungen festgelegt. +.INDENT 0.0 .TP -\fBpostconf\fP (\fIString\fP) -Der absolute Pfad zu Postfix' \fBpostconf\fR(1). -.br -Dieses Binary wird verwendet, wenn \fBvmm\fR(1) diverse Postfix-Einstellungen -prüft, zum Beispiel virtual_alias_expansion_limit. +.B \fCbase_directory\fP +\fIString\fP +.sp +Alle Domain\-Verzeichnisse werden innerhalb dieses Basis\-Verzeichnisses +angelegt. +.TP +.B \fCpassword_scheme\fP +\fIString\fP +.sp +Das zu verwendende Passwort\-Schema (siehe auch: \fBdovecotpw \-l\fP). .TP -\fBBeispiel\fP: -[bin] -.br -dovecotpw = /usr/sbin/dovecotpw -.br -du = /usr/bin/du -.br -postconf = /usr/sbin/postconf -.\" ----- -.SH MISC ABSCHNITT -Im \fBmisc\fP-Abschnitt werden verschiedene Einstellungen festgelegt. +.B \fCgid_mail\fP +\fIInt\fP +.sp +Die numerische Gruppen\-ID der Gruppe mail, bzw. der Gruppe aus +\fImail_privileged_group\fP der Datei \fIdovecot.conf\fP. .TP -\fBpasswdscheme\fP (\fIString\fP) -Das zu verwendende 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. +.B \fCtransport\fP +\fIString\fP +.sp +Der Standard\-Transport aller Domains und Konten. Siehe auch: +\fBtransport\fP(5) .TP -\fBtransport\fP (\fIString\fP) -Der Standard-Transport aller Domains und Konten. -.TP -\fBdovecotvers\fP (\fIInt\fP) -Die verketteten Major- und Minor-Teile der eingesetzten Dovecot-Version -(siehe: dovecot --version). -.br -Diese Option beeinflusst diverse Datenbankzugriffe. Da es zwischen Dovecot -v1.1.x und v1.2.x einige Änderungen gab. Zum Beispiel \fB11\fP, falls -\fBdovecot --version\fP den Wert \fB1.1\fP.18 ausgibt. -.TP -\fBBeispiel\fP: +.B \fCdovecot_version\fP +\fIInt\fP +.sp +Die verketteten Major\- und Minor\-Teile der eingesetzten Dovecot\-Version +(siehe: \fBdovecot \-\-version\fP). +.sp +Diese Option beeinflusst diverse Datenbankzugriffe. Da es zwischen +Dovecot v1.1.x und v1.2.x einige Änderungen gab. Zum Beispiel \fB11\fP, +falls \fBdovecot \-\-version\fP den Wert 1.1.18 ausgibt. +.UNINDENT +.sp +Beispiel: +.sp +.nf +.ft C [misc] -.br -passwdscheme = CRAM-MD5 -.br +base_directory = /srv/mail +password_scheme = CRAM\-MD5 gid_mail = 8 -.br -forcedel = false -.br transport = dovecot: -.br -dovecotvers = 11 -.\" ----- -.SH CONFIG ABSCHNITT -Beim \fBconfig\fP-Abschnitt handelt es sich um einen internen -Steuerungs-Abschnitt. +dovecot_version = 11 +.ft P +.fi +.SH DATEIEN +.INDENT 0.0 +.TP +.B \fI/root/vmm.cfg\fP +.nf +Wird verwendet, falls vorhanden. +.fi +.sp +.TP +.B \fI/usr/local/etc/vmm.cfg\fP +.nf +Wird verwendet, sollte obige Datei nicht gefunden werden. +.fi +.sp .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, weisen 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 -vmm.cfg +.B \fI/etc/vmm.cfg\fP +.nf +Wird verwendet, falls obengenannte Dateien nicht existieren. +.fi +.sp +.UNINDENT .SH SIEHE AUCH -vmm(1), Programm für die Kommandozeile, um E-Mail-Domains, -Konten und -Aliase +.sp +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 -<\fIneverseen@users.sourceforge.net\fP> geschrieben und sind unter den -Bedingungen der BSD Lizenz lizenziert. +.SH COPYING +.sp +vmm und die dazugehörigen Manualseiten wurden von Pascal Volk geschrieben +und sind unter den Bedingungen der BSD Lizenz lizenziert. +.SH AUTHOR +Pascal Volk +.\" Generated by docutils manpage writer. +.\" +. diff -r fd496561acc6 -r a72908248153 man/de/man5/vmm.cfg.5.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/man/de/man5/vmm.cfg.5.rst Mon Jan 18 03:23:50 2010 +0000 @@ -0,0 +1,323 @@ +========= + vmm.cfg +========= + +--------------------------- +Konfigurationsdatei für vmm +--------------------------- + +:Author: Pascal Volk +:Date: 2010-01-18 +:Version: vmm-0.6.0 +:Manual group: vmm Manual +:Manual section: 5 + +.. contents:: + :backlinks: top + :class: htmlout + +SYNOPSIS +======== +vmm.cfg + +BESCHREIBUNG +============ +**vmm**\(1) liest seine Konfigurationsparameter aus der Datei *vmm.cfg*. + +Die Konfigurationsdatei ist in mehrere Abschnitte unterteilt. Jeder Abschnitt +wird mit dem, in eckigen Klammern '**[**' und '**]**' eingefassten, Namen des +Abschnitts eingeleitet, gefolgt von '*Option* = *Wert*' Einträgen:: + + [database] + host = 127.0.0.1 + +Leerräume um das Gleichheitszeichen '=' und am Ende eines Wertes werden +ignoriert. + +Leerzeilen und Zeilen, die mit einer '#' oder einem ';' anfangen, werden +ignoriert. + +Jeder Wert ist von einem der folgenden Datentypen: + +* *Boolean* um zu bestimmen, ob etwas eingeschaltet/aktiviert (true) oder + ausgeschaltet/deaktiviert (false) ist. + + | Mögliche Werte für *true* sind: **1**, **yes**, **true** und **on**. + | Mögliche Werte für *false* sind: **0**, **no**, **false** und **off**. + +* *Int* eine Integer-Zahl, geschrieben ohne eine gebrochene oder dezimale + Komponente. + + | Beispielsweise **1**, **50** oder **321** sind Integer-Zahlen. + +* *String* eine Folge von Buchstaben und Zahlen. + + | Zum Beispiel: '**Wort**', '**Hallo Welt**' oder '**/usr/bin/strings**' + + +SUCHREIHENFOLGE +--------------- +Standardmäßig sucht **vmm**\(1) die *vmm.cfg* in folgenden Verzeichnissen, +in der angegebenen Reihenfolge: + + | */root* + | */usr/local/etc* + | */etc* + +Die zuerst gefundene Datei wird verwendet. + +ABSCHNITTE +========== +Dieser Abschnitt beschreibt alle Abschnitte, sowie deren Optionen, der +*vmm.cfg*. + +ACCOUNT +------- +Die Optionen des Abschnitts **account** legen Konto-spezifische +Einstellungen fest. + +``delete_directory`` : *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. + +``directory_mode`` : *Int* + Zugriffsbits des Home-Verzeichnisses, sowie aller enthaltenen + Verzeichnisse, in Dezimal-Schreibweise (Basis 10). + + | Beispiel: 'drwx------' -> oktal 0700 -> dezimal 448 + +``disk_usage`` : *Boolean* + 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. + +``imap`` : *Boolean* + Bestimmt, ob sich neu angelegte Benutzer per IMAP anmelden können sollen. + +``password_length`` : *Int* + Legt fest, wie viele Zahlen und/oder Buchstaben für ein automatisch + erzeugtes Passwort verwendet werden sollen. Alle Werte kleiner als 8 + werden auf 8 erhöht. + +``pop3`` + Bestimmt, ob sich neu angelegte Benutzer per POP3 anmelden können sollen. + +``random_password`` : *Boolean* + Mit dieser Option bestimmen Sie, 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. + + Sie können die Länge für automatisch generierte Passwörter mit der + Option **password_length** konfigurieren. + +``sieve`` : *Boolean* + Bestimmt, ob sich neu angelegte Benutzer per ManageSieve anmelden + können sollen. + +``smtp`` : *Boolean* + 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 + +BIN +--- +Im **bin**-Abschnitt werden Pfade zu Binaries angegeben, die von +**vmm**\(1) benötigt werden. + +``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'. + +``du`` : *String* + Der absolute Pfad zu **du**\(1). Dieses Binary wird verwendet, wenn + die Festplattenbelegung eines Kontos ermittelt wird. + +``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`. + +Beispiel:: + + [bin] + dovecotpw = /usr/sbin/dovecotpw + du = /usr/bin/du + postconf = /usr/sbin/postconf + +CONFIG +------ +Beim **config**-Abschnitt handelt es sich um einen internen +Steuerungs-Abschnitt. + +``done`` : *Boolean* + Diese Option hat den 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. + + Sollte diese Option den Wert *false* zugewiesen haben, so startet + **vmm**\(1) beim nächsten Aufruf im interaktiven Konfigurations-Modus. + +Beispiel:: + + [config] + done = true + +DATABASE +-------- +Der **database**-Abschnitt wird verwendet, um die für den Datenbankzugriff +benötigten Optionen festzulegen. + +``host`` : *String* + Der Hostname oder die IP-Adresse des Datenbank-Servers. + +``name`` : *String* + Name der zu verwendenden Datenbank. + +``pass`` : *String* + Das Passwort des Datenbank-Benutzers. + +``user`` : *String* + Der Name des Datenbank-Benutzers. + +Beispiel:: + + [database] + host = localhost + user = vmm + pass = PY_SRJ}L/0p-oOk + name = mailsys + +DOMAIN +------ +Im **domain**-Abschnitt werden Domain-spezifische Informationen konfiguriert. + +``auto_postmaster`` : *Boolean* + Setzen Sie den Wert dieser Option auf *true*, wenn **vmm**\(1) + automatisch einen postmaster-Account erstellen soll, wenn Sie eine neue + Domain anlegen. + +``delete_directory`` : *Boolean* + Bestimmt, ob beim Löschen einer Domain das Verzeichnis einer Domain, + inklusive aller Anwender-Verzeichnisse, rekursiv gelöscht werden soll. + +``directory_mode`` : *Int* + Zugriffsbits des Domain-Verzeichnisses in Dezimal-Schreibweise (Basis + 10). + + | Beispiel: 'drwxrwx---' -> oktal 0770 -> dezimal 504 + +``force_deletion`` : *Boolean* + Legt fest, ob beim Löschen einer Domain alle vorhanden Konten und/oder + Aliase, ohne Nachfrage, gelöscht werden sollen. + +Beispiel:: + + [domain] + auto_postmaster = true + delete_directory = false + directory_mode = 504 + force_deletion = false + +MAILDIR +------- +Im **maildir**-Abschnitt werden die für die Maildirs erforderlichen Optionen +festgelegt. + +``folders`` : *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. + + Wenn Sie Verzeichnisse mit Unterverzeichnissen anlegen wollen, + verwendenden Sie einen einzelnen Punkt ('**.**') als Separator. + +``name`` : *String* + Standard-Name des Maildir-Verzeichnisses im Verzeichnis des jeweiligen + Anwenders. + +Beispiel:: + + [maildir] + folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix + name = Maildir + +MISC +---- +Im **misc**-Abschnitt werden verschiedene Einstellungen festgelegt. + +``base_directory`` : *String* + Alle Domain-Verzeichnisse werden innerhalb dieses Basis-Verzeichnisses + angelegt. + +``password_scheme`` : *String* + Das zu verwendende Passwort-Schema (siehe auch: **dovecotpw -l**). + +``gid_mail`` : *Int* + Die numerische Gruppen-ID der Gruppe mail, bzw. der Gruppe aus + `mail_privileged_group` der Datei *dovecot.conf*. + +``transport`` : *String* + Der Standard-Transport aller Domains und Konten. Siehe auch: + **transport**\(5) + +``dovecot_version`` : *Int* + Die verketteten Major- und Minor-Teile der eingesetzten Dovecot-Version + (siehe: **dovecot --version**). + + Diese Option beeinflusst diverse Datenbankzugriffe. Da es zwischen + Dovecot v1.1.x und v1.2.x einige Änderungen gab. Zum Beispiel **11**, + falls **dovecot --version** den Wert 1.1.18 ausgibt. + +Beispiel:: + + [misc] + base_directory = /srv/mail + password_scheme = CRAM-MD5 + gid_mail = 8 + transport = dovecot: + dovecot_version = 11 + +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(1), Programm für die Kommandozeile, um E-Mail-Domains, -Konten und -Aliase +zu verwalten. + +COPYING +======= +vmm und die dazugehörigen Manualseiten wurden von Pascal Volk geschrieben +und sind unter den Bedingungen der BSD Lizenz lizenziert. + diff -r fd496561acc6 -r a72908248153 man/man5/vmm.cfg.5 --- a/man/man5/vmm.cfg.5 Thu Jan 14 06:18:34 2010 +0000 +++ b/man/man5/vmm.cfg.5 Mon Jan 18 03:23:50 2010 +0000 @@ -1,256 +1,449 @@ -.TH vmm.cfg 5 "17 Aug 2009" "Pascal Volk" +.\" Man page generated from reStructeredText. +. +.TH VMM.CFG 5 "2010-01-18" "vmm-0.6.0" "vmm Manual" .SH NAME vmm.cfg \- configuration file for vmm +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.\" to create a man page strip the next part: +.\" rst2man --strip-elements-with-class=htmlout in.rst out +. .SH SYNOPSIS +.sp vmm.cfg .SH DESCRIPTION -\fBvmm\fR(1) reads configuration data from \fIvmm.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 +.sp +\fBvmm\fP(1) reads its configuration data from \fIvmm.cfg\fP. +.sp +The configuration file is split into multiple sections. A section starts with +the section name, enclosed in square brackets \(aq\fB[\fP\(aq and \(aq\fB]\fP\(aq, followed +by \(aq\fIoption\fP = \fIvalue\fP\(aq pairs: +.sp +.nf +.ft C +[database] +host = 127.0.0.1 +.ft P +.fi +.sp +Whitespace around the \(aq=\(aq and at the end of a value is ignored. +.sp +Empty lines and lines starting with \(aq#\(aq or \(aq;\(aq will be ignored. +.sp 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' +.INDENT 0.0 +.IP \(bu 2 +. +\fIBoolean\fP to indicate if something is enabled/activated (true) or +disabled/deactivated (false). +.nf +Accepted values for \fItrue\fP are: \fB1\fP, \fByes\fP, \fBtrue\fP and \fBon\fP. +Accepted values for \fIfalse\fP are: \fB0\fP, \fBno\fP, \fBfalse\fP and \fBoff\fP. +.fi +.sp +.IP \(bu 2 +. +\fIInt\fP an integer number, written without a fractional or decimal component. +.nf +For example \fB1\fP, \fB50\fP or \fB321\fP are integers. +.fi +.sp +.IP \(bu 2 +. +\fIString\fP a sequence of characters and numbers. +.nf +For example \(aq\fBword\fP\(aq, \(aq\fBhello world\fP\(aq or \(aq\fB/usr/bin/strings\fP\(aq +.fi +.sp +.UNINDENT .SS SEARCH ORDER -By default vmm looks for \fIvmm.cfg\fP in the following directories in the +.sp +By default \fBvmm\fP(1) looks for \fIvmm.cfg\fP in the following directories in the order listed: -.RS -.PD 0 +.INDENT 0.0 +.INDENT 3.5 +.nf +\fI/root\fP +\fI/usr/local/etc\fP +\fI/etc\fP +.fi +.sp +.UNINDENT +.UNINDENT +.sp +The first configuration file found will be used. +.SH SECTIONS +.sp +This section describes all sections and their options of the \fIvmm.cfg\fP. +.SS ACCOUNT +.sp +The options in the section \fBaccount\fP are used to specify user account +related settings. +.INDENT 0.0 +.TP +.B \fCdelete_directory\fP +\fIBoolean\fP +.sp +Determines the behavior of \fBvmm\fP(1) when an account is deleted. If +this option is set to \fItrue\fP the user\(aqs home directory will be deleted +recursively. +.TP +.B \fCdirectory_mode\fP +\fIInt\fP +.sp +Access mode for a user\(aqs home directory and all directories inside. +The value has to be specified in decimal (base 10) notation. +.nf +For example: \(aqdrwx\-\-\-\-\-\-\(aq \-> octal 0700 \-> decimal 448 +.fi +.sp .TP -.I -/root +.B \fCdisk_usage\fP +\fIBoolean\fP +.sp +Determines whether the disk usage of a user\(aqs Maildir always should be +summarized, using \fBdu\fP(1), and displayed with account information. +.sp +This could be slow on large Maildirs. When you have enabled quotas, +\fBvmm\fP\(aqs \fBuserinfo\fP subcomammand will also display the current quota +usage of the account. You may also use \fBuserinfo\fP\(aqs optional argument +\fBdu\fP or \fBfull\fP, in order to display the current disk usage of an +account. +.TP +.B \fCimap\fP +\fIBoolean\fP +.sp +Determines whether a newly created user can log in via IMAP. +.TP +.B \fCpassword_length\fP +\fIInt\fP +.sp +Determines how many characters and/or numbers should be used for random +generated passwords. Any value less than 8 will be increased to 8. +.TP +.B \fCpop3\fP +\fIBoolean\fP +.sp +Determines whether a newly created user can log in via POP3. +.TP +.B \fCrandom_password\fP +\fIBoolean\fP +.sp +Determines whether \fBvmm\fP should generate a random password when no +password was given for the \fBuseradd\fP subcommand. If this option is +set to \fIfalse\fP \fBvmm\fP will prompt you to enter a password for the new +account. +.sp +You can specify the password length of generated passwords with the +\fBpassword_length\fP option. +.TP +.B \fCsieve\fP +\fIBoolean\fP +.sp +Determines whether a newly created user can log in via ManageSieve. .TP -.I -/usr/local/etc +.B \fCsmtp\fP +\fIBoolean\fP +.sp +Determines whether a newly created user can log in via SMTP (SMTP AUTH). +.UNINDENT +.sp +Example: +.sp +.nf +.ft C +[account] +delete_directory = false +directory_mode = 448 +disk_usage = false +random_password = true +password_length = 10 +smtp = true +pop3 = true +imap = true +sieve = true +.ft P +.fi +.SS BIN +.sp +The \fBbin\fP section is used to specify some paths to some binaries required +by \fBvmm\fP(1). +.INDENT 0.0 +.TP +.B \fCdovecotpw\fP +\fIString\fP +.sp +The absolute path to the dovecotpw binary. This binary is used to +generate a password hash, if \fBmisc.password_scheme\fP is set to one of +\(aqSMD5\(aq, \(aqSSHA\(aq, \(aqCRAM\-MD5\(aq, \(aqHMAC\-MD5\(aq, \(aqLANMAN\(aq, \(aqNTLM\(aq or \(aqRPA\(aq. +.TP +.B \fCdu\fP +\fIString\fP +.sp +The absolute path to \fBdu\fP(1). This binary is used to summarize the +disk usage of a user\(aqs Maildir. .TP -.I -/etc -.PD -.RE -.PP -The first match it finds will be used. -.\" ----- -.SH DATABASE SECTION +.B \fCpostconf\fP +\fIString\fP +.sp +The absolute path to Postfix\(aq \fBpostconf\fP(1). This binary is required +when \fBvmm\fP(1) has to check for some Postfix settings, e.g. +\fIvirtual_alias_expansion_limit\fP. +.UNINDENT +.sp +Example: +.sp +.nf +.ft C +[bin] +dovecotpw = /usr/sbin/dovecotpw +du = /usr/bin/du +postconf = /usr/sbin/postconf +.ft P +.fi +.SS CONFIG +.sp +The \fBconfig\fP section is an internal used control section. +.INDENT 0.0 +.TP +.B \fCdone\fP +\fIBoolean\fP +.sp +This option is set to \fIfalse\fP when \fBvmm\fP(1) 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 \fBvmm\fP(1) with the command \fBvmm +configure\fP. +.sp +If this option is set to \fIfalse\fP, \fBvmm\fP(1) will start in the +interactive configurations mode. +.UNINDENT +.sp +Example: +.sp +.nf +.ft C +[config] +done = true +.ft P +.fi +.SS DATABASE +.sp The \fBdatabase\fP section is used to specify some options required to connect to the database. +.INDENT 0.0 .TP -\fBhost\fP (\fIString\fP) +.B \fChost\fP +\fIString\fP +.sp 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) +.B \fCname\fP +\fIString\fP +.sp Name of the database. .TP -\fBExample\fP: +.B \fCpass\fP +\fIString\fP +.sp +Database password. +.TP +.B \fCuser\fP +\fIString\fP +.sp +Name of the database user. +.UNINDENT +.sp +Example: +.sp +.nf +.ft C [database] -.br host = localhost -.br user = vmm -.br -pass = T~_:L4OYyl]TU?) -.br +pass = PY_SRJ}L/0p\-oOk name = mailsys -.\" ----- -.SH MAILDIR SECTION -The \fBmaildir\fP section is used to specify some options for the Maildirs. +.ft P +.fi +.SS DOMAIN +.sp +The \fBdomain\fP section specifies some domain related settings. +.INDENT 0.0 .TP -\fBname\fP (\fIString\fP) -Default name of the maildir folder in users home directory. +.B \fCauto_postmaster\fP +\fIBoolean\fP +.sp +Determines if \fBvmm\fP(1) should create also a postmaster account when a +new domain is created. +.TP +.B \fCdelete_directory\fP +\fIBoolean\fP +.sp +Specifies whether the domain directory and all user directories inside +should be deleted when a domain is deleted. .TP -\fBfolders\fP (\fIString\fP) -A colon separated list of folder names, that should be created. -.br -If no folders should be created inside the Maildir, set the value of this option -to a single colon (':'). -.TP -\fBmode\fP (\fIInt\fP) -Access mode for the maildir in decimal (base 10) notation. For example: -\'drwx------' -> octal 0700 -> decimal 448 +.B \fCdirectory_mode\fP +\fIInt\fP +.sp +Access mode for the domain directory in decimal (base 10) notation. +.nf +For example: \(aqdrwxrwx\-\-\-\(aq \-> octal 0770 \-> decimal 504 +.fi +.sp .TP -\fBdiskusage\fP (\fIBoolean\fP) -Decides if the disk usage of users maildir always should be summarized and -displayed with account information. +.B \fCforce_deletion\fP +\fIBoolean\fP +.sp +Force deletion of accounts and aliases when a domain is deleted. +.UNINDENT +.sp +Example: +.sp +.nf +.ft C +[domain] +auto_postmaster = true +delete_directory = false +directory_mode = 504 +force_deletion = false +.ft P +.fi +.SS MAILDIR +.sp +The \fBmaildir\fP section is used to specify some default options for new +created Maildirs and folders inside. +.INDENT 0.0 .TP -\fBdelete\fP (\fIBoolean\fP) -Decides if the maildir should be deleted recursive when the account is deleted. +.B \fCfolders\fP +\fIString\fP +.sp +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 (\(aq\fB:\fP\(aq). +.sp +If you want to create folders containing one or more subfolders, separate +them with a single dot (\(aq\fB.\fP\(aq). .TP -\fBExample\fP: +.B \fCname\fP +\fIString\fP +.sp +Default name of the Maildir folder in users home directories. +.UNINDENT +.sp +Example: +.sp +.nf +.ft C [maildir] -.br +folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix name = Maildir -.br -folders = Drafts:Sent:Templates:Trash:INBOX.News -.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. +.ft P +.fi +.SS MISC +.sp +The \fBmisc\fP section is used to define miscellaneous settings. +.INDENT 0.0 .TP -\fBimap\fP (\fIBoolean\fP) -Decides if users can login via imap by default. -.TP -\fBsieve\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 -sieve = false -.\" ----- -.SH DOMDIR SECTION -The \fBdomdir\fP section is used to specify options for the directories of the -domains. -.TP -\fBbase\fP (\fIString\fP) +.B \fCbase_directory\fP +\fIString\fP +.sp 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. +.B \fCpassword_scheme\fP +\fIString\fP +.sp +Password scheme to use (see also: \fBdovecotpw \-l\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 -\fBpostconf\fP (\fIString\fP) -The absolute path to Postfix' \fBpostconf\fR(1). -.br -This binary is required if \fBvmm\fR(1) has to check for some Postfix settings, -e.g. virtual_alias_expansion_limit. +.B \fCgid_mail\fP +\fIInt\fP +.sp +Numeric group ID of group mail (\fImail_privileged_group\fP from +\fIdovecot.conf\fP) .TP -\fBExample\fP: -[bin] -.br -dovecotpw = /usr/sbin/dovecotpw -.br -du = /usr/bin/du -.br -postconf = /usr/sbin/postconf -.\" ----- -.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) +.B \fCtransport\fP +\fIString\fP +.sp +Default transport for domains and accounts. For details see +\fBtransport\fP(5). .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 -\fBdovecotvers\fP (\fIInt\fP) -The concatenated major and minor version number of the currently used Dovecot -version. (see: dovecot --version). -.br -This option affects various database operations. There are some differences -between Dovecot v1.1.x and v1.2.x. For example, when the command \fBdovecot ---version\fP shows \fB1.1\fP.18, set the value of this option to \fB11\fP. -.TP -\fBExample\fP: +.B \fCdovecot_version\fP +\fIInt\fP +.sp +The concatenated major and minor version number of the currently used +Dovecot version. (see: \fBdovecot \-\-version\fP). +.sp +This option affects various database operations. There are some +differences between Dovecot v1.1.x and v1.2.x. For example, when the +command \fBdovecot \-\-version\fP shows 1.1.18, set the value of this option +to \fB11\fP. +.UNINDENT +.sp +Example: +.sp +.nf +.ft C [misc] -.br -passwdscheme = CRAM-MD5 -.br +base_directory = /srv/mail +password_scheme = CRAM\-MD5 gid_mail = 8 -.br -forcedel = false -.br transport = dovecot: -.br -dovecotvers = 11 -.\" ----- -.SH CONFIG SECTION -The \fBconfig\fP section is a internal used control section. +dovecot_version = 11 +.ft P +.fi +.SH FILES +.INDENT 0.0 +.TP +.B \fI/root/vmm.cfg\fP +.nf +will be used when found. +.fi +.sp +.TP +.B \fI/usr/local/etc/vmm.cfg\fP +.nf +will be used when the above file doesn\(aqt exist. +.fi +.sp .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 -vmm.cfg +.B \fI/etc/vmm.cfg\fP +.nf +will be used when none of the both above mentioned files exists. +.fi +.sp +.UNINDENT .SH SEE ALSO +.sp vmm(1), command line tool to manage email domains/accounts/aliases +.SH COPYING +.sp +vmm and its manual pages were written by Pascal Volk and are licensed under +the terms of the BSD License. .SH AUTHOR -\fBvmm\fP and its man pages were written by Pascal Volk -<\fIneverseen@users.sourceforge.net\fP> and are licensed under the terms of the -BSD License. +Pascal Volk +.\" Generated by docutils manpage writer. +.\" +. diff -r fd496561acc6 -r a72908248153 man/man5/vmm.cfg.5.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/man/man5/vmm.cfg.5.rst Mon Jan 18 03:23:50 2010 +0000 @@ -0,0 +1,305 @@ +========= + vmm.cfg +========= + +-------------------------- +configuration file for vmm +-------------------------- + +:Author: Pascal Volk +:Date: 2010-01-18 +:Version: vmm-0.6.0 +:Manual group: vmm Manual +:Manual section: 5 + +.. contents:: + :backlinks: top + :class: htmlout + +SYNOPSIS +======== +vmm.cfg + +DESCRIPTION +=========== +**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 +by '*option* = *value*' pairs:: + + [database] + host = 127.0.0.1 + +Whitespace around the '=' and at the end of a value is ignored. + +Empty lines and lines starting with '#' or ';' will be ignored. + +Each value uses one of the following data types: + +* *Boolean* to indicate if something is enabled/activated (true) or + disabled/deactivated (false). + + | Accepted values for *true* are: **1**, **yes**, **true** and **on**. + | Accepted values for *false* are: **0**, **no**, **false** and **off**. + +* *Int* an integer number, written without a fractional or decimal component. + + | For example **1**, **50** or **321** are integers. + +* *String* a sequence of characters and numbers. + + | For example '**word**', '**hello world**' or '**/usr/bin/strings**' + +SEARCH ORDER +------------- +By default **vmm**\(1) looks for *vmm.cfg* in the following directories in the +order listed: + + | */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. + +``delete_directory`` : *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. + +``directory_mode`` : *Int* + 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 + +``disk_usage`` : *Boolean* + 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. + +``imap`` : *Boolean* + Determines whether a newly created user can log in via IMAP. + +``password_length`` : *Int* + Determines how many characters and/or numbers should be used for random + generated passwords. Any value less than 8 will be increased to 8. + +``pop3`` : *Boolean* + Determines whether a newly created user can log in via POP3. + +``random_password`` : *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. + + You can specify the password length of generated passwords with the + **password_length** option. + +``sieve`` : *Boolean* + Determines whether a newly created user can log in via ManageSieve. + +``smtp`` : *Boolean* + 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 + +BIN +--- +The **bin** section is used to specify some paths to some binaries required +by **vmm**\(1). + +``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'. + +``du`` : *String* + The absolute path to **du**\(1). This binary is used to summarize the + disk usage of a user's Maildir. + +``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`. + +Example:: + + [bin] + dovecotpw = /usr/sbin/dovecotpw + du = /usr/bin/du + postconf = /usr/sbin/postconf + +CONFIG +------ +The **config** section is an internal used control section. + +``done`` : *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**. + + If this option is set to *false*, **vmm**\(1) will start in the + interactive configurations mode. + +Example:: + + [config] + done = true + +DATABASE +-------- +The **database** section is used to specify some options required to +connect to the database. + +``host`` : *String* + Hostname or IP address of the database server. + +``name`` : *String* + Name of the database. + +``pass`` : *String* + Database password. + +``user`` : *String* + Name of the database user. + +Example:: + + [database] + host = localhost + user = vmm + pass = PY_SRJ}L/0p-oOk + name = mailsys + +DOMAIN +------ +The **domain** section specifies some domain related settings. + +``auto_postmaster`` : *Boolean* + Determines if **vmm**\(1) should create also a postmaster account when a + new domain is created. + +``delete_directory`` : *Boolean* + Specifies whether the domain directory and all user directories inside + should be deleted when a domain is deleted. + +``directory_mode`` : *Int* + Access mode for the domain directory in decimal (base 10) notation. + + | For example: 'drwxrwx---' -> octal 0770 -> decimal 504 + +``force_deletion`` : *Boolean* + Force deletion of accounts and aliases when a domain is deleted. + +Example:: + + [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. + +``folders`` : *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 ('**:**'). + + If you want to create folders containing one or more subfolders, separate + them with a single dot ('**.**'). + +``name`` : *String* + Default name of the Maildir folder in users home directories. + +Example:: + + [maildir] + folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix + name = Maildir + +MISC +---- +The **misc** section is used to define miscellaneous settings. + +``base_directory`` : *String* + All domain directories will be created inside this directory. + +``password_scheme`` : *String* + Password scheme to use (see also: **dovecotpw -l**). + +``gid_mail`` : *Int* + Numeric group ID of group mail (`mail_privileged_group` from + *dovecot.conf*) + +``transport`` : *String* + Default transport for domains and accounts. For details see + **transport**\(5). + +``dovecot_version`` : *Int* + The concatenated major and minor version number of the currently used + Dovecot version. (see: **dovecot --version**). + + This option affects various database operations. There are some + differences between Dovecot v1.1.x and v1.2.x. For example, when the + command **dovecot --version** shows 1.1.18, set the value of this option + to **11**. + +Example:: + + [misc] + base_directory = /srv/mail + password_scheme = CRAM-MD5 + gid_mail = 8 + transport = dovecot: + dovecot_version = 11 + +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(1), command line tool to manage email domains/accounts/aliases + +COPYING +======= +vmm and its manual pages were written by Pascal Volk and are licensed under +the terms of the BSD License. +