man/man5/vmm.cfg.5
author Pascal Volk <neverseen@users.sourceforge.net>
Sat, 02 Jan 2010 19:37:20 +0000
branchv0.6.x
changeset 163 1981f285f0c0
parent 162 0ac9ef587769
child 169 a72908248153
permissions -rw-r--r--
setup.py: Fixed a UserWarning that may occur with older Python.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
113
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
     1
.TH vmm.cfg 5 "17 Aug 2009" "Pascal Volk"
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     2
.SH NAME
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     3
vmm.cfg \- configuration file for vmm
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     4
.SH SYNOPSIS
94
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
     5
vmm.cfg
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     6
.SH DESCRIPTION
94
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
     7
\fBvmm\fR(1) reads configuration data from \fIvmm.cfg\fP.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     8
.br
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
     9
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
    10
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
    11
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
    12
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    13
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
    14
.PP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    15
Empty lines and lines starting with '#' or ';' will be ignored.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    16
.PP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    17
Each value uses one of the following data types:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    18
.IP \(bu
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    19
.I Boolean
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    20
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
    21
(false).
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
    22
.br
37
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    23
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
    24
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    25
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
    26
\fBoff\fP.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    27
.IP \(bu
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    28
.I Int
37
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    29
an integer number, written without a fractional or decimal component. For
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    30
example \fB1\fP, \fB50\fP or \fB321\fP are integers.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    31
.IP \(bu
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    32
.I String
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    33
a sequence of characters and numbers. For example '\fBword\fP', '\fBhello
100
b581e747e720 INSTALL, man/*: small enhancement and corrections
Pascal Volk <neverseen@users.sourceforge.net>
parents: 94
diff changeset
    34
world\fP' or '\fB/usr/bin/strings\fP'
94
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    35
.SS SEARCH ORDER
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    36
By default vmm looks for \fIvmm.cfg\fP in the following directories in the
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    37
order listed:
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    38
.RS
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    39
.PD 0
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    40
.TP
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    41
.I
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    42
/root
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    43
.TP
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    44
.I
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    45
/usr/local/etc
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    46
.TP
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    47
.I
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    48
/etc
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    49
.PD
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    50
.RE
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    51
.PP
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    52
The first match it finds will be used.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    53
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    54
.SH DATABASE SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
    55
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
    56
connect to the database.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    57
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    58
\fBhost\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    59
Hostname or IP address of the database server.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    60
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    61
\fBuser\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    62
Name of the database user.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    63
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    64
\fBpass\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    65
Database password
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
\fBname\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    68
Name of the database.
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
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    71
[database]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    72
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    73
host = localhost
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    74
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    75
user = vmm
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    76
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    77
pass = T~_:L4OYyl]TU?)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    78
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    79
name = mailsys
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    80
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    81
.SH MAILDIR SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
    82
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
    83
.TP
68
7ae95b9938c4 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    84
\fBname\fP (\fIString\fP)
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    85
Default name of the maildir folder in users home directory.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    86
.TP
68
7ae95b9938c4 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    87
\fBfolders\fP (\fIString\fP)
7ae95b9938c4 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    88
A colon separated list of folder names, that should be created.
7ae95b9938c4 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    89
.br
7ae95b9938c4 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    90
If no folders should be created inside the Maildir, set the value of this option
7ae95b9938c4 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    91
to a single colon (':').
7ae95b9938c4 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    92
.TP
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    93
\fBmode\fP (\fIInt\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    94
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
    95
\'drwx------' -> octal 0700 -> decimal 448
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    96
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    97
\fBdiskusage\fP (\fIBoolean\fP)
37
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    98
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
    99
displayed with account information.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   100
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   101
\fBdelete\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   102
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
   103
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   104
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   105
[maildir]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   106
.br
68
7ae95b9938c4 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   107
name = Maildir
7ae95b9938c4 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   108
.br
7ae95b9938c4 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   109
folders = Drafts:Sent:Templates:Trash:INBOX.News
24
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
mode = 448
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
diskusage = false
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
delete = false
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   116
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   117
.SH SERVICES SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   118
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
   119
all accounts.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   120
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   121
\fBsmtp\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   122
Decides if users can login via smtp by default. 
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   123
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   124
\fBpop3\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   125
Decides if users can login via pop3 by default. 
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   126
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   127
\fBimap\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   128
Decides if users can login via imap by default. 
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   129
.TP
113
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
   130
\fBsieve\fP (\fIBoolean\fP)
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   131
Decides if users can login via managesieve by default. 
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   132
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   133
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   134
[services]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   135
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   136
smtp = true
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   137
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   138
pop3 = true
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   139
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   140
imap = false
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   141
.br
113
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
   142
sieve = false
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   143
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   144
.SH DOMDIR SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   145
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
   146
domains.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   147
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   148
\fBbase\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   149
All domain directories will be created inside this directory.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   150
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   151
\fBmode\fP (\fIInt\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   152
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
   153
example: 'drwxrwx---' -> octal 0770 -> decimal 504
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   154
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   155
\fBdelete\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   156
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
   157
deleted when a domain is deleted.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   158
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   159
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   160
[domdir]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   161
.br
37
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
   162
base = /srv/mail
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   163
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   164
mode = 504
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   165
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   166
delete = false
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   167
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   168
.SH BIN SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   169
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
   170
by \fBvmm\fP.
24
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
\fBdovecotpw\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   173
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
   174
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
   175
\'HMAC-MD5', 'LANMAN', 'NTLM' or 'RPA'.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   176
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   177
\fBdu\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   178
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
   179
usage of a maildir.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   180
.TP
86
e43e4e7e9ec0 * 'VirtualMailManager/ext/Postconf.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 68
diff changeset
   181
\fBpostconf\fP (\fIString\fP)
e43e4e7e9ec0 * 'VirtualMailManager/ext/Postconf.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 68
diff changeset
   182
The absolute path to Postfix' \fBpostconf\fR(1).
e43e4e7e9ec0 * 'VirtualMailManager/ext/Postconf.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 68
diff changeset
   183
.br
e43e4e7e9ec0 * 'VirtualMailManager/ext/Postconf.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 68
diff changeset
   184
This binary is required if \fBvmm\fR(1) has to check for some Postfix settings,
e43e4e7e9ec0 * 'VirtualMailManager/ext/Postconf.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 68
diff changeset
   185
e.g. virtual_alias_expansion_limit.
e43e4e7e9ec0 * 'VirtualMailManager/ext/Postconf.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 68
diff changeset
   186
.TP
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   187
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   188
[bin]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   189
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   190
dovecotpw = /usr/sbin/dovecotpw
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   191
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   192
du = /usr/bin/du
86
e43e4e7e9ec0 * 'VirtualMailManager/ext/Postconf.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 68
diff changeset
   193
.br
e43e4e7e9ec0 * 'VirtualMailManager/ext/Postconf.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 68
diff changeset
   194
postconf = /usr/sbin/postconf
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   195
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   196
.SH MISC SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   197
The \fBmisc\fP section is used to define miscellaneous settings.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   198
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   199
\fBpasswdscheme\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   200
Password scheme to use (see also: dovecotpw -l)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   201
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   202
\fBgid_mail\fP (\fIInt\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   203
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
   204
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   205
\fBforcedel\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   206
Force deletion of accounts and aliases when a domain is deleted.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   207
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   208
\fBtransport\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   209
Default transport for domains and accounts.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   210
.TP
113
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
   211
\fBdovecotvers\fP (\fIInt\fP)
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
   212
The concatenated major and minor version number of the currently used Dovecot
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
   213
version. (see: dovecot --version).
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
   214
.br
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
   215
This option affects various database operations. There are some differences
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
   216
between Dovecot v1.1.x and v1.2.x. For example, when the command \fBdovecot
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
   217
--version\fP shows \fB1.1\fP.18, set the value of this option to \fB11\fP.
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
   218
.TP
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   219
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   220
[misc]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   221
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   222
passwdscheme = CRAM-MD5
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   223
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   224
gid_mail = 8
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   225
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   226
forcedel = false
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   227
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   228
transport = dovecot:
113
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
   229
.br
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
   230
dovecotvers = 11
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   231
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   232
.SH CONFIG SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   233
The \fBconfig\fP section is a internal used control section.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   234
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   235
\fBdone\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   236
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
   237
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
   238
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
   239
configure\fP.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   240
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   241
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
   242
configurations mode.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   243
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   244
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   245
[config]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   246
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   247
done = true
25
985cee77da5f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 24
diff changeset
   248
.\" -----
985cee77da5f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 24
diff changeset
   249
.SH FILES
94
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
   250
vmm.cfg
25
985cee77da5f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 24
diff changeset
   251
.SH SEE ALSO
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   252
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
   253
.SH AUTHOR
985cee77da5f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 24
diff changeset
   254
\fBvmm\fP and its man pages were written by Pascal Volk
162
0ac9ef587769 Updated copyright notices to include the year 2010.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 113
diff changeset
   255
<\fIneverseen@users.sourceforge.net\fP> and are licensed under the terms of the
0ac9ef587769 Updated copyright notices to include the year 2010.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 113
diff changeset
   256
BSD License.