1lcdproc-config(5)                LCDproc suite               lcdproc-config(5)
2
3
4

NAME

6       lcdproc-config - format of LCDproc's configuration files
7
8

SYNTAX

10       The syntax for LCDproc's configuration files is INI-file style.
11
12       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
17       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
23       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
29       Spaces around section labels, keys,  and  values  are  ignored.   Lines
30       starting with ';' or '#' are considered comments and ignored too.
31
32       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
36       *      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
40       *      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
44       *      Comments are allowed after section labels and key value pairs
45
46       *      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
51       In case of a a parsing error the rest of the line is ignored and  pars‐
52       ing continues with the next line.
53
54

GENERAL CONFIGURATION

56       The  section  '[lcdproc]'  defines  the  options to connect to the LCDd
57       server : hostname, port, log level...
58
59
60       Server=
61           address of the LCDd server to connect to
62
63       Port=
64           Port of the server to connect to
65
66       ReportLevel=
67           set reporting level
68
69       ReportToSyslog=
70           [default: false; legal: true, false]
71
72       Foreground=
73           run in foreground [default: false; legal: true, false]
74
75       PidFile=
76           PidFile location when running  as  daemon  [default:  /var/run/lcd‐
77           proc.pid]
78
79       delay=
80           slow down initial announcement of modes (in 1/100s) [default: 2]
81
82       DisplayName=
83           display name for the main menu [default: LCDproc HOST]
84
85

SCREEN SPECIFIC CONFIGURATION

87       the  following section of the /etc/lcdproc/lcdproc.conf contains screen
88       specific configuration options. Each section refers to a  screen  which
89       can be enabled and configured.
90
91

[CPU] SECTION OPTIONS

93       Displays CPU usage.
94
95       Screen example (depending on screen size):
96        +--------------------+   +--------------------+
97        |## CPU 51.9%: myh #@|   |CPU [----    ]48.1%@|
98        |Usr 46.0% Nice  0.0%|   |U--  S-   N    I--- |
99        |Sys  5.9% Idle 48.1%|   +--------------------+
100        |0%--------      100%|
101        +--------------------+
102
103       Active=
104           Show the screen [default: false; legal: true, false]
105
106       OnTime=
107           [integer; 1]
108
109       OffTime=
110           [integer; 2]
111
112       ShowInvisible=
113           [default: false; legal: true, false]
114
115

[Iface] SECTION OPTIONS

117       Displays stats about network interfaces.
118
119       Screen example (depending on screen size):
120        +--------------------+   +--------------------+
121        |## Net Load: LAN ##@|   |### Net Load ######@|
122        |UL:       123.456 Kb|   |LAN: U: 34kb D: 56Mb|
123        |DL:       654.321 Kb|   +--------------------+
124        |Total:    777.777 Kb|
125        +--------------------+
126
127       Active=
128           Show the screen [default: false; legal: true, false]
129
130       Interface0=
131           defines the interface name : eth0
132
133       Alias0=
134           Interface alias name to display [default: <interface name>]
135
136       Note:
137           Interface0 and Alias0 can be repeated to display more interfaces, the last digit in the option must be incremented. For more than 3 interfaces change MAX_INTERFACES in iface.h and rebuild.
138
139       unit=
140           Units to display [default: byte; legal: byte, bit, packet]
141
142       transfer=
143           add screen with transferred traffic [default: false; legal: true, false]
144
145

[Memory] SECTION OPTIONS

147       Displays stats about memory.
148
149       Screen example (depending on screen size):
150        +--------------------+   +--------------------+
151        |##  MEM #### SWAP #@|   |M 758.3M [- ] 35.3%@|
152        | 758.3M Totl 1.884G |   |S 1.884G [  ]  0.1% |
153        | 490.8M Free 1.882G |   +--------------------+
154        |E---    F  E       F|
155        +--------------------+
156
157       Active=
158           Show the screen [default: false; legal: true, false]
159
160

[Load] SECTION OPTIONS

162       Shows a display very similar to "xload"'s histogram
163
164       Screen example (depending on screen size):
165        +--------------------+   +--------------------+
166        |## LOAD 0.44: myh #@|   |myhost 0.24        1|
167        |                   1|   |        |||||||||||0|
168        |            ||||||  |   +--------------------+
169        |    ||||  |||||||| 0|
170        +--------------------+
171
172       Active=
173           Show the screen [default: false; legal: true, false]
174
175       LowLoad=
176           Min Load Avg at which the backlight will be turned off [default: 0.05]
177
178       HighLoad=
179           Max Load Avg at which the backlight will start blinking [default: 1.3]
180
181

[TimeDate] SECTION OPTIONS

183       Displays current time and date, uptime, OS ver
184
185       Screen example (depending on screen size):
186        +--------------------+   +--------------------+
187        |## Linux 2.6.11 ###@|   |### TIME: myhost ##@|
188        |Up xxx days hh:mm:ss|   |17.05.2005 11:32:57a|
189        |  Wed May 17, 1998  |   +--------------------+
190        |11:32:57a  100% idle|
191        +--------------------+
192
193       Active=
194           Show the screen [default: false; legal: true, false]
195
196       TimeFormat=
197           Time format [default: "%H:%M:%S"; legal: see strftime(3)]
198
199       DateFormat=
200           Date format [default: "%x"; legal: see strftime(3)]
201
202

[About] SECTION OPTIONS

204       Shows who wrote this software
205
206       Active=
207           Show the screen [default: false; legal: true, false]
208
209

[SMP-CPU] SECTION OPTIONS

211       Shows a current usage percentage graph for each CPU.
212
213       Active=
214           Show the screen [default: false; legal: true, false]
215
216

[OldTime] SECTION OPTIONS

218       Displays current time and date
219
220       Screen example (depending on screen size):
221        +--------------------+   +--------------------+
222        |## DATE & TIME ####@|   |### TIME: myhost ##@|
223        |       myhost       |   |2005-05-17 11:32:57a|
224        |11:32:75a Wednesday,|   +--------------------+
225        |       May 17, 2005 |
226        +--------------------+
227
228       Active=
229           Show the screen [default: false; legal: true, false]
230
231       TimeFormat=
232           time format [default: "%H:%M:%S"; legal: see strftime(3)]
233
234       DateFormat=
235           date format [default: "%x"; legal: see strftime(3)]
236
237       ShowTitle=
238           Display the title bar in two-line mode. Note that with four lines or more the title is always shown. [default: true; legal: true, false]
239           Screen example :
240            +----------------+
241            |   2012-12-27  @|
242            |    15:07:01    |
243            +----------------+
244
245

[BigClock] SECTION OPTIONS

247       Displays current time with big number
248
249       Screen example (depending on screen size):
250        +--------------------+
251        |    _   _      _  _ |
252        |  ||_ . _||_|. _|  ||
253        |  ||_|. _|  |.|_   ||
254        |                    |
255        +--------------------+
256
257       Active=
258           Show the screen [default: false; legal: true, false]
259
260       showSecs=
261           display seconds [default: true; legal: true, false]
262           true : the date is displayed in format HH:MM:SS (default)
263           false : the date is displayed in format HH:MM
264           Screen example :
265            +--------------------+
266            |       _   _        |
267            |     ||_ . _||_|    |
268            |     ||_|. _|  |    |
269            |                    |
270            +--------------------+
271
272

[Uptime] SECTION OPTIONS

274       Shows info about system uptime and OS version
275
276       Screen example (depending on screen size):
277        +--------------------+   +--------------------+
278        |## SYSTEM UPTIME ##@|   |# Linux 2.6.11: my#@|
279        |       myhost       |   | xxx days hh:mm:ss  |
280        | xxx days hh:mm:ss  |   +--------------------+
281        |   Linux 2.6.11     |
282        +--------------------+
283
284       Active=
285           Show the screen [default: false; legal: true, false]
286
287

[Battery] SECTION OPTIONS

289       Shows apm battery status
290
291       Screen example (depending on screen size):
292        +--------------------+   +--------------------+
293        |## AC: 100%: myho #@|   |## AC: 100%: myho #@|
294        |AC: On              |   |AC, Batt: Absent    |
295        |Batt: Absent        |   +--------------------+
296        |E------------------F|
297        +--------------------+
298
299       Active=
300           Show the screen [default: false; legal: true, false]
301
302

[CPUGraph] SECTION OPTIONS

304       Shows a quick-moving histogram of CPU use
305
306       Screen example (depending on screen size):
307        +--------------------+   +--------------------+
308        |## CPU: myhost ####@|   |CPU: myhos||       @|
309        |             ||     |   |         ||||       |
310        |            |||     |   +--------------------+
311        |            ||||    |
312        +--------------------+
313
314       Active=
315           Show the screen [default: false; legal: true, false]
316
317

[ProcSize] SECTION OPTIONS

319       Displays info about top 5 memory hogs
320
321       Screen example (depending on screen size):
322        +--------------------+   +--------------------+
323        |## TOP MEM: myhos #@|   |## TOP MEM: myhos #@|
324        |1 110.4M mysqld     |   |1 110.4M mysqld     |
325        |2 35.38M konqueror(2|   +--------------------+
326        |3 29.21M XFree86    |
327        +--------------------+
328
329       Active=
330           Show the screen [default: false; legal: true, false]
331
332

[Disk] SECTION OPTIONS

334       Displays disks stats
335
336       Screen example (depending on screen size):
337        +--------------------+   +--------------------+
338        |## DISKS: myhost ##@|   |## DISKS: myhost ##@|
339        |/       18.3G E--  F|   |-local  18.3G E--- F|
340        |-local  18.3G E--- F|   +--------------------+
341        |/boot  949.6M E-   F|
342        +--------------------+
343
344       Active=
345           Show the screen [default: false; legal: true, false]
346
347

[MiniClock] SECTION OPTIONS

349       Displays the current time
350
351       Screen example (depending on screen size):
352        +--------------------+   +--------------------+
353        |                    |   |       11:32        |
354        |       11:32        |   |                    |
355        |                    |   +--------------------+
356        |                    |
357        +--------------------+
358
359       Active=
360           Show the screen [default: false; legal: true, false]
361
362       TimeFormat=
363           Time format [default: "%H:%M"; legal: see strftime(3)]
364
365

EXAMPLE

367       Here is fully working example of an lcdproc.conf (formatted somewhat
368       strange to show the features):
369
370       # LCDproc client configuration file
371
372       ## general options ##
373       [lcdproc]
374       # address of the LCDd server to connect to
375        Server=localhost
376       # Port of the server to connect to
377       Port=13666
378       # set reporting level
379       ReportLevel=2
380       # report to to syslog ?
381       ReportToSyslog=false
382       # run in foreground [default: false; legal: true, false]
383       # Foreground=true
384       # PidFile location when running as daemon [default: /var/run/lcdproc.pid]
385        #PidFile=/var/run/lcdproc.pid
386       # slow down initial announcement of modes (in 1/100s)
387       #delay=2
388       # display name for the main menu [default: LCDproc HOST]
389       #DisplayName=lcdproc
390
391       ## screen specific configuration options ##
392
393          [CPU]
394       # Show screen
395       Active=True
396          OnTime=1
397       OffTime=2
398       ShowInvisible=false
399
400       [Iface]
401       # Show screen
402       Active=True
403
404       # Show stats for Interface0
405       Interface0=eth0
406       # Interface alias name to display [default: <interface name>]
407       Alias0=LAN
408       # Show stats for Interface1
409       #Interface1=eth1
410       #Alias1=WAN
411       # Show stats for Interface2
412       #Interface2=eth2
413       #Alias2=MGMT
414       # for more than 3 interfaces change MAX_INTERFACES in iface.h and rebuild
415       # Units to display [default: byte; legal: byte, bit, packet]
416       unit=bit
417       # add screen with transferred traffic
418       #transfer=TRUE
419
420       [Memory]
421       # Show screen
422       Active=True
423
424       [Load]
425       # Show screen
426       Active=True
427       # Min Load Avg at which the backlight will be turned off [default: 0.05]
428       LowLoad=0.05
429       # Max Load Avg at which the backlight will start blinking [default: 1.3]
430       HighLoad=1.3
431
432       [TimeDate]
433       # Show screen
434       Active=True
435       # time format [default: %H:%M:%S; legal: see strftime(3)]
436       TimeFormat="%H:%M:%S"
437       # date format [default: %x; legal: see strftime(3)]
438       DateFormat="%x"
439
440       [About]
441       # Show screen
442       Active=false
443
444       [SMP-CPU]
445       # Show screen
446       Active=false
447
448       [OldTime]
449       # Show screen
450       Active=false
451       # time format [default: %H:%M:%S; legal: see strftime(3)]
452       TimeFormat="%H:%M:%S"
453       # date format [default: %x; legal: see strftime(3)]
454       DateFormat="%x"
455       # Display the title bar in two-line mode. Note that with four lines or more
456       # the title is always shown. [default: true; legal: true, false]
457       #ShowTitle=false
458
459       [BigClock]
460       # Show screen
461       Active=false
462       # display seconds
463       # true : the date is displayed in format HH:MM:SS (default)
464       # false : the date is displayed in format HH:MM
465       # [default: true; legal: true, false]
466       #showSecs=true
467
468       [Uptime]
469       # Show screen
470       Active=false
471
472       [Battery]
473       # Show screen
474       Active=false
475
476       [CPUGraph]
477       # Show screen
478       Active=false
479
480       [ProcSize]
481       # Show screen
482       Active=false
483
484       [Disk]
485       # Show screen
486       Active=false
487
488       [MiniClock]
489       # Show screen
490       Active=True
491       # time format [default: %H:%M; legal: see strftime(3)]
492       TimeFormat="%H:%M"
493
494       # EOF
495
496

FILES

498       These are the default config files for the various parts of the LCDproc
499       suite:
500
501       /etc/lcdproc/LCDd.conf
502              configuration of the LCDd server daemon
503
504       /etc/lcdproc/lcdproc.conf
505              configuration of the lcdproc system monitoring client
506
507       /etc/lcdproc/lcdexec.conf
508              configuration of the lcdexec the program starter client
509
510       /etc/lcdproc/lcdvc.conf
511              configuration of the lcdvc virtual console client
512
513

SEE ALSO

515       LCDd(8), lcdproc(1), lcdexec(1)
516
517

AUTHOR

519       This manual page has been written by Peter Marschall <peter@adpm.de>
520
521
522
523LCDproc                        18 September 2006             lcdproc-config(5)