diff --git a/docs/lcdproc-user/configuration.docbook b/docs/lcdproc-user/configuration.docbook
index 0bb1a39..1d173ec 100644
--- a/docs/lcdproc-user/configuration.docbook
+++ b/docs/lcdproc-user/configuration.docbook
@@ -23,10 +23,75 @@ The format of the /etc/LCDd.conf is INI-file like.
-It is divided into sections that start at markers that look like
-[section].
-Comments are all line-based comments,
-and are lines that start with '#' or ';'.
+It is divided into sections that start at declarations that look like
+[section]; i.e. an opening square bracket, followed
+by the section name, and terminated by a closing square bracket, on a line by itself.
+Section names are case insensitive.
+
+
+
+Parameters are grouped into sections and have the form
+key=value;
+i.e. a key, also known as the configuration option, followed by an equality sign and
+finally the value for the option.
+All three elements must occur together on one line.
+The key, which is case insensitive, may be surrounded by spaces,
+but is must be one word (i.e. a sequence of non-space characters) not containing the equality sign.
+A similar rule applies to the value: it may be surrounded by spaces,
+but it must be either one word or enclosed within double quotes ("),
+which are not considered as part of value.
+When quoted, the following character sequences are evaluated as in literal C strings:
+
+
+
+
+
+ escape sequence
+ character
+
+
+
+ \a
+ alert (bell) character
+
+
+ \b
+ backspace
+
+
+ \f
+ formfeed
+
+
+ \n
+ newline
+
+
+ \r
+ carriage return
+
+
+ \t
+ horizontal tab
+
+
+ \v
+ vertical tab
+
+
+ \\
+ backslash
+
+
+
+
+All other occurences of \ within quoted values will be ignored.
+
+
+
+Comments are all line-based, and may start with '#' or ';'.
+Everything including and behind the character starting the comment up to the end
+of the line is ignored.
@@ -46,40 +111,16 @@ line in the server section, like:
[Server]
Driver=curses
-
-
This tells LCDd to use the curses driver.
-The first driver specified here that is capable of output functionality
-will be used as the output driver.
-All other drivers can only serve as input drivers.
-The default driver to use is curses.
-
-
-
-If LCDd is started automatically by an init-script using the curses driver,
-it will lock /dev/tty1! So, be careful about what you are
-doing here.
-
-
+
The drivers read their own options from the config file.
For this purpose they use the config sections that are named like the driver.
-
-LCDd -d driver
-
-
-
-
-If is specified on the command line, the
-Driver= options in the configuration file are ignored.
-
-
-
<filename>LCDd.conf</filename>: The <code>[Server]</code> Section
@@ -100,7 +141,7 @@ settings for the LCDproc server LCDd.
If not specified DRIVERPATH
defaults to the empty string, resulting in drivers being
searched
- in the directory LCDd is started in.
+ in the directory LCDd is started in.
@@ -109,13 +150,25 @@ settings for the LCDproc server LCDd.
Driver=DRIVERNAME
-
- Tells the server which driver(s) to use. See
- above for details.
- If not specified DRIVERNAME
- defaults to curses, a driver that is supposed
- to work on any half-way decent UNIX console.
-
+
+
+ Tells the server which driver(s) to use.
+ The first driver specified here that is capable of output functionality
+ will be used as the master output driver, defining
+ display properties and capabilities.
+ All other drivers specified can only serve as input drivers
+ or slave output drivers.
+ If not specified DRIVERNAME
+ defaults to curses, a driver that is supposed
+ to work on any half-way decent UNIX console.
+
+
+ This setting can be overridden on LCDd's
+ command line using the option.
+ When the command line option is used, only the one driver given there
+ will be loaded, and all drivers specified in the configuration file are ignored.
+
+
@@ -123,11 +176,18 @@ settings for the LCDproc server LCDd.
Bind=ADDRESS
-
- Tells the server to bind to the given local IP address and listen for incoming client connections.
- The default value for ADDRESS is 127.0.0.1, which
- is actually the safest variant.
-
+
+
+ Tells the server to bind to the given local IP address and listen for incoming client connections.
+ The default value for ADDRESS is 127.0.0.1, which
+ is actually the safest variant, as it allows connections only from the local machine and forbids
+ connections from remote systems.
+
+
+ This setting can be overridden on LCDd's
+ command line using the option.
+
+
@@ -135,10 +195,16 @@ settings for the LCDproc server LCDd.
Port=PORTNUMBER
-
- Tells the server to listen to this specified port.
- If not specified PORTNUMBER defaults to 13666.
-
+
+
+ Tells the server to listen to this specified port.
+ If not specified PORTNUMBER defaults to 13666.
+
+
+ This setting can be overridden on LCDd's
+ command line using the option.
+
+
@@ -146,12 +212,18 @@ settings for the LCDproc server LCDd.
ReportLevel=LEVEL
-
- Sets the reporting level.
- Legal values for LEVEL range from 0
- (only critical errors) to 5 (everything including debugging information).
- If not specified it defaults to 2 (warnings and errors only).
-
+
+
+ Sets the reporting level.
+ Legal values for LEVEL range from 0
+ (only critical errors) to 5 (everything including debugging information).
+ If not specified it defaults to 2 (warnings and errors only).
+
+
+ This setting can be overridden on LCDd's
+ command line using the option.
+
+
@@ -164,10 +236,27 @@ settings for the LCDproc server LCDd.
-
- Should we report to syslog instead of stderr?
- Default value is no.
-
+
+
+ Should we report to syslog (yes)
+ instead of stderr (no)?
+ Default value is no.
+
+
+ This setting can be overridden on LCDd's
+ command line using the option.
+ Passing on the command line enables reporting to syslog
+ while disables it.
+
+
+
+ If LCDd is started automatically by an init script
+ using the curses driver, it will lock /dev/tty1!
+ So, be careful about what you are doing here.
+
+
+
+
@@ -177,18 +266,13 @@ settings for the LCDproc server LCDd.
- User to run as. When started as root LCDd will drop its privileges,
- and run as this user instead. Defaults to nobody.
+ User to run as. When started as root LCDd will drop its privileges,
+ and run as USER instead. Defaults to nobody.
+
+
+ This setting can be overridden on LCDd's
+ command line using the option.
-
@@ -202,11 +286,17 @@ settings for the LCDproc server LCDd.
-
- The server will stay in the foreground if set to true.
- Otherwise the server will fork to background and report
- to syslog. Defaults to no.
-
+
+
+ The server will stay in the foreground if set to true.
+ Otherwise the server will fork to background and report
+ to syslog. Defaults to no.
+
+
+ This setting can be overridden on LCDd's
+ command line with the option that forces foreground mode.
+
+
@@ -217,7 +307,7 @@ settings for the LCDproc server LCDd.
Define the startup message printed on the screen when LCDd starts.
- This message will stay on the screen until a client connects.
+ This message will stay on the screen until the first client connects.
If not given, it defaults to the builtin server screen that tells
how many clients are connected and how many screens these clients
are using in total.
@@ -279,10 +369,16 @@ settings for the LCDproc server LCDd.
WaitTime=SECONDS
-
- Sets the default time in seconds to display a screen.
- If not specified the default value for SECONDS is 4.
-
+
+
+ Sets the default time in seconds to display a screen.
+ If not specified the default value for SECONDS is 4.
+
+
+ This setting can be overridden on LCDd's
+ command line with the option.
+
+
@@ -295,11 +391,19 @@ settings for the LCDproc server LCDd.
-
- Include the server screen, that shows the number of active clients and screens,
- into the screen rotation scheme when other screens exist.
- Defaults to yes.
-
+
+
+ Include the server screen, that shows the number of active clients and screens,
+ into the screen rotation scheme when other screens exist.
+ Defaults to yes.
+
+
+ This setting can be overridden on LCDd's
+ command line using the option.
+ Passing on the command line enables server screen rotation,
+ while disables it.
+
+