man/man5/vmm.cfg.5
changeset 94 0d303d15549e
parent 86 e43e4e7e9ec0
child 100 b581e747e720
equal deleted inserted replaced
93:bc41dfcef0ad 94:0d303d15549e
     1 .\" $Id$
     1 .\" $Id$
     2 .TH vmm.cfg 5 "15 Sep 2008" "Pascal Volk"
     2 .TH vmm.cfg 5 "08 Dec 2008" "Pascal Volk"
     3 .SH NAME
     3 .SH NAME
     4 vmm.cfg \- configuration file for vmm
     4 vmm.cfg \- configuration file for vmm
     5 .SH SYNOPSIS
     5 .SH SYNOPSIS
     6 /usr/local/etc/vmm.cfg
     6 vmm.cfg
     7 .SH DESCRIPTION
     7 .SH DESCRIPTION
     8 \fBvmm\fR(1) reads configuration data from \fI/usr/local/etc/vmm.cfg\fP.
     8 \fBvmm\fR(1) reads configuration data from \fIvmm.cfg\fP.
     9 .br
     9 .br
    10 The configuration file is split in multiple sections. A section starts with the
    10 The configuration file is split in multiple sections. A section starts with the
    11 section  name, enclosed in square brackets '[' and ']' (e.g. \fB[database]\fP),
    11 section  name, enclosed in square brackets '[' and ']' (e.g. \fB[database]\fP),
    12 followed by \'option=value' pairs (e.g. \fBhost = 127.0.0.1\fP).
    12 followed by \'option=value' pairs (e.g. \fBhost = 127.0.0.1\fP).
    13 .br
    13 .br
    31 example \fB1\fP, \fB50\fP or \fB321\fP are integers.
    31 example \fB1\fP, \fB50\fP or \fB321\fP are integers.
    32 .IP \(bu
    32 .IP \(bu
    33 .I String
    33 .I String
    34 a sequence of characters and numbers. For example '\fBword\fP', '\fBhello
    34 a sequence of characters and numbers. For example '\fBword\fP', '\fBhello
    35 world\fP', or '\fB/usr/bin/strings\fP'
    35 world\fP', or '\fB/usr/bin/strings\fP'
       
    36 .SS SEARCH ORDER
       
    37 By default vmm looks for \fIvmm.cfg\fP in the following directories in the
       
    38 order listed:
       
    39 .RS
       
    40 .PD 0
       
    41 .TP
       
    42 .I
       
    43 /root
       
    44 .TP
       
    45 .I
       
    46 /usr/local/etc
       
    47 .TP
       
    48 .I
       
    49 /etc
       
    50 .PD
       
    51 .RE
       
    52 .PP
       
    53 The first match it finds will be used.
    36 .\" -----
    54 .\" -----
    37 .SH DATABASE SECTION
    55 .SH DATABASE SECTION
    38 The \fBdatabase\fP section is used to specify some options required to
    56 The \fBdatabase\fP section is used to specify some options required to
    39 connect to the database.
    57 connect to the database.
    40 .TP
    58 .TP
   218 [config]
   236 [config]
   219 .br
   237 .br
   220 done = true
   238 done = true
   221 .\" -----
   239 .\" -----
   222 .SH FILES
   240 .SH FILES
   223 /usr/local/etc/vmm.cfg
   241 vmm.cfg
   224 .SH SEE ALSO
   242 .SH SEE ALSO
   225 vmm(1), command line tool to manage email domains/accounts/aliases
   243 vmm(1), command line tool to manage email domains/accounts/aliases
   226 .SH AUTHOR
   244 .SH AUTHOR
   227 \fBvmm\fP and its man pages were written by Pascal Volk
   245 \fBvmm\fP and its man pages were written by Pascal Volk
   228 <\fIp.volk@veb-it.de\fP> and are licensed under the terms of the BSD License.
   246 <\fIp.volk@veb-it.de\fP> and are licensed under the terms of the BSD License.