man/man5/vmm.cfg.5.rst
author Pascal Volk <neverseen@users.sourceforge.net>
Fri, 12 Feb 2010 04:15:18 +0000
branchv0.6.x
changeset 201 dbb0f7ed7858
parent 180 f8279c90e99c
child 230 eefbe052a135
permissions -rw-r--r--
VMM/Config: LazyConfigOption.__init__() cast 'default' to 'cls'. If the default value is not None, make sure it has the proper type.
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>
180
f8279c90e99c VMM/Config: dropped option config.done
Pascal Volk <neverseen@users.sourceforge.net>
parents: 179
diff changeset
    10
:Date:           2010-02-01
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::
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    16
  :backlinks: top
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    17
  :class: htmlout
169
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
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    23
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    24
DESCRIPTION
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    25
===========
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    26
|vmm(1)|_ reads its configuration data from *vmm.cfg*.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    27
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    28
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
    29
the section name, enclosed in square brackets '**[**' and '**]**', followed
177
ec2e1df8bb10 man/{,de/}man5: added a note about how to use default settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 176
diff changeset
    30
by '*option* = *value*' pairs.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    31
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    32
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
    33
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    34
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
    35
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    36
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
    37
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    38
* *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
    39
  disabled/deactivated (false).
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    40
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    41
  | 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
    42
  | 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
    43
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    44
* *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
    45
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    46
  | 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
    47
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    48
* *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
    49
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    50
  | 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
    51
177
ec2e1df8bb10 man/{,de/}man5: added a note about how to use default settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 176
diff changeset
    52
Most options have a default value, shown in parentheses after the option's
ec2e1df8bb10 man/{,de/}man5: added a note about how to use default settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 176
diff changeset
    53
name. In order to use a option's default setting, comment out the line,
ec2e1df8bb10 man/{,de/}man5: added a note about how to use default settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 176
diff changeset
    54
either with a **#** or **;** or simply remove the setting from *vmm.cfg*.
ec2e1df8bb10 man/{,de/}man5: added a note about how to use default settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 176
diff changeset
    55
ec2e1df8bb10 man/{,de/}man5: added a note about how to use default settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 176
diff changeset
    56
A minimal *vmm.cfg* would be::
ec2e1df8bb10 man/{,de/}man5: added a note about how to use default settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 176
diff changeset
    57
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    58
  [database]
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    59
  user = me
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    60
  pass = xxxxxxxx
177
ec2e1df8bb10 man/{,de/}man5: added a note about how to use default settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 176
diff changeset
    61
ec2e1df8bb10 man/{,de/}man5: added a note about how to use default settings.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 176
diff changeset
    62
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    63
SEARCH ORDER
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    64
-------------
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    65
By default |vmm(1)|_ looks for *vmm.cfg* in the following directories in the
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    66
order listed:
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    67
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    68
  | */root*
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    69
  | */usr/local/etc*
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    70
  | */etc*
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    71
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    72
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
    73
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    74
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    75
SECTIONS
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    76
========
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    77
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
    78
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    79
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    80
ACCOUNT
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    81
-------
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    82
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
    83
related settings.
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    84
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    85
.. _account.delete_directory:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    86
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
    87
``delete_directory (default: false)`` : *Boolean*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    88
  Determines the behavior of |vmm(1)|_ when an account is deleted
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    89
  (|userdelete|_). If this option is set to *true* the user's home directory
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    90
  will be deleted  recursively.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    91
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    92
.. _account.directory_mode:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    93
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
    94
``directory_mode (default: 448)`` : *Int*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    95
  Access mode for a user's home directory and all directories inside. The
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    96
  value has to be specified in decimal (base 10) notation.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    97
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    98
  | For example: 'drwx------' -> octal 0700 -> decimal 448
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
    99
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   100
.. _account.disk_usage:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   101
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   102
``disk_usage (default: false)`` : *Boolean*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   103
  Determines whether the disk usage of a user's Maildir always should be
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   104
  summarized, using **du**\(1), and displayed with account information.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   105
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   106
  This could be slow on large Maildirs. When you have enabled quotas,
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   107
  **vmm**'s |userinfo|_ subcomammand will also display the current quota
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   108
  usage of the account. You may also use |userinfo|_'s optional argument
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   109
  **du** or **full**, in order to display the current disk usage of an
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   110
  account's Maildir.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   111
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   112
.. _account.imap:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   113
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   114
``imap (default: true)`` : *Boolean*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   115
  Determines whether a newly created user can log in via IMAP.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   116
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   117
.. _account.password_length:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   118
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   119
``password_length (default: 8)`` : *Int*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   120
  Determines how many characters and/or numbers should be used for randomly
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   121
  generated passwords. Any value less than 8 will be increased to 8.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   122
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   123
.. _account.pop3:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   124
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   125
``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
   126
    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
   127
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   128
.. _account.random_password:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   129
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   130
``random_password (default: false)`` : *Boolean*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   131
  Determines whether **vmm** should generate a random password when no
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   132
  password was given for the |useradd|_ subcommand. If this option is set to
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   133
  *false* **vmm** will prompt you to enter a password for the new account.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   134
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   135
  You can specify the password length of generated passwords with the
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   136
  |account.password_length|_ option.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   137
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   138
.. _account.sieve:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   139
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   140
``sieve (default: true)`` : *Boolean*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   141
  Determines whether a newly created user can log in via ManageSieve.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   142
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   143
.. _account.smtp:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   144
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   145
``smtp (default: true)`` : *Boolean*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   146
  Determines whether a newly created user can log in via SMTP (SMTP AUTH).
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   147
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   148
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   149
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   150
  [account]
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   151
  delete_directory = false
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   152
  directory_mode = 448
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   153
  disk_usage = false
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   154
  random_password = true
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   155
  password_length = 10
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   156
  smtp = true
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   157
  pop3 = true
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   158
  imap = true
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   159
  sieve = true
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   160
169
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
BIN
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   163
---
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   164
The **bin** section is used to specify some paths to some binaries required
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   165
by |vmm(1)|_.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   166
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   167
.. _bin.dovecotpw:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   168
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   169
``dovecotpw (default: /usr/sbin/dovecotpw)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   170
  The absolute path to the dovecotpw binary. This binary is used to
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   171
  generate a password hash, if |misc.password_scheme|_ is set to one of
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   172
  'SMD5', 'SSHA', 'CRAM-MD5', 'HMAC-MD5', 'LANMAN', 'NTLM' or 'RPA'.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   173
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   174
.. _bin.du:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   175
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   176
``du (default: /usr/bin/du)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   177
  The absolute path to **du**\(1). This binary is used to summarize the disk
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   178
  usage of a user's Maildir.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   180
.. _bin.postconf:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   181
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   182
``postconf (default: /usr/sbin/postconf)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   183
  The absolute path to Postfix' |postconf(1)|_. This binary is required when
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   184
  |vmm(1)|_ has to check for some Postfix settings, e.g.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   185
  |virtual_alias_expansion_limit|_.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   186
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   187
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   188
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   189
  [bin]
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   190
  dovecotpw = /usr/sbin/dovecotpw
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   191
  du = /usr/bin/du
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   192
  postconf = /usr/sbin/postconf
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   193
169
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
DATABASE
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
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
   198
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
   199
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   200
.. _database.host:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   201
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   202
``host (default: localhost)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   203
  Hostname or IP address of the database server.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   204
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   205
.. _database.name:
169
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
``name (default: mailsys)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   208
  Name of the database.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   209
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   210
.. _database.pass:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   211
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   212
``pass (default: None)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   213
  Database password.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   214
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   215
.. _database.user:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   216
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   217
``user (default: None)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   218
  Name of the database user.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   219
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   220
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   221
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   222
  [database]
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   223
  host = localhost
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   224
  user = vmm
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   225
  pass = PY_SRJ}L/0p-oOk
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   226
  name = mailsys
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   227
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   228
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   229
DOMAIN
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
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
   232
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   233
.. _domain.auto_postmaster:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   234
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   235
``auto_postmaster (default: true)`` : *Boolean*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   236
  Determines if |vmm(1)|_ should create also a postmaster account when a new
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   237
  domain is created (|domainadd|_).
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   238
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   239
.. _domain.delete_directory:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   240
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   241
``delete_directory (default: false)`` : *Boolean*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   242
  Specifies whether the domain directory and all user directories inside
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   243
  should be deleted when a domain is deleted (|domaindelete|_).
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   244
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   245
.. _domain.directory_mode:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   246
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   247
``directory_mode (default: 504)`` : *Int*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   248
  Access mode for the domain directory in decimal (base 10) notation.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   249
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   250
  | For example: 'drwxrwx---' -> octal 0770 -> decimal 504
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   251
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   252
.. _domain.force_deletion:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   253
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   254
``force_deletion (default: false)`` : *Boolean*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   255
  Force deletion of accounts and aliases when a domain is deleted
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   256
  (|domaindelete|_).
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   257
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   258
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   259
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   260
  [domain]
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   261
  auto_postmaster = true
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   262
  delete_directory = false
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   263
  directory_mode = 504
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   264
  force_deletion = false
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   265
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   266
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   267
MAILDIR
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   268
-------
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   269
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
   270
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
   271
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   272
.. _maildir.folders:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   273
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   274
``folders (default: Drafts:Sent:Templates:Trash)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   275
  A colon separated list of folder names, that should be created. If no
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   276
  folders should be created inside the Maildir, set the value of this option
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   277
  to a single colon ('**:**').
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   278
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   279
  If you want to create folders containing one or more subfolders, separate
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   280
  them with a single dot ('**.**').
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   281
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   282
.. _maildir.name:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   283
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   284
``name (default: Maildir)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   285
  Default name of the Maildir folder in users home directories.
169
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
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   288
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   289
  [maildir]
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   290
  folders = Drafts:Sent:Templates:Trash:Lists.Dovecot:Lists.Postfix
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   291
  name = Maildir
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   292
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   293
.. _imap_uft7:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   294
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   295
.. note:: If you want to use internationalized mailbox names in the
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   296
  **folders** setting, you have to specify them in a modified version of the
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   297
  UTF-7 encoding (see :RFC:`3501`, section 5.1.3).
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   298
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   299
  Dovecot provides a useful utility for mUTF-7 <-> UTF-8 conversion:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   300
  **imap-utf7**, it's available since Dovecot version 1.2.0.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   301
..
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   302
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   303
imap-utf7 example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   304
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   305
  user@host:~$ /usr/local/libexec/dovecot/imap-utf7 -r Wysłane
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   306
  Wys&AUI-ane
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   307
  user@host:~$ /usr/local/libexec/dovecot/imap-utf7 "&AVo-mietnik"
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   308
  Śmietnik
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   309
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   310
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   311
MISC
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   312
----
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   313
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
   314
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   315
.. _misc.base_directory:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   316
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   317
``base_directory (default: /srv/mail)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   318
  All domain directories will be created inside this directory.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   319
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   320
.. _misc.password_scheme:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   321
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   322
``password_scheme (default: CRAM-MD5)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   323
  Password scheme to use (see also: **dovecotpw -l**).
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   324
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   325
.. _misc.gid_mail:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   326
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   327
``gid_mail (default: 8)`` : *Int*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   328
  Numeric group ID of group mail (`mail_privileged_group` from
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   329
  *dovecot.conf*)
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   330
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   331
.. _misc.transport:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   332
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   333
``transport (default: dovecot:)`` : *String*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   334
  Default transport for domains and accounts. For details see
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   335
  |transport(5)|_.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   336
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   337
.. _misc.dovecot_version:
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   338
176
cc0d79842fdf man: Added used default values to manual.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 170
diff changeset
   339
``dovecot_version (default: 12)`` : *Int*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   340
  The concatenated major and minor version number of the currently used
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   341
  Dovecot version. (see: **dovecot --version**).
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   342
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   343
  When, for example, the command **dovecot --version** prints *1.1.18*, set
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   344
  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
   345
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   346
Example::
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   347
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   348
  [misc]
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   349
  base_directory = /srv/mail
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   350
  password_scheme = PLAIN
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   351
  gid_mail = 8
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   352
  transport = dovecot:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   353
  dovecot_version = 11
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   354
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   355
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   356
FILES
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   357
=====
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   358
*/root/vmm.cfg*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   359
  | will be used when found.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   360
*/usr/local/etc/vmm.cfg*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   361
  | will be used when the above file doesn't exist.
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   362
*/etc/vmm.cfg*
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   363
  | will be used when none of the both above mentioned files exists.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   364
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   365
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   366
SEE ALSO
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   367
========
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   368
|vmm(1)|_
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   369
169
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   370
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   371
COPYING
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   372
=======
a72908248153 man: updated man/{de/,}man5/vmm.cfg.5, using reStructuredText now
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   373
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
   374
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
   375
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   376
.. include:: ../substitute_links.rst
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents: 177
diff changeset
   377
.. include:: ../substitute_links_5.rst