1lcdproc-config(5) LCDproc suite lcdproc-config(5)
2
6 lcdproc-config - format of LCDproc's configuration files
7
10 The syntax for LCDproc's configuration files is INI-file style.
11 They are 8-bit text files divided into sections, each containing zero
13 or more key-value pairs. Sections are introduced by section labels
14 which start with '[' and end with ']', and key-value pairs consist of a
15 key name, a '=' sign and a value each.
16 Key names are sequences of non-space characters, not starting with '['
18 and not containing '=' or '\n', while values are shell like strings.
19 I.e. they are either simple sequences of non-space characters, or dou‐
20 ble quoted-strings with C-style syntax (except the missing support for
21 '\NNN' and '\xNN' escape sequences) or or a mix of both of these forms.
22 Section labels and key names are case-insensitive and may occur more
24 than once. Keys of duplicate sections will be merged into one section,
25 while the values of duplicate keys in a section will be appended to
26 form an array of values for this key. (In the program, all values of a
27 key can be retrieved individually)
28 Spaces around section labels, keys, and values are ignored. Lines
30 starting with ';' or '#' are considered comments and ignored too.
31 While all of the above is quite common to almost all INI-file implemen‐
33 tations, there are a few special features that make LCDproc's config
34 files special:
35 * Section labels may contain any character except ']', '\n' or
37 '\0'. However, all characters are interpreted literally (i.e.
38 neither quoting, nor escaping done).
39 * Key names may contain any non-space character except '\n' or
41 '\0'. However, all characters are interpreted literally (i.e.
42 neither quoting, nor escaping done).
43 * Comments are allowed after section labels and key value pairs
45 * Values may be a mix of quoted and unquoted strings similar as
47 strings are interpreted in the shell. E.g. the value 'string"
48 with "blanks"\t!"' will be parsed as 'string with blanks<TAB>!'
49 where <TAB> stands for the TAB character.
50 In case of a a parsing error the rest of the line is ignored and pars‐
52 ing continues with the next line.
53
56 Here is fully working example of an LCDd.conf (formatted somewhat
57 strange to show the features):
58 # the server section
59 [server]
60 Bind=127.0.0.1
61 Port=13666
62 User="nobody"
63 #Foreground=no
64 #ReportLevel=3
65 #ReportToSyslog=yes
66 Driver="my Curses Driver"
67 DriverPath=/usr/lib/lcdproc/
68 WaitTime= "5"
69 ServerScreen=no
70 # assign keys to special functions #
72 ToggleRotateKey = Enter
73 PrevScreenKey = Left
74 NextScreenKey = Right
75 # ScrollUpKey = Up
76 #ScrollDownKey=Down
77 # menu section: define keys to use in the server menu #
79 [menu]
80 MenuKey = Escape # ESC switches to server menu
81 EnterKey =Enter
82 UpKey= Up
83 DownKey="Down"
84 LeftKey= "Left"
85 RightKey = "Right"
86 # configuration of the curses driver #
88 [my curses Driver] # yes I use the curse driver
89 File= "curses.so"
90 Size="20"x"4" # LCD screen dimensions
91 TopLeftX=7 # screen position: X coordinate
92 TopLeftY=7 # screen position: Y coordinate
93 Foreground=blue # foreground color
94 Background=cyan # background color when backight is off
95 Backlight=red # background color when backight is on
96
100 These are the default config files for the various parts of the LCDproc
101 suite:
102 /etc/lcdproc/LCDd.conf
104 configuration of the LCDd server daemon
105 /etc/lcdproc/lcdproc.conf
107 configuration of the lcdproc system monitoring client
108 /etc/lcdproc/lcdexec.conf
110 configuration of the lcdexec the program starter client
111 /etc/lcdproc/lcdvc.conf
113 configuration of the lcdvc virtual console client
114
117 LCDd(8), lcdproc(1), lcdexec(1)
118
121 This manual page has been written by Peter Marschall <peter@adpm.de>
122LCDproc 18 September 2006 lcdproc-config(5)