man/man5/vmm.cfg.5
author Pascal Volk <neverseen@users.sourceforge.net>
Tue, 23 Dec 2008 19:39:54 +0000
changeset 95 fc008eb12186
parent 94 0d303d15549e
child 100 b581e747e720
permissions -rw-r--r--
* 'VirtualMailManager/Config.py' - fixed parenthesis in Config.configure() * 'setup.py' - updated url to http://vmm.localdomain.org/ - adjusted long_description * 'vmm' - fixed UnicodeDecodeError, that could occur with german locale.
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$
94
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
     2
.TH vmm.cfg 5 "08 Dec 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
94
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
     6
vmm.cfg
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     7
.SH DESCRIPTION
94
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
     8
\fBvmm\fR(1) reads configuration data from \fIvmm.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'
94
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    36
.SS SEARCH ORDER
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    37
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
    38
order listed:
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    39
.RS
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    40
.PD 0
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    41
.TP
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    42
.I
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    43
/root
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    44
.TP
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    45
.I
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    46
/usr/local/etc
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    47
.TP
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    48
.I
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    49
/etc
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    50
.PD
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    51
.RE
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    52
.PP
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
    53
The first match it finds will be used.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    54
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    55
.SH DATABASE SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
    56
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
    57
connect to the database.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    58
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    59
\fBhost\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    60
Hostname or IP address of the database server.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    61
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    62
\fBuser\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    63
Name of the database user.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    64
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    65
\fBpass\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    66
Database password
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    67
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    68
\fBname\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    69
Name of the database.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    70
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    71
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    72
[database]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    73
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    74
host = localhost
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    75
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    76
user = vmm
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    77
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    78
pass = T~_:L4OYyl]TU?)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    79
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    80
name = mailsys
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    81
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    82
.SH MAILDIR SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
    83
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
    84
.TP
68
7ae95b9938c4 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    85
\fBname\fP (\fIString\fP)
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    86
Default name of the maildir folder in users home directory.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    87
.TP
68
7ae95b9938c4 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    88
\fBfolders\fP (\fIString\fP)
7ae95b9938c4 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    89
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
    90
.br
7ae95b9938c4 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    91
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
    92
to a single colon (':').
7ae95b9938c4 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    93
.TP
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    94
\fBmode\fP (\fIInt\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    95
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
    96
\'drwx------' -> octal 0700 -> decimal 448
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    97
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    98
\fBdiskusage\fP (\fIBoolean\fP)
37
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    99
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
   100
displayed with account information.
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
\fBdelete\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   103
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
   104
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   105
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   106
[maildir]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   107
.br
68
7ae95b9938c4 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   108
name = Maildir
7ae95b9938c4 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   109
.br
7ae95b9938c4 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   110
folders = Drafts:Sent:Templates:Trash:INBOX.News
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   111
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   112
mode = 448
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   113
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   114
diskusage = false
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   115
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   116
delete = false
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   117
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   118
.SH SERVICES SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   119
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
   120
all accounts.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   121
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   122
\fBsmtp\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   123
Decides if users can login via smtp by default. 
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   124
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   125
\fBpop3\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   126
Decides if users can login via pop3 by default. 
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   127
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   128
\fBimap\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   129
Decides if users can login via imap by default. 
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   130
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   131
\fBmanagesieve\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   132
Decides if users can login via managesieve by default. 
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
[services]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   136
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   137
smtp = true
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
pop3 = true
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
imap = false
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   142
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   143
managesieve = false
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   144
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   145
.SH DOMDIR SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   146
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
   147
domains.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   148
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   149
\fBbase\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   150
All domain directories will be created inside this directory.
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
\fBmode\fP (\fIInt\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   153
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
   154
example: 'drwxrwx---' -> octal 0770 -> decimal 504
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
\fBdelete\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   157
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
   158
deleted when a domain is deleted.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   159
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   160
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   161
[domdir]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   162
.br
37
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
   163
base = /srv/mail
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   164
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   165
mode = 504
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   166
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   167
delete = false
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   168
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   169
.SH BIN SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   170
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
   171
by \fBvmm\fP.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   172
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   173
\fBdovecotpw\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   174
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
   175
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
   176
\'HMAC-MD5', 'LANMAN', 'NTLM' or 'RPA'.
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
\fBdu\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   179
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
   180
usage of a maildir.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   181
.TP
86
e43e4e7e9ec0 * 'VirtualMailManager/ext/Postconf.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 68
diff changeset
   182
\fBpostconf\fP (\fIString\fP)
e43e4e7e9ec0 * 'VirtualMailManager/ext/Postconf.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 68
diff changeset
   183
The absolute path to Postfix' \fBpostconf\fR(1).
e43e4e7e9ec0 * 'VirtualMailManager/ext/Postconf.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 68
diff changeset
   184
.br
e43e4e7e9ec0 * 'VirtualMailManager/ext/Postconf.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 68
diff changeset
   185
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
   186
e.g. virtual_alias_expansion_limit.
e43e4e7e9ec0 * 'VirtualMailManager/ext/Postconf.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 68
diff changeset
   187
.TP
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   188
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   189
[bin]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   190
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   191
dovecotpw = /usr/sbin/dovecotpw
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   192
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   193
du = /usr/bin/du
86
e43e4e7e9ec0 * 'VirtualMailManager/ext/Postconf.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 68
diff changeset
   194
.br
e43e4e7e9ec0 * 'VirtualMailManager/ext/Postconf.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 68
diff changeset
   195
postconf = /usr/sbin/postconf
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   196
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   197
.SH MISC SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   198
The \fBmisc\fP section is used to define miscellaneous settings.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   199
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   200
\fBpasswdscheme\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   201
Password scheme to use (see also: dovecotpw -l)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   202
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   203
\fBgid_mail\fP (\fIInt\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   204
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
   205
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   206
\fBforcedel\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   207
Force deletion of accounts and aliases when a domain is deleted.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   208
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   209
\fBtransport\fP (\fIString\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   210
Default transport for domains and accounts.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   211
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   212
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   213
[misc]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   214
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   215
passwdscheme = CRAM-MD5
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   216
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   217
gid_mail = 8
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   218
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   219
forcedel = false
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   220
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   221
transport = dovecot:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   222
.\" -----
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   223
.SH CONFIG SECTION
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   224
The \fBconfig\fP section is a internal used control section.
24
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   225
.TP
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   226
\fBdone\fP (\fIBoolean\fP)
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   227
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
   228
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
   229
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
   230
configure\fP.
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   231
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   232
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
   233
configurations mode.
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
\fBExample\fP:
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   236
[config]
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   237
.br
48ea255e8a85 * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   238
done = true
25
985cee77da5f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 24
diff changeset
   239
.\" -----
985cee77da5f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 24
diff changeset
   240
.SH FILES
94
0d303d15549e * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 86
diff changeset
   241
vmm.cfg
25
985cee77da5f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 24
diff changeset
   242
.SH SEE ALSO
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   243
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
   244
.SH AUTHOR
985cee77da5f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 24
diff changeset
   245
\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
   246
<\fIp.volk@veb-it.de\fP> and are licensed under the terms of the BSD License.