man/man5/vmm.cfg.5.rst
author Pascal Volk <neverseen@users.sourceforge.net>
Mon, 25 Jan 2010 03:09:47 +0000
branchv0.6.x
changeset 176 cc0d79842fdf
parent 170 d9ca5c46c1fa
child 177 ec2e1df8bb10
permissions -rw-r--r--
man: Added used default values to manual.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     1
=========
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     2
 vmm.cfg
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     3
=========
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     4
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     5
--------------------------
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     6
configuration file for vmm
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     7
--------------------------
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     8
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     9
:Author:         Pascal Volk <neverseen@users.sourceforge.net>
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
    10
:Date:           2010-01-25
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    11
:Version:        vmm-0.6.0
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    12
:Manual group:   vmm Manual
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    13
:Manual section: 5
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    14
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    15
.. contents::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    16
    :backlinks: top
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    17
    :class: htmlout
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    18
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    19
SYNOPSIS
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    20
========
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    21
vmm.cfg
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    22
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    23
DESCRIPTION
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    24
===========
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    25
**vmm**\(1) reads its configuration data from *vmm.cfg*.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    26
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    27
The configuration file is split into multiple sections. A section starts with
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    28
the section name, enclosed in square brackets '**[**' and '**]**', followed
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    29
by '*option* = *value*' pairs::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    30
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    31
    [database]
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    32
    host = 127.0.0.1
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    33
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    34
Whitespace around the '=' and at the end of a value is ignored.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    35
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    36
Empty lines and lines starting with '#' or ';' will be ignored.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    37
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    38
Each value uses one of the following data types:
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    39
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    40
* *Boolean* to indicate if something is enabled/activated (true) or
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    41
  disabled/deactivated (false).
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    42
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    43
  | Accepted values for *true* are: **1**, **yes**, **true** and **on**.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    44
  | Accepted values for *false* are: **0**, **no**, **false** and **off**.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    45
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    46
* *Int* an integer number, written without a fractional or decimal component.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    47
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    48
  | For example **1**, **50** or **321** are integers.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    49
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    50
* *String* a sequence of characters and numbers.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    51
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    52
  | For example '**word**', '**hello world**' or '**/usr/bin/strings**'
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    53
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    54
SEARCH ORDER
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    55
-------------
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    56
By default **vmm**\(1) looks for *vmm.cfg* in the following directories in the
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    57
order listed:
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    58
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    59
     | */root*
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    60
     | */usr/local/etc*
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    61
     | */etc*
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    62
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    63
The first configuration file found will be used.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    64
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    65
SECTIONS
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    66
========
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    67
This section describes all sections and their options of the *vmm.cfg*.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    68
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    69
ACCOUNT
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    70
-------
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    71
The options in the section **account** are used to specify user account
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    72
related settings.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    73
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
    74
``delete_directory (default: false)`` : *Boolean*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    75
    Determines the behavior of **vmm**\(1) when an account is deleted. If
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    76
    this option is set to *true* the user's home directory will be deleted
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    77
    recursively.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    78
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
    79
``directory_mode (default: 448)`` : *Int*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    80
    Access mode for a user's home directory and all directories inside.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    81
    The value has to be specified in decimal (base 10) notation.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    82
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    83
    | For example: 'drwx------' -> octal 0700 -> decimal 448
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    84
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
    85
``disk_usage (default: false)`` : *Boolean*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    86
    Determines whether the disk usage of a user's Maildir always should be
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    87
    summarized, using **du**\(1), and displayed with account information.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    88
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    89
    This could be slow on large Maildirs. When you have enabled quotas,
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    90
    **vmm**'s **userinfo** subcomammand will also display the current quota
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    91
    usage of the account. You may also use **userinfo**'s optional argument
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    92
    **du** or **full**, in order to display the current disk usage of an
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    93
    account.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    94
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
    95
``imap (default: true)`` : *Boolean*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    96
    Determines whether a newly created user can log in via IMAP.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    97
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
    98
``password_length (default: 8)`` : *Int*
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
    99
    Determines how many characters and/or numbers should be used for
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   100
    randomly generated passwords. Any value less than 8 will be
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   101
    increased to 8.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   102
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   103
``pop3 (default: true)`` : *Boolean*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   104
    Determines whether a newly created user can log in via POP3.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   105
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   106
``random_password (default: false)`` : *Boolean*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   107
    Determines whether **vmm** should generate a random password when no
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   108
    password was given for the **useradd** subcommand. If this option is
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   109
    set to *false* **vmm** will prompt you to enter a password for the new
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   110
    account.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   111
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   112
    You can specify the password length of generated passwords with the
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   113
    **password_length** option.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   114
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   115
``sieve (default: true)`` : *Boolean*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   116
    Determines whether a newly created user can log in via ManageSieve.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   117
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   118
``smtp (default: true)`` : *Boolean*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   119
     Determines whether a newly created user can log in via SMTP (SMTP AUTH).
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   120
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   121
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   122
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   123
    [account]
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   124
    delete_directory = false
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   125
    directory_mode = 448
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   126
    disk_usage = false
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   127
    random_password = true
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   128
    password_length = 10
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   129
    smtp = true
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   130
    pop3 = true
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   131
    imap = true
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   132
    sieve = true
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   133
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   134
BIN
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   135
---
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   136
The **bin** section is used to specify some paths to some binaries required
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   137
by **vmm**\(1).
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   138
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   139
``dovecotpw (default: /usr/sbin/dovecotpw)`` : *String*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   140
    The absolute path to the dovecotpw binary. This binary is used to
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   141
    generate a password hash, if **misc.password_scheme** is set to one of
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   142
    'SMD5', 'SSHA', 'CRAM-MD5', 'HMAC-MD5', 'LANMAN', 'NTLM' or 'RPA'.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   143
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   144
``du (default: /usr/bin/du)`` : *String*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   145
    The absolute path to **du**\(1). This binary is used to summarize the
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   146
    disk usage of a user's Maildir.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   147
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   148
``postconf (default: /usr/sbin/postconf)`` : *String*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   149
    The absolute path to Postfix' **postconf**\(1). This binary is required
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   150
    when **vmm**\(1) has to check for some Postfix settings, e.g.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   151
    `virtual_alias_expansion_limit`.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   152
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   153
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   154
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   155
    [bin]
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   156
    dovecotpw = /usr/sbin/dovecotpw
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   157
    du = /usr/bin/du
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   158
    postconf = /usr/sbin/postconf
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   159
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   160
CONFIG
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   161
------
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   162
The **config** section is an internal used control section.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   163
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   164
``done (default: false)`` : *Boolean*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   165
    This option is set to *false* when **vmm**\(1) is installed for the first
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   166
    time. When you edit *vmm.cfg*, set this option to *true*. This option is
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   167
    also set to *true* when you configure **vmm**\(1) with the command **vmm
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   168
    configure**.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   170
    If this option is set to *false*, **vmm**\(1) will start in the
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   171
    interactive configurations mode.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   172
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   173
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   174
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   175
    [config]
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   176
    done = true
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   177
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   178
DATABASE
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   179
--------
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   180
The **database** section is used to specify some options required to
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   181
connect to the database.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   182
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   183
``host (default: localhost)`` : *String*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   184
    Hostname or IP address of the database server.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   185
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   186
``name (default: mailsys)`` : *String*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   187
    Name of the database.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   188
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   189
``pass (default: None)`` : *String*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   190
    Database password.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   191
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   192
``user (default: None)`` : *String*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   193
    Name of the database user.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   194
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   195
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   196
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   197
    [database]
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   198
    host = localhost
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   199
    user = vmm
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   200
    pass = PY_SRJ}L/0p-oOk
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   201
    name = mailsys
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   202
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   203
DOMAIN
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   204
------
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   205
The **domain** section specifies some domain related settings.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   206
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   207
``auto_postmaster (default: true)`` : *Boolean*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   208
    Determines if **vmm**\(1) should create also a postmaster account when a
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   209
    new domain is created.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   210
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   211
``delete_directory (default: false)`` : *Boolean*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   212
    Specifies whether the domain directory and all user directories inside
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   213
    should be deleted when a domain is deleted.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   214
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   215
``directory_mode (default: 504)`` : *Int*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   216
    Access mode for the domain directory in decimal (base 10) notation.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   217
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   218
    | For example: 'drwxrwx---' -> octal 0770 -> decimal 504
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   219
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   220
``force_deletion (default: false)`` : *Boolean*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   221
    Force deletion of accounts and aliases when a domain is deleted.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   222
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   223
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   224
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   225
    [domain]
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   226
    auto_postmaster = true
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   227
    delete_directory = false
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   228
    directory_mode = 504
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   229
    force_deletion = false
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   230
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   231
MAILDIR
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   232
-------
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   233
The **maildir** section is used to specify some default options for new
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   234
created Maildirs and folders inside.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   235
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   236
``folders (default: Drafts:Sent:Templates:Trash)`` : *String*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   237
    A colon separated list of folder names, that should be created. If no
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   238
    folders should be created inside the Maildir, set the value of this
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   239
    option to a single colon ('**:**').
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   240
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   241
    If you want to create folders containing one or more subfolders, separate
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   242
    them with a single dot ('**.**').
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   243
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   244
``name (default: Maildir)`` : *String*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   245
    Default name of the Maildir folder in users home directories.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   246
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   247
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   248
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   249
    [maildir]
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   250
    folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   251
    name = Maildir
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   252
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   253
MISC
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   254
----
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   255
The **misc** section is used to define miscellaneous settings.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   256
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   257
``base_directory (default: /srv/mail)`` : *String*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   258
    All domain directories will be created inside this directory.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   259
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   260
``password_scheme (default: CRAM-MD5)`` : *String*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   261
    Password scheme to use (see also: **dovecotpw -l**).
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   262
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   263
``gid_mail (default: 8)`` : *Int*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   264
    Numeric group ID of group mail (`mail_privileged_group` from
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   265
    *dovecot.conf*)
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   266
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   267
``transport (default: dovecot:)`` : *String*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   268
    Default transport for domains and accounts. For details see
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   269
    **transport**\(5).
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   270
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   271
``dovecot_version (default: 12)`` : *Int*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   272
    The concatenated major and minor version number of the currently used
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   273
    Dovecot version. (see: **dovecot --version**).
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   274
170
d9ca5c46c1fa man: reworded some parts.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 169
diff changeset
   275
    When, for example, the command **dovecot --version** prints *1.1.18*, set
d9ca5c46c1fa man: reworded some parts.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 169
diff changeset
   276
    the value of this option to **11**.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   277
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   278
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   279
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   280
    [misc]
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   281
    base_directory = /srv/mail
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   282
    password_scheme = CRAM-MD5
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   283
    gid_mail = 8
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   284
    transport = dovecot:
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   285
    dovecot_version = 11
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   286
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   287
FILES
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   288
=====
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   289
*/root/vmm.cfg*
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   290
    | will be used when found.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   291
*/usr/local/etc/vmm.cfg*
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   292
    | will be used when the above file doesn't exist.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   293
*/etc/vmm.cfg*
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   294
    | will be used when none of the both above mentioned files exists.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   295
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   296
SEE ALSO
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   297
========
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   298
vmm(1), command line tool to manage email domains/accounts/aliases
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   299
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   300
COPYING
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   301
=======
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   302
vmm and its manual pages were written by Pascal Volk and are licensed under
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   303
the terms of the BSD License.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   304