man5: Moved some option descriptions to section doamin, v0.6.x
authorPascal Volk <neverseen@users.sourceforge.net>
Sun, 06 Nov 2011 04:47:43 +0000
branchv0.6.x
changeset 460 e57dd007d69a
parent 459 033a0436894f
child 461 cabdf94ec580
man5: Moved some option descriptions to section doamin, accordingly to commit 4ff0fa3ba0fa. Added a brief explanation of which settings will be applied in which situations.
man/de/man5/vmm.cfg.5
man/man5/vmm.cfg.5
--- a/man/de/man5/vmm.cfg.5	Sat Nov 05 21:54:31 2011 +0000
+++ b/man/de/man5/vmm.cfg.5	Sun Nov 06 04:47:43 2011 +0000
@@ -1,4 +1,4 @@
-.TH "VMM.CFG" "5" "2011-10-26" "vmm 0.6" "vmm"
+.TH "VMM.CFG" "5" "2011-11-06" "vmm 0.6" "vmm"
 .SH NAME
 vmm.cfg \- Konfigurationsdatei für vmm
 .\" -----------------------------------------------------------------------
@@ -140,12 +140,6 @@
 an userinfo übergeben, um sich die aktuelle Festplattenbelegung anzeigen zu
 lassen.
 .\" ------------------------------------
-.SS account.imap
-.BR imap " (Vorgabe: true) :"
-.I Boolean
-.PP
-Legt fest, ob sich neu angelegte Benutzer per IMAP anmelden können sollen.
-.\" ------------------------------------
 .SS account.password_length
 .BR password_length " (Vorgabe: 8) :"
 .I Int
@@ -154,12 +148,6 @@
 Passwörter fest.
 Alle Werte kleiner als 8 werden auf 8 erhöht.
 .\" ------------------------------------
-.SS account.pop3
-.BR pop3 " (Vorgabe: true) :"
-.I Boolean
-.PP
-Legt fest, ob sich neu angelegte Benutzer per POP3 anmelden können sollen.
-.\" ------------------------------------
 .SS account.random_password
 .BR random_password " (Vorgabe: false) :"
 .I Boolean
@@ -177,25 +165,11 @@
 Sie können die Länge für automatisch generierte Passwörter mit der Option
 .I account.password_length
 konfigurieren.
-.\" ------------------------------------
-.SS account.sieve
-.BR sieve " (Vorgabe: true) :"
-.I Boolean
-.PP
-Legt fest, ob sich neu angelegte Benutzer per ManageSieve anmelden können
-sollen.
-.\" ------------------------------------
-.SS account.smtp
-.BR smtp " (Vorgabe: true) :"
-.I Boolean
-.PP
-Legt fest, ob sich neu angelegte Benutzer per SMTP (SMTP AUTH) anmelden
-können sollen.
 .\" -----------------------------------------------------------------------
 .SH SEKTION BIN
 In der
 .BR bin \-Sektion
-werden die Pfade zu den von 
+werden die Pfade zu den von
 .BR vmm (1)
 benötigten Binaries angegeben.
 .SS bin.dovecotpw
@@ -319,6 +293,32 @@
 In der
 .BR domain \-Sektion
 werden Domain\-spezifische Einstellungen hinterlegt.
+.PP
+Das Quota\-Limit (quota_bytes und quota_messages), Service\-Einstellungen
+(imap,  pop3, sieve und smtp) und der Transport werden angewendet, wenn
+eine Domain angelegt wird.
+Um die Einstellungen einer vorhandenen Domain zu ändern, verwenden Sie
+einen der folgenden
+.BR vmm (1)
+Unterbefehle:
+.PP
+.TP
+.B domainquota
+um das Quota\-Limit einer Domain zu ändern
+.TP
+.B domainservices
+um einer Domain einen abweichenden Satz von nutzbaren Services zuzuweisen
+.TP
+.B domaintransport
+um einen neuen Vorgabe\-Transport für eine Domain festzulegen
+.PP
+Wenn ein Account angelegt wird, erbt er alle Einstellungen von der Domain,
+zu der er hinzugefügt wird.
+Abweichende Einstellungen für einen vorhandenen Account nehmen Sie mit
+einem der Unterbefehle
+.BR userquota ", " userservices " und " usertransport
+vor.
+.\" ------------------------------------
 .SS domain.auto_postmaster
 .BR auto_postmaster " (Vorgabe: true) :"
 .I Boolean
@@ -353,6 +353,66 @@
 .PP
 Erzwingt das Löschen aller zugeordneten Konten und Aliase beim Löschen
 einer Domain (domaindelete).
+.\" ------------------------------------
+.SS domain.imap
+.BR imap " (Vorgabe: true) :"
+.I Boolean
+.PP
+Legt fest, ob sich neu angelegte Benutzer per IMAP anmelden können sollen.
+.\" ------------------------------------
+.SS domain.pop3
+.BR pop3 " (Vorgabe: true) :"
+.I Boolean
+.PP
+Legt fest, ob sich neu angelegte Benutzer per POP3 anmelden können sollen.
+.\" ------------------------------------
+.SS domain.quota_bytes
+.BR quota_bytes " (Vorgabe: 0) :"
+.I String
+.PP
+Quota Limit in Bytes.
+0 bedeutet unbegrenzt.
+Dieses Limit wird beim Anlegen von Domains angewendet.
+.PP
+Der Wert dieser Option kann als Integer\-Wert, zum Beispiel
+.B 20480
+geschrieben werden.
+Es ist auch möglich dem Wert eines der folgenden
+Suffixe anzuhängen:
+.BR b " (Bytes), " k " (Kilobytes), " M " (Megabytes) oder " G
+(Gigabytes).
+.br
+1024 entspricht 1024b oder 1k.
+.\" ------------------------------------
+.SS domain.quota_messages
+.BR quota_messages " (Vorgabe: 0) :"
+.I Int
+.PP
+Quota Limit als Anzahl von Nachrichten.
+0 bedeutet unbegrenzt.
+Dieses Limit wird beim Anlegen neuer Domains angewendet.
+.\" ------------------------------------
+.SS domain.sieve
+.BR sieve " (Vorgabe: true) :"
+.I Boolean
+.PP
+Legt fest, ob sich neu angelegte Benutzer per SIEVE (ManageSieve) anmelden
+können sollen.
+.\" ------------------------------------
+.SS domain.smtp
+.BR smtp " (Vorgabe: true) :"
+.I Boolean
+.PP
+Legt fest, ob sich neu angelegte Benutzer per SMTP (SMTP AUTH) anmelden
+können sollen.
+.\" ------------------------------------
+.SS domain.transport
+.BR transport " (Vorgabe: dovecot:) :"
+.I String
+.PP
+Der Standard\-Transport aller neuen Domains.
+Siehe auch:
+.BR transport (5).
 .\" -----------------------------------------------------------------------
 .SH SEKTION MAILBOX
 In der
@@ -511,40 +571,6 @@
 Unterstützte Encoding\-Suffixe:
 .BR .b64 ", " .base64 " und " .hex .
 Beispiel: PLAIN.BASE64
-.\" ------------------------------------
-.SS misc.quota_bytes
-.BR quota_bytes " (Vorgabe: 0) :"
-.I String
-.PP
-Quota Limit in Bytes.
-0 bedeutet unbegrenzt.
-Dieses Limit wird bei allen neu angelegten Domains angewendet.
-.PP
-Der Wert dieser Option kann als Integer\-Wert, zum Beispiel
-.B 20480
-geschrieben werden.
-Es ist auch möglich dem Wert eines der folgenden
-Suffixe anzuhängen:
-.BR b " (Bytes), " k " (Kilobytes), " M " (Megabytes) oder " G
-(Gigabytes).
-.br
-1024 entspricht 1024b oder 1k.
-.\" ------------------------------------
-.SS misc.quota_messages
-.BR quota_messages " (Vorgabe: 0) :"
-.I Int
-.PP
-Quota Limit als Anzahl von Nachrichten.
-0 bedeutet unbegrenzt.
-Dieses Limit wird bei allen neu angelegten Domains angewendet.
-.\" ------------------------------------
-.SS misc.transport
-.BR transport " (Vorgabe: dovecot:) :"
-.I String
-.PP
-Der Standard\-Transport aller Domains und Konten.
-Siehe auch:
-.BR transport (5).
 .\" -----------------------------------------------------------------------
 .SH BEISPIEL
 Eine Beispiel\-Konfiguration.
@@ -566,6 +592,11 @@
 sslmode = require
 user = vmm
 
+[domain]
+quota_bytes = 500M
+quota_messages = 10000
+transport = lmtp:unix:private/dovecot\-lmtp
+
 [mailbox]
 folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix
 
@@ -573,9 +604,6 @@
 crypt_sha512_rounds = 10000
 dovecot_version = 2.0.beta4
 password_scheme = SHA512\-CRYPT.hex
-quota_bytes = 500M
-quota_messages = 10000
-transport = lmtp:unix:private/dovecot\-lmtp
 .fi
 .\" -----------------------------------------------------------------------
 .SH SIEHE AUCH
--- a/man/man5/vmm.cfg.5	Sat Nov 05 21:54:31 2011 +0000
+++ b/man/man5/vmm.cfg.5	Sun Nov 06 04:47:43 2011 +0000
@@ -1,4 +1,4 @@
-.TH "VMM.CFG" "5" "2011-02-24" "vmm 0.6" "vmm"
+.TH "VMM.CFG" "5" "2011-11-06" "vmm 0.6" "vmm"
 .SH NAME
 vmm.cfg \- configuration file for vmm
 .\" -----------------------------------------------------------------------
@@ -135,12 +135,6 @@
 .BR du " or " full ,
 in order to display the current disk usage of an account's mail directory.
 .\" ------------------------------------
-.SS account.imap
-.BR imap " (default: true) :"
-.I Boolean
-.PP
-Determines whether a newly created user can log in via IMAP.
-.\" ------------------------------------
 .SS account.password_length
 .BR password_length " (default: 8) :"
 .I Int
@@ -149,12 +143,6 @@
 generated passwords.
 Any value less than 8 will be increased to 8.
 .\" ------------------------------------
-.SS account.pop3
-.BR pop3 " (default: true) :"
-.I Boolean
-.PP
-Determines whether a newly created user can log in via POP3.
-.\" ------------------------------------
 .SS account.random_password
 .BR random_password " (default: false) :"
 .I Boolean
@@ -171,18 +159,6 @@
 You can specify the password length of generated passwords with the
 .I account.password_length
 option.
-.\" ------------------------------------
-.SS account.sieve
-.BR sieve " (default: true) :"
-.I Boolean
-.PP
-Determines whether a newly created user can log in via ManageSieve.
-.\" ------------------------------------
-.SS account.smtp
-.BR smtp " (default: true) :"
-.I Boolean
-.PP
-Determines whether a newly created user can log in via SMTP (SMTP AUTH).
 .\" -----------------------------------------------------------------------
 .SH SECTION BIN
 The
@@ -309,6 +285,30 @@
 The
 .B domain
 section specifies some domain related settings.
+.PP
+The quota limit (quota_bytes and quota_messages), service settings (imap,
+pop3, sieve and smtp) and the transport setting will be applied when a
+domain is created.
+In order to modify those settings for an existing domain, use one of
+the following
+.BR vmm (1)
+subcommands:
+.PP
+.TP
+.B domainquota
+in order to update a domain's quota limit
+.TP
+.B domainservices
+in order to assign a different service set to a domain
+.TP
+.B domaintransport
+in order to set a new default domain transport
+.PP
+When an account is created, it inherits all the settings of the domain
+to which it is added.
+Different settings for an existing account can be set using the subcommands
+.BR userquota ", " userservices " and " usertransport .
+.\" ------------------------------------
 .SS domain.auto_postmaster
 .BR auto_postmaster " (default: true) :"
 .I Boolean
@@ -339,6 +339,62 @@
 .PP
 Force the deletion of accounts and aliases when a domain is deleted
 (domaindelete).
+.\" ------------------------------------
+.SS domain.imap
+.BR imap " (default: true) :"
+.I Boolean
+.PP
+Determines whether newly created users can log in via IMAP.
+.\" ------------------------------------
+.SS domain.pop3
+.BR pop3 " (default: true) :"
+.I Boolean
+.PP
+Determines whether newly created users can log in via POP3.
+.\" ------------------------------------
+.SS domain.quota_bytes
+.BR quota_bytes " (default: 0) :"
+.I String
+.PP
+Quota limit in bytes.
+0 means unlimited.
+This limit will be applied to all newly created domains.
+.PP
+The option's value can be written as an integer value, e.g.:
+.BR 20480 .
+It's also possible to append one of the following prefixes to the limit:
+.BR b " (bytes), " k " (kilobytes), " M " (megabytes) or " G
+(gigabytes).
+.br
+1024 is the same as 1024b or 1k.
+.\" ------------------------------------
+.SS domain.quota_messages
+.BR quota_messages " (default: 0) :"
+.I Int
+.PP
+Quota limit in number of messages.
+0 means unlimited.
+This limit will be applied to all newly created domains.
+.\" ------------------------------------
+.SS domain.sieve
+.BR sieve " (default: true) :"
+.I Boolean
+.PP
+Determines whether newly created users can log in via SIEVE (ManageSieve).
+.\" ------------------------------------
+.SS domain.smtp
+.BR smtp " (default: true) :"
+.I Boolean
+.PP
+Determines whether newly created users can log in via SMTP (SMTP AUTH).
+.\" ------------------------------------
+.SS domain.transport
+.BR transport " (default: dovecot:) :"
+.I String
+.PP
+Default transport for domains and accounts.
+For details see
+.BR transport (5).
 .\" -----------------------------------------------------------------------
 .SH SECTION MAILBOX
 The
@@ -480,39 +536,6 @@
 Supported encoding suffixes are:
 .BR .b64 ", " .base64 " and " .hex .
 For example: PLAIN.BASE64
-.\" ------------------------------------
-.SS misc.quota_bytes
-.BR quota_bytes " (default: 0) :"
-.I String
-.PP
-Quota limit in bytes.
-0 means unlimited.
-This limit will be applied to all newly created domains.
-.PP
-The option's value can be written as an integer value, e.g.:
-.BR 20480 .
-It's also possible to append one of the following prefixes to the limit:
-.BR b " (bytes), " k " (kilobytes), " M " (megabytes) or " G
-(gigabytes).
-.br
-1024 is the same as 1024b or 1k.
-.\" ------------------------------------
-.SS misc.quota_messages
-.BR quota_messages " (default: 0) :"
-.I Int
-.PP
-Quota limit in number of messages.
-0 means unlimited.
-This limit will be
-applied to all newly created domains.
-.\" ------------------------------------
-.SS misc.transport
-.BR transport " (default: dovecot:) :"
-.I String
-.PP
-Default transport for domains and accounts.
-For details see
-.BR transport (5).
 .\" -----------------------------------------------------------------------
 .SH EXAMPLE
 An example configuration.
@@ -534,6 +557,11 @@
 sslmode = require
 user = vmm
 
+[domain]
+quota_bytes = 500M
+quota_messages = 10000
+transport = lmtp:unix:private/dovecot\-lmtp
+
 [mailbox]
 folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix
 
@@ -541,9 +569,6 @@
 crypt_sha512_rounds = 10000
 dovecot_version = 2.0.beta4
 password_scheme = SHA512\-CRYPT.hex
-quota_bytes = 500M
-quota_messages = 10000
-transport = lmtp:unix:private/dovecot\-lmtp
 .fi
 .\" -----------------------------------------------------------------------
 .SH SEE ALSO