summaryrefslogtreecommitdiff
path: root/doc/bitz-server.conf.man
blob: ec4ca34d1bc4394863ebe6d233de3c5e67942f36 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
.TH bitz-server.conf 5 "November 2015" Linux "File Formats Manual"
.SH NAME
bitz-server.conf \- bitz-server configuration file
.SH SYNOPSIS
.B /etc/bitz/bitz-server.conf
.SH DESCRIPTION
.BR bitz-server (1)
obtains configuration data from a config file, the location of which is specified
at compile-time and can be overridden by command-line options during run-time.
.SS Grammar
Below is the BNF grammar for configuration files. Comments and include directives
are not part of the grammar, so they are not included here. See libconfig manual
at http://www.hyperrealm.com/libconfig/libconfig_manual.html#Configuration-File-Grammar
for more details.
.PP
.RS
.nf
configuration = setting-list | empty
setting-list = setting | setting-list setting
setting = name (":" | "=") value (";" | "," | empty)
value = scalar-value | array | list | group
value-list = value | value-list "," value
scalar-value = boolean | integer | integer64 | hex | hex64 | float | string
scalar-value-list = scalar-value | scalar-value-list "," scalar-value
array = "[" (scalar-value-list | empty) "]"
list = "(" (value-list | empty) ")"
group = "{" (setting-list | empty) "}"
empty =
.fi
.RE
.PP
Terminals are defined below as regular expressions:
.TP
.B boolean
([Tt][Rr][Uu][Ee])|([Ff][Aa][Ll][Ss][Ee])
.TP
.B string
\\"([^\\"\\\\]|\\\\.)*\\"
.TP
.B name
[A-Za-z\\*][\-A-Za-z0-9_\\*]*
.TP
.B integer
[\-+]?[0-9]+
.TP
.B integer64
[\-+]?[0-9]+L(L)?
.TP
.B hex
0[Xx][0-9A-Fa-f]+
.TP
.B hex64
0[Xx][0-9A-Fa-f]+L(L)?
.TP
.B float
.nf
([\-+]?([0-9]*)?\\.[0-9]*([eE][-+]?[0-9]+)?)|
([\-+]([0-9]+)(\\.[0-9]*)?[eE][-+]?[0-9]+)
.fi
.SH AUTHOR
Uditha Atukorala <ua@nuked.zone>
.SH "SEE ALSO"
.BR bitz-server (1)