# HG changeset patch # User Pascal Volk # Date 1264388987 0 # Node ID cc0d79842fdf74f670902ba0fecb1197f5ac15b2 # Parent b241272eb1bd823375c682266a8d0fbe9c577354 man: Added used default values to manual. diff -r b241272eb1bd -r cc0d79842fdf man/de/man5/vmm.cfg.5.rst --- a/man/de/man5/vmm.cfg.5.rst Sun Jan 24 09:06:05 2010 +0000 +++ b/man/de/man5/vmm.cfg.5.rst Mon Jan 25 03:09:47 2010 +0000 @@ -7,7 +7,7 @@ --------------------------- :Author: Pascal Volk -:Date: 2010-01-18 +:Date: 2010-01-25 :Version: vmm-0.6.0 :Manual group: vmm Manual :Manual section: 5 @@ -76,18 +76,18 @@ Die Optionen des Abschnitts **account** legen Konto-spezifische Einstellungen fest. -``delete_directory`` : *Boolean* +``delete_directory (Vorgabe: false)`` : *Boolean* Bestimmt das Verhalten von **vmm**\(1) beim Löschen eines Kontos. Wenn der Wert dieser Option *true* ist, wird das Home-Verzeichnis des zu löschenden Anwenders rekursiv gelöscht. -``directory_mode`` : *Int* +``directory_mode (Vorgabe: 448)`` : *Int* Zugriffsbits des Home-Verzeichnisses, sowie aller enthaltenen Verzeichnisse, in Dezimal-Schreibweise (Basis 10). | Beispiel: 'drwx------' -> oktal 0700 -> dezimal 448 -``disk_usage`` : *Boolean* +``disk_usage (Vorgabe: false)`` : *Boolean* Legt fest, ob die Festplattenbelegung des Maildirs eines Benutzers jedes Mal mit **du**\(1) ermittelt und mit den Konto-Informationen ausgegeben werden soll. @@ -98,17 +98,17 @@ eines der optionalen Argumente **du** oder **full** an **userinfo** übergeben, um sich die aktuelle Festplattenbelegung anzeigen zu lassen. -``imap`` : *Boolean* +``imap (Vorgabe: true)`` : *Boolean* Bestimmt, ob sich neu angelegte Benutzer per IMAP anmelden können sollen. -``password_length`` : *Int* +``password_length (Vorgabe: 8)`` : *Int* Diese Option legt die Anzahl der Zeichen für automatisch erzeugte Passwörter fest. Alle Werte kleiner als 8 werden auf 8 erhöht. -``pop3`` +``pop3 (Vorgabe: true)`` : *Boolean* Bestimmt, ob sich neu angelegte Benutzer per POP3 anmelden können sollen. -``random_password`` : *Boolean* +``random_password (Vorgabe: false)`` : *Boolean* Mit dieser Option wird bestimmt , ob **vmm**\(1) ein zufälliges Passwort generieren soll, wenn kein Passwort an den **useradd** Unterbefehl übergeben wurde. Ist der Wert dieser Option *false*, wird **vmm** Sie @@ -117,11 +117,11 @@ Sie können die Länge für automatisch generierte Passwörter mit der Option **password_length** konfigurieren. -``sieve`` : *Boolean* +``sieve (Vorgabe: true)`` : *Boolean* Bestimmt, ob sich neu angelegte Benutzer per ManageSieve anmelden können sollen. -``smtp`` : *Boolean* +``smtp (Vorgabe: true)`` : *Boolean* Bestimmt, ob sich neu angelegte Benutzer per SMTP (SMTP AUTH) anmelden können sollen. @@ -143,17 +143,17 @@ Im **bin**-Abschnitt werden Pfade zu Binaries angegeben, die von **vmm**\(1) benötigt werden. -``dovecotpw`` : *String* +``dovecotpw (Vorgabe: /usr/sbin/dovecotpw)`` : *String* Der absolute Pfad zum dovecotpw Binary. Dieses Binary wird zur Hash-Erzeugung verwendet, wenn **misc.password_scheme** einen der nachfolgenden Werte hat: 'SMD5', 'SSHA', 'CRAM-MD5', 'HMAC-MD5', 'LANMAN', 'NTLM' oder 'RPA'. -``du`` : *String* +``du (Vorgabe: /usr/bin/du)`` : *String* Der absolute Pfad zu **du**\(1). Dieses Binary wird verwendet, wenn die Festplattenbelegung eines Kontos ermittelt wird. -``postconf`` : *String* +``postconf (Vorgabe: /usr/sbin/postconf)`` : *String* Der absolute Pfad zu Postfix' **postconf**\(1). Dieses Binary wird verwendet, wenn **vmm**\(1) diverse Postfix-Einstellungen prüft, zum Beispiel das `virtual_alias_expansion_limit`. @@ -170,7 +170,7 @@ Beim **config**-Abschnitt handelt es sich um einen internen Steuerungs-Abschnitt. -``done`` : *Boolean* +``done (Vorgabe: false)`` : *Boolean* Diese Option hat den Wert *false*, wenn **vmm**\(1) zum ersten Mal installiert wurde. Wenn Sie die Datei *vmm.cfg* von Hand editieren, weisen Sie dieser Option abschließend den Wert *true* zu. Wird die @@ -190,16 +190,16 @@ Der **database**-Abschnitt wird verwendet, um die für den Datenbankzugriff benötigten Optionen festzulegen. -``host`` : *String* +``host (Vorgabe: localhost)`` : *String* Der Hostname oder die IP-Adresse des Datenbank-Servers. -``name`` : *String* +``name (Vorgabe: mailsys)`` : *String* Der Name der zu verwendenden Datenbank. -``pass`` : *String* +``pass (Vorgabe: Nichts)`` : *String* Das Passwort des Datenbank-Benutzers. -``user`` : *String* +``user (Vorgabe: Nichts)`` : *String* Der Name des Datenbank-Benutzers. Beispiel:: @@ -214,21 +214,21 @@ ------ Im **domain**-Abschnitt werden Domain-spezifische Informationen konfiguriert. -``auto_postmaster`` : *Boolean* +``auto_postmaster (Vorgabe: true)`` : *Boolean* Ist der Wert dieser Option *true*, wird **vmm**\(1) beim Anlegen einer Domain automatisch einen postmaster-Account erstellen. -``delete_directory`` : *Boolean* +``delete_directory (Vorgabe: false)`` : *Boolean* Bestimmt, ob beim Löschen einer Domain das Verzeichnis einer Domain, inklusive aller Anwender-Verzeichnisse, rekursiv gelöscht werden soll. -``directory_mode`` : *Int* +``directory_mode (Vorgabe: 504)`` : *Int* Zugriffsbits des Domain-Verzeichnisses in Dezimal-Schreibweise (Basis 10). | Beispiel: 'drwxrwx---' -> oktal 0770 -> dezimal 504 -``force_deletion`` : *Boolean* +``force_deletion (Vorgabe: false)`` : *Boolean* Erzwingt das Löschen aller zugeordneten Konten und Aliase beim Löschen einer Domain. @@ -245,7 +245,7 @@ Im **maildir**-Abschnitt werden die für die Maildirs erforderlichen Optionen festgelegt. -``folders`` : *String* +``folders (Vorgabe: Drafts:Sent:Templates:Trash)`` : *String* Eine durch Doppelpunkten getrennte Liste mit Verzeichnisnamen, die innerhalb des Maildirs erstellt werden sollen. Sollen innerhalb des Maildirs keine Verzeichnisse angelegt werden, ist dieser Optionen ein @@ -254,7 +254,7 @@ Sollen Verzeichnisse mit Unterverzeichnissen angelegt werden, ist ein einzelner Punkt ('**.**') als Separator zu verwenden. -``name`` : *String* +``name (Vorgabe: Maildir)`` : *String* Der Standard-Name des Maildir-Verzeichnisses im Verzeichnis des jeweiligen Anwenders. @@ -268,22 +268,22 @@ ---- Im **misc**-Abschnitt werden verschiedene Einstellungen festgelegt. -``base_directory`` : *String* +``base_directory (Vorgabe: /srv/mail)`` : *String* Alle Domain-Verzeichnisse werden innerhalb dieses Basis-Verzeichnisses angelegt. -``password_scheme`` : *String* +``password_scheme (Vorgabe: CRAM-MD5)`` : *String* Das zu verwendende Passwort-Schema (siehe auch: **dovecotpw -l**). -``gid_mail`` : *Int* +``gid_mail (Vorgabe: 8)`` : *Int* Die numerische Gruppen-ID der Gruppe mail, bzw. der Gruppe aus `mail_privileged_group` der Datei *dovecot.conf*. -``transport`` : *String* +``transport (Vorgabe: dovecot:)`` : *String* Der Standard-Transport aller Domains und Konten. Siehe auch: **transport**\(5) -``dovecot_version`` : *Int* +``dovecot_version (Vorgabe: 12)`` : *Int* Die verketteten Major- und Minor-Teile der eingesetzten Dovecot-Version (siehe: **dovecot --version**). diff -r b241272eb1bd -r cc0d79842fdf man/man5/vmm.cfg.5.rst --- a/man/man5/vmm.cfg.5.rst Sun Jan 24 09:06:05 2010 +0000 +++ b/man/man5/vmm.cfg.5.rst Mon Jan 25 03:09:47 2010 +0000 @@ -7,7 +7,7 @@ -------------------------- :Author: Pascal Volk -:Date: 2010-01-18 +:Date: 2010-01-25 :Version: vmm-0.6.0 :Manual group: vmm Manual :Manual section: 5 @@ -71,18 +71,18 @@ The options in the section **account** are used to specify user account related settings. -``delete_directory`` : *Boolean* +``delete_directory (default: false)`` : *Boolean* Determines the behavior of **vmm**\(1) when an account is deleted. If this option is set to *true* the user's home directory will be deleted recursively. -``directory_mode`` : *Int* +``directory_mode (default: 448)`` : *Int* Access mode for a user's home directory and all directories inside. The value has to be specified in decimal (base 10) notation. | For example: 'drwx------' -> octal 0700 -> decimal 448 -``disk_usage`` : *Boolean* +``disk_usage (default: false)`` : *Boolean* Determines whether the disk usage of a user's Maildir always should be summarized, using **du**\(1), and displayed with account information. @@ -92,17 +92,18 @@ **du** or **full**, in order to display the current disk usage of an account. -``imap`` : *Boolean* +``imap (default: true)`` : *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. +``password_length (default: 8)`` : *Int* + Determines how many characters and/or numbers should be used for + randomly generated passwords. Any value less than 8 will be + increased to 8. -``pop3`` : *Boolean* +``pop3 (default: true)`` : *Boolean* Determines whether a newly created user can log in via POP3. -``random_password`` : *Boolean* +``random_password (default: false)`` : *Boolean* Determines whether **vmm** should generate a random password when no password was given for the **useradd** subcommand. If this option is set to *false* **vmm** will prompt you to enter a password for the new @@ -111,10 +112,10 @@ You can specify the password length of generated passwords with the **password_length** option. -``sieve`` : *Boolean* +``sieve (default: true)`` : *Boolean* Determines whether a newly created user can log in via ManageSieve. -``smtp`` : *Boolean* +``smtp (default: true)`` : *Boolean* Determines whether a newly created user can log in via SMTP (SMTP AUTH). Example:: @@ -135,16 +136,16 @@ The **bin** section is used to specify some paths to some binaries required by **vmm**\(1). -``dovecotpw`` : *String* +``dovecotpw (default: /usr/sbin/dovecotpw)`` : *String* The absolute path to the dovecotpw binary. This binary is used to generate a password hash, if **misc.password_scheme** is set to one of 'SMD5', 'SSHA', 'CRAM-MD5', 'HMAC-MD5', 'LANMAN', 'NTLM' or 'RPA'. -``du`` : *String* +``du (default: /usr/bin/du)`` : *String* The absolute path to **du**\(1). This binary is used to summarize the disk usage of a user's Maildir. -``postconf`` : *String* +``postconf (default: /usr/sbin/postconf)`` : *String* The absolute path to Postfix' **postconf**\(1). This binary is required when **vmm**\(1) has to check for some Postfix settings, e.g. `virtual_alias_expansion_limit`. @@ -160,7 +161,7 @@ ------ The **config** section is an internal used control section. -``done`` : *Boolean* +``done (default: false)`` : *Boolean* This option is set to *false* when **vmm**\(1) is installed for the first time. When you edit *vmm.cfg*, set this option to *true*. This option is also set to *true* when you configure **vmm**\(1) with the command **vmm @@ -179,16 +180,16 @@ The **database** section is used to specify some options required to connect to the database. -``host`` : *String* +``host (default: localhost)`` : *String* Hostname or IP address of the database server. -``name`` : *String* +``name (default: mailsys)`` : *String* Name of the database. -``pass`` : *String* +``pass (default: None)`` : *String* Database password. -``user`` : *String* +``user (default: None)`` : *String* Name of the database user. Example:: @@ -203,20 +204,20 @@ ------ The **domain** section specifies some domain related settings. -``auto_postmaster`` : *Boolean* +``auto_postmaster (default: true)`` : *Boolean* Determines if **vmm**\(1) should create also a postmaster account when a new domain is created. -``delete_directory`` : *Boolean* +``delete_directory (default: false)`` : *Boolean* Specifies whether the domain directory and all user directories inside should be deleted when a domain is deleted. -``directory_mode`` : *Int* +``directory_mode (default: 504)`` : *Int* Access mode for the domain directory in decimal (base 10) notation. | For example: 'drwxrwx---' -> octal 0770 -> decimal 504 -``force_deletion`` : *Boolean* +``force_deletion (default: false)`` : *Boolean* Force deletion of accounts and aliases when a domain is deleted. Example:: @@ -232,7 +233,7 @@ The **maildir** section is used to specify some default options for new created Maildirs and folders inside. -``folders`` : *String* +``folders (default: Drafts:Sent:Templates:Trash)`` : *String* A colon separated list of folder names, that should be created. If no folders should be created inside the Maildir, set the value of this option to a single colon ('**:**'). @@ -240,7 +241,7 @@ If you want to create folders containing one or more subfolders, separate them with a single dot ('**.**'). -``name`` : *String* +``name (default: Maildir)`` : *String* Default name of the Maildir folder in users home directories. Example:: @@ -253,21 +254,21 @@ ---- The **misc** section is used to define miscellaneous settings. -``base_directory`` : *String* +``base_directory (default: /srv/mail)`` : *String* All domain directories will be created inside this directory. -``password_scheme`` : *String* +``password_scheme (default: CRAM-MD5)`` : *String* Password scheme to use (see also: **dovecotpw -l**). -``gid_mail`` : *Int* +``gid_mail (default: 8)`` : *Int* Numeric group ID of group mail (`mail_privileged_group` from *dovecot.conf*) -``transport`` : *String* +``transport (default: dovecot:)`` : *String* Default transport for domains and accounts. For details see **transport**\(5). -``dovecot_version`` : *Int* +``dovecot_version (default: 12)`` : *Int* The concatenated major and minor version number of the currently used Dovecot version. (see: **dovecot --version**). diff -r b241272eb1bd -r cc0d79842fdf vmm.cfg --- a/vmm.cfg Sun Jan 24 09:06:05 2010 +0000 +++ b/vmm.cfg Mon Jan 25 03:09:47 2010 +0000 @@ -7,7 +7,7 @@ # [database] ; Hostname or IP address of the database server (String) -host = 127.0.0.1 +host = localhost ; Database user name (String) user = dbuser ; Database password (String) @@ -83,14 +83,14 @@ ; The base directory for all domains/accounts (String) base_directory = /srv/mail ; Password scheme to use (see also: dovecotpw -l) (String) -password_scheme = PLAIN +password_scheme = CRAM-MD5 ; numeric group ID of group mail (mail_privileged_group from dovecot.conf) (Int) gid_mail = 8 ; default transport for domains and accounts (String) transport = dovecot: ; the concatenated major and minor version number from `dovecot --version` (Int) ; e.g. 1.0.15 -> 10; 1.1.18 -> 11; 1.2.3 -> 12 -dovecot_version = 11 +dovecot_version = 12 # # Configuration state