man/man5/vmm.cfg.5.rst
branchv0.6.x
changeset 177 ec2e1df8bb10
parent 176 cc0d79842fdf
child 179 3d09c657e9e5
equal deleted inserted replaced
176:cc0d79842fdf 177:ec2e1df8bb10
     5 --------------------------
     5 --------------------------
     6 configuration file for vmm
     6 configuration file for vmm
     7 --------------------------
     7 --------------------------
     8 
     8 
     9 :Author:         Pascal Volk <neverseen@users.sourceforge.net>
     9 :Author:         Pascal Volk <neverseen@users.sourceforge.net>
    10 :Date:           2010-01-25
    10 :Date:           2010-01-26
    11 :Version:        vmm-0.6.0
    11 :Version:        vmm-0.6.0
    12 :Manual group:   vmm Manual
    12 :Manual group:   vmm Manual
    13 :Manual section: 5
    13 :Manual section: 5
    14 
    14 
    15 .. contents::
    15 .. contents::
    24 ===========
    24 ===========
    25 **vmm**\(1) reads its configuration data from *vmm.cfg*.
    25 **vmm**\(1) reads its configuration data from *vmm.cfg*.
    26 
    26 
    27 The configuration file is split into multiple sections. A section starts with
    27 The configuration file is split into multiple sections. A section starts with
    28 the section name, enclosed in square brackets '**[**' and '**]**', followed
    28 the section name, enclosed in square brackets '**[**' and '**]**', followed
    29 by '*option* = *value*' pairs::
    29 by '*option* = *value*' pairs.
    30 
       
    31     [database]
       
    32     host = 127.0.0.1
       
    33 
    30 
    34 Whitespace around the '=' and at the end of a value is ignored.
    31 Whitespace around the '=' and at the end of a value is ignored.
    35 
    32 
    36 Empty lines and lines starting with '#' or ';' will be ignored.
    33 Empty lines and lines starting with '#' or ';' will be ignored.
    37 
    34 
    48   | For example **1**, **50** or **321** are integers.
    45   | For example **1**, **50** or **321** are integers.
    49 
    46 
    50 * *String* a sequence of characters and numbers.
    47 * *String* a sequence of characters and numbers.
    51 
    48 
    52   | For example '**word**', '**hello world**' or '**/usr/bin/strings**'
    49   | For example '**word**', '**hello world**' or '**/usr/bin/strings**'
       
    50 
       
    51 Most options have a default value, shown in parentheses after the option's
       
    52 name. In order to use a option's default setting, comment out the line,
       
    53 either with a **#** or **;** or simply remove the setting from *vmm.cfg*.
       
    54 
       
    55 A minimal *vmm.cfg* would be::
       
    56 
       
    57     [database]
       
    58     user = me
       
    59     pass = xxxxxxxx
       
    60 
       
    61     [config]
       
    62     done = true
    53 
    63 
    54 SEARCH ORDER
    64 SEARCH ORDER
    55 -------------
    65 -------------
    56 By default **vmm**\(1) looks for *vmm.cfg* in the following directories in the
    66 By default **vmm**\(1) looks for *vmm.cfg* in the following directories in the
    57 order listed:
    67 order listed:
   277 
   287 
   278 Example::
   288 Example::
   279 
   289 
   280     [misc]
   290     [misc]
   281     base_directory = /srv/mail
   291     base_directory = /srv/mail
   282     password_scheme = CRAM-MD5
   292     password_scheme = PLAIN
   283     gid_mail = 8
   293     gid_mail = 8
   284     transport = dovecot:
   294     transport = dovecot:
   285     dovecot_version = 11
   295     dovecot_version = 11
   286 
   296 
   287 FILES
   297 FILES