man/man5/vmm.cfg.5
author Pascal Volk <neverseen@users.sourceforge.net>
Sun, 24 Aug 2008 22:26:00 +0000
changeset 64 432a037658a8
parent 37 89f952b0f366
child 68 7ae95b9938c4
permissions -rw-r--r--
* 'vmm' - cleanups in the usage() output * 'man/de/man1/vmm.1' * 'man/man1/vmm.1' - updated
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     1
.\" $Id$
37
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
     2
.TH vmm.cfg 5 "11. Jun 2008" "Pascal Volk"
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     3
.SH NAME
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     4
vmm.cfg \- configuration file for vmm
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     5
.SH SYNOPSIS
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     6
/usr/local/etc/vmm.cfg
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     7
.SH DESCRIPTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
     8
\fBvmm\fR(1) reads configuration data from \fI/usr/local/etc/vmm.cfg\fP.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     9
.br
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
    10
The configuration file is split in multiple sections. A section starts with the
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    11
section  name, enclosed in square brackets '[' and ']' (e.g. \fB[database]\fP),
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    12
followed by \'option=value' pairs (e.g. \fBhost = 127.0.0.1\fP).
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    13
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    14
Whitespace around the '=' and at the end of a value is ignored.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    15
.PP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    16
Empty lines and lines starting with '#' or ';' will be ignored.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    17
.PP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    18
Each value uses one of the following data types:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    19
.IP \(bu
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    20
.I Boolean
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    21
to indicate if something is enabled/activated (true) or disabled/deactivated
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
    22
(false).
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
    23
.br
37
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    24
Accepted values for \fBtrue\fP are: \fB1\fP, \fByes\fP, \fBtrue\fP and \fBon\fP.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    25
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    26
Accepted values for \fBfalse\fP are: \fB0\fP, \fBno\fP, \fBfalse\fP and
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    27
\fBoff\fP.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    28
.IP \(bu
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    29
.I Int
37
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    30
an integer number, written without a fractional or decimal component. For
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    31
example \fB1\fP, \fB50\fP or \fB321\fP are integers.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    32
.IP \(bu
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    33
.I String
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    34
a sequence of characters and numbers. For example '\fBword\fP', '\fBhello
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    35
world\fP', or '\fB/usr/bin/strings\fP'
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    36
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    37
.SH DATABASE SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
    38
The \fBdatabase\fP section is used to specify some options required to
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
    39
connect to the database.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    40
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    41
\fBhost\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    42
Hostname or IP address of the database server.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    43
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    44
\fBuser\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    45
Name of the database user.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    46
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    47
\fBpass\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    48
Database password
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    49
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    50
\fBname\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    51
Name of the database.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    52
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    53
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    54
[database]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    55
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    56
host = localhost
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    57
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    58
user = vmm
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    59
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    60
pass = T~_:L4OYyl]TU?)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    61
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    62
name = mailsys
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    63
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    64
.SH MAILDIR SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
    65
The \fBmaildir\fP section is used to specify some options for the Maildirs.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    66
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    67
\fBfolder\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    68
Default name of the maildir folder in users home directory.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    69
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    70
\fBmode\fP (\fIInt\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    71
Access mode for the maildir in decimal (base 10) notation. For example:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    72
\'drwx------' -> octal 0700 -> decimal 448
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    73
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    74
\fBdiskusage\fP (\fIBoolean\fP)
37
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    75
Decides if the disk usage of users maildir always should be summarized and
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    76
displayed with account information.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    77
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    78
\fBdelete\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    79
Decides if the maildir should be deleted recursive when the account is deleted.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    80
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    81
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    82
[maildir]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    83
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    84
folder = Maildir
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    85
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    86
mode = 448
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    87
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    88
diskusage = false
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    89
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    90
delete = false
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    91
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    92
.SH SERVICES SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
    93
The \fBservices\fP section is used to specify the default restrictions for
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
    94
all accounts.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    95
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    96
\fBsmtp\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    97
Decides if users can login via smtp by default. 
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    98
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    99
\fBpop3\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   100
Decides if users can login via pop3 by default. 
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   101
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   102
\fBimap\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   103
Decides if users can login via imap by default. 
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   104
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   105
\fBmanagesieve\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   106
Decides if users can login via managesieve by default. 
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   107
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   108
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   109
[services]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   110
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   111
smtp = true
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   112
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   113
pop3 = true
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   114
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   115
imap = false
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   116
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   117
managesieve = false
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   118
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   119
.SH DOMDIR SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   120
The \fBdomdir\fP section is used to specify options for the directories of the
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   121
domains.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   122
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   123
\fBbase\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   124
All domain directories will be created inside this directory.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   125
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   126
\fBmode\fP (\fIInt\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   127
Access mode for the domain directory in decimal (base 10) notation. For
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   128
example: 'drwxrwx---' -> octal 0770 -> decimal 504
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   129
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   130
\fBdelete\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   131
Decides if the domain directory and all user directories inside should be
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   132
deleted when a domain is deleted.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   133
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   134
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   135
[domdir]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   136
.br
37
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
   137
base = /srv/mail
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   138
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   139
mode = 504
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   140
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   141
delete = false
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   142
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   143
.SH BIN SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   144
The \fBbin\fP section is used to specify some paths to some binaries required
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   145
by \fBvmm\fP.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   146
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   147
\fBdovecotpw\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   148
The absolute path to the dovecotpw binary. This binary is used to generate a
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   149
password hash, if the \fIpasswdscheme\fP is one of 'SMD5', 'SSHA', 'CRAM-MD5',
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   150
\'HMAC-MD5', 'LANMAN', 'NTLM' or 'RPA'.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   151
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   152
\fBdu\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   153
The absolute path to \fBdu\fR(1). This binary is used to summarize the disk
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   154
usage of a maildir.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   155
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   156
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   157
[bin]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   158
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   159
dovecotpw = /usr/sbin/dovecotpw
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   160
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   161
du = /usr/bin/du
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   162
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   163
.SH MISC SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   164
The \fBmisc\fP section is used to define miscellaneous settings.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   165
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   166
\fBpasswdscheme\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   167
Password scheme to use (see also: dovecotpw -l)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   168
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   169
\fBgid_mail\fP (\fIInt\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   170
Numeric group ID of group mail (mail_privileged_group from dovecot.conf)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   171
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   172
\fBforcedel\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   173
Force deletion of accounts and aliases when a domain is deleted.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   174
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   175
\fBtransport\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   176
Default transport for domains and accounts.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   177
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   178
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   179
[misc]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   180
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   181
passwdscheme = CRAM-MD5
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   182
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   183
gid_mail = 8
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   184
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   185
forcedel = false
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   186
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   187
transport = dovecot:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   188
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   189
.SH CONFIG SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   190
The \fBconfig\fP section is a internal used control section.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   191
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   192
\fBdone\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   193
This option is set to \fIfalse\fP when \fBvmm\fP is installed for the first
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   194
time. When you edit \fIvmm.cfg\fP, set this option to \fItrue\fP. This option is
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   195
also set to \fItrue\fP when you configure vmm with the command \fBvmm
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   196
configure\fP.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   197
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   198
If this option is set to \fIfalse\fP, \fBvmm\fP will start in the interactive
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   199
configurations mode.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   200
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   201
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   202
[config]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   203
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   204
done = true
25
985cee77da5f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 24
diff changeset
   205
.\" -----
985cee77da5f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 24
diff changeset
   206
.SH FILES
985cee77da5f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 24
diff changeset
   207
/usr/local/etc/vmm.cfg
985cee77da5f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 24
diff changeset
   208
.SH SEE ALSO
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   209
vmm(1), command line tool to manage email domains/accounts/aliases
25
985cee77da5f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 24
diff changeset
   210
.SH AUTHOR
985cee77da5f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 24
diff changeset
   211
\fBvmm\fP and its man pages were written by Pascal Volk
985cee77da5f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 24
diff changeset
   212
<\fIp.volk@veb-it.de\fP> and are licensed under the terms of the BSD License.