diff --git a/docs/lcdproc-user/configuration.docbook b/docs/lcdproc-user/configuration.docbook index 465fbd5..8ae5144 100644 --- a/docs/lcdproc-user/configuration.docbook +++ b/docs/lcdproc-user/configuration.docbook @@ -89,78 +89,94 @@ settings for the LCDproc server LCDd. - - Driver= - - + + Driver= + DRIVERNAME + + Tells the server which driver(s) to use. See - above for details - - - - The default setting is Driver=none which makes the server exit right - after the start. This is neccessary to avoid trouble with package installations. - - - + above for details. + If not specified DRIVERNAME + defaults to curses, a driver that is supposed + to work on any half-way decent UNIX console. + - Bind= - - - Tells the server to bind to the given interface. Default to Bind=127.0.0.1 which + + 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. - - + - Port= - - - Tells the server to listen to this specified port; defaults to 13666. - - - - - - ReportLevel= - - - Sets the reporting level; defaults to 2 (warnings and errors only). - - - - - - ReportToSyslog= - - - Should we report to syslog instead of stderr ? Defaults to no. - - - - - - WaitTime= + + Port= + PORTNUMBER - - + + Tells the server to listen to this specified port. + If not specified PORTNUMBER defaults to 13666. + + + + + + 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). + + + + + + ReportToSyslog= + + + no + yes + + + + + Should we report to syslog instead of stderr? + Default value is no. + + + + + + WaitTime= + SECONDS + + Sets the default time in seconds to display a screen. - - + If not specified the default value for SECONDS is 4. + - User= + + User= + USER - User to run as. LCDd will drop its root privileges, - if any, and run as this user instead. Defaults to User=nobody. + User to run as. When started as root LCDd will drop its privileges, + and run as this user instead. Defaults to nobody. + - ServerScreen= + + ServerScreen= + + + yes + no + + - - - Enables the server screen even when other screens are active. Defaults to - no. - - + + 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. + - Foreground= - - + + Foreground= + + + no + yes + + + + The server will stay in the foreground if set to true. Otherwise the server will fork to background and report - to syslog. Defaults to yes. - - + to syslog. Defaults to no. + - @@ -202,50 +230,54 @@ don't go to any client. - - ToggleRotateKey= - - + + ToggleRotateKey= + KEY + + Defaults to Enter. - - + - PrevScreenKey= - - + + PrevScreenKey= + KEY + + Defaults to Left. - - + - NextScreenKey= - - + + NextScreenKey= + KEY + + Defaults to Right. - - + - ScrollUpKey= - - + + ScrollUpKey= + KEY + + Defaults to Up. - - + - ScrollDownKey= - - + + ScrollDownKey= + KEY + + Defaults to Down. - - + @@ -307,97 +339,98 @@ input "events". Forward (Go to next screen) Right - -MenuKey -Open main menu -Exit/Cancel - --> -The menu is an LCDproc client built into rLCDd. -You can configure what keys the menu should use. Note that the MenuKey -will be reserved exclusively, the others work in shared mode. +The menu is an LCDproc client built into LCDd. +You can configure what keys the menu should use. +Note that the MenuKey will be reserved exclusively, +while the others work in shared mode. + + + MenuKey= + KEY + + + The key that switches into menu mode (=open the main menu). + In menu mode it cancels any operation. Cancelling the main menu + means returning to the regular display mode. + It defaults to Menu. + + - - MenuKey= - - - The key that switches into menu mode (=opens the main menu). - In menu mode it cancels any operation. Cancelling the main menu - means returning to the regular display mode. - It defaults to Escape. - - - + + + EnterKey= + KEY + + + The key to enter a sub menu and/or, to select an entry. + It defaults to Enter. + + - - EnterKey= - - - The key to enter a sub menu and/or, to select an entry. - It defaults to Enter. - - - + + + UpKey= + KEY + + + The key to move to the previous menu item. + If the LeftKey is not set, + it is also used to move left in input fields. + It default to Up. + + - - UpKey= - - - The key to move to the previous menu item. - If the LeftKey is not set, - it is also used to move left in input fields. - It default to Up. - - - + + + DownKey= + KEY + + + The key to move to the next menu item. + If the RightKey is not set, + it is also used to move right in input fields. + It default to Down. + + - - DownKey= - - - The key to move to the next menu item. - If the RightKey is not set, - it is also used to move right in input fields. - It default to Down. - - - - - - LeftKey= - - - If defined, this optional key is used to - to move left in input fields and to select submenu entries. - It is not set by default, but if you have more than 4 keys, - a natural candidate is Left. - - - - - - RightKey= - - - If defined, this optional key is used to to move right in input fields. - It is not set by default, but if you have more than 4 keys, - a natural candidate is Right. - - - + + + LeftKey= + KEY + + + If defined, this optional key is used to + to move left in input fields and to select submenu entries. + It is not set by default, but if you have more than 4 keys, + a natural candidate is Left. + + + + + RightKey= + KEY + + + If defined, this optional key is used to to move right in input fields. + It is not set by default, but if you have more than 4 keys, + a natural candidate is Right. + + + <filename>LCDd.conf</filename>: The Driver Section @@ -407,14 +440,17 @@ As mentioned earlier, each driver has its own section in the -The settings are more or less self-explanatory. So, read through the -section of your driver and change everything neccessary. +Although the settings are more or less self-explanatory, +they are explained in the next chapter in the section for each driver. +So, read through the section of your driver and changei +everything neccessary. + The LCDproc Init Scripts diff --git a/docs/lcdproc-user/drivers/lcdm001.docbook b/docs/lcdproc-user/drivers/lcdm001.docbook index 6bca295..8fd7702 100644 --- a/docs/lcdproc-user/drivers/lcdm001.docbook +++ b/docs/lcdproc-user/drivers/lcdm001.docbook @@ -26,19 +26,19 @@ lcdm001 chipset. - PauseKey=LeftKey + PauseKey= KEY - BackKey=UpKey + BackKey= KEY - ForwardKey=DownKey + ForwardKey= KEY - MainMenuKey=RightKey + MainMenuKey= KEY diff --git a/docs/lcdproc-user/drivers/lircin.docbook b/docs/lcdproc-user/drivers/lircin.docbook index 3b4e69b..cfc4633 100644 --- a/docs/lcdproc-user/drivers/lircin.docbook +++ b/docs/lcdproc-user/drivers/lircin.docbook @@ -69,47 +69,6 @@ Then you have to modify the [lirc] section of your LCDd.conf. - -<filename>LCDd.conf</filename>: The [lirc] Section - - -The [lirc] section of the LCDd.conf contains the -settings for the lirc LCDproc driver. - - - - -lircrc= - - -Normally all LIRC clients scan the file ~/.lircrc. -However, you might want to have a separate file to configure the -LCDproc lirc driver only. - - -This option enables you to specify the file you want the lirc -driver to scan. - - - - -prog= - - -All LIRC keys are assigned to a program using the prog=... option -in the ~/.lircrc (or the file you have specified -with lircrc=...). - - -The prog=... line must be the same as in your ~/.lircrc -(or the file you have specified with lircrc=...). - - - - - - - @@ -143,8 +102,8 @@ The prog=... line must be the same as in your ~/.lircrc - All LIRC keys are assigned to a program using the prog=... option - in the lirc configuration file. + All LIRC keys are assigned to a program using the prog=... + directive in the lirc configuration file. PROGRAM must be the same as in iyour lirc @@ -175,7 +134,7 @@ lines to the file: -<filename>~/.lircrc</filename>: Specify the associations from buttons to keysi +<title><filename>~/.lircrc</filename>: Specify the associations from buttons to keys for the lirc driver