diff --git a/docs/lcdproc-user/configuration.docbook b/docs/lcdproc-user/configuration.docbook index ce1908f..465fbd5 100644 --- a/docs/lcdproc-user/configuration.docbook +++ b/docs/lcdproc-user/configuration.docbook @@ -89,121 +89,179 @@ settings for the LCDproc server LCDd. + -Driver= - - -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. - - - - - -Bind= - - -Tells the server to bind to the given interface. Default to Bind=127.0.0.1 which -is actually the safest variant. - - - - -Port= - - -Tells the server to listen to this specified port; defaults to 13666. - - + Driver= + + + 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. + + + -ReportLevel= - - -Sets the reporting level; defaults to 2 (warnings and errors only). - - + Bind= + + + Tells the server to bind to the given interface. Default to Bind=127.0.0.1 which + is actually the safest variant. + + -ReportToSyslog= - - -Should we report to syslog instead of stderr ? Defaults to no. - - + Port= + + + Tells the server to listen to this specified port; defaults to 13666. + + -WaitTime= - - - -Sets the default time in seconds to display a screen. - - + ReportLevel= + + + Sets the reporting level; defaults to 2 (warnings and errors only). + + -User= - - - -User to run as. LCDd will drop its root privileges, -if any, and run as this user instead. Defaults to User=nobody. - - - -If you want to use the server menu, to shutdown or reboot your system, - you will have to set this to root. Otherwise LCDd does not have the - privileges to run commands like init 6. - - - + ReportToSyslog= + + + Should we report to syslog instead of stderr ? Defaults to no. + + -ServerScreen= - - - -Enables the server screen even when other screens are active. Defaults to -no. - - + WaitTime= + + + + Sets the default time in seconds to display a screen. + + -Foreground= - - -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. - - + User= + + + + User to run as. LCDd will drop its root privileges, + if any, and run as this user instead. Defaults to User=nobody. + + + + If you want to use the server menu, to shutdown or reboot your system, + you will have to set this to root. Otherwise LCDd does not have the + privileges to run commands like init 6. + + + + + ServerScreen= + + + + Enables the server screen even when other screens are active. Defaults to + no. + + + + + + Foreground= + + + 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. + + + + + + + + +The "...Key=" lines define what the server does with keypresses that +don't go to any client. + + + + + + ToggleRotateKey= + + + Defaults to Enter. + + + + + + PrevScreenKey= + + + Defaults to Left. + + + + + + NextScreenKey= + + + Defaults to Right. + + + + + + ScrollUpKey= + + + Defaults to Up. + + + + + + ScrollDownKey= + + + Defaults to Down. + + + - -<filename>LCDd.conf</filename>: The [input] Section + +<filename>LCDd.conf</filename>: The [menu] Section -The [input] section enables you to set some general ("global") +The [menu] section enables you to set some general ("global") options related to the way LCDd handles input "events". + -The Free*Key Options are interesting for those users whose keypad (or other input source) -has got only four (or less) keys. In this case LCDd would normally use all those -keys to enable you to control the server menu and the other server functions (like -switching to the next screen). If these keys are used by a client to do anything -but noticing that the user has e.g. entered the menu or switched to another screen, -this will probably cause trouble, as one keypress has several effects at the same -time. - - -The Free*Key options enable you to influence this behaviour. +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. - - FreePauseKey= - - - If set to yes, this prevents LCDd from handling the PauseKey itself. - Then a client can request the key 'A' and handle it. - - - - - FreeBackKey= - - - If set to yes, this prevents LCDd from handling the BackKey itself. - Then a client can request the key 'B' and handle it. - - - - - FreeForwardKey= - - - If set to yes, this prevents LCDd from handling the ForwardKey itself. - Then a client can request the key 'C' and handle it. - - - - - FreeMainMenuKey= - - - If set to yes, this prevents LCDd from handling the MainMenuKey itself. - Then a client can request the key 'D' and handle it. - - - - Even if you "free" the above keys, you can still use the menu - provided you set FreeMainMenuKey to no. - - - - - - + + 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= + + + The key to enter a sub menu and/or, to select an entry. + It defaults to Enter. + + + + + + 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= + + + 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. + + + + + @@ -393,7 +476,7 @@ sources distribution). # Set SCREENS to the screens you want lcdproc to send to LCDd # lcdproc --help will give you a list of the screens available -SCREENS="C X" +SCREENS="C L" diff --git a/docs/lcdproc-user/drivers/CwLnx.docbook b/docs/lcdproc-user/drivers/CwLnx.docbook index 473ffa9..872a328 100644 --- a/docs/lcdproc-user/drivers/CwLnx.docbook +++ b/docs/lcdproc-user/drivers/CwLnx.docbook @@ -2,10 +2,43 @@ The CwLnx Driver -This section talks about using LCDproc with LCD displays that use the -CwLnx chipset. +This section talks about using LCDproc with the serial / USB LCDs CW12232 +by CwLinux. + +Features + + +The CwLinux CW12232 LCDs are graphical LCDs with 122 x 32 dots +that also have a text mode with 20 x 4 characters. +The modules can be ordered bare or as part of a kit mounted +on brackets that fit in half-height 5.25" drive bays. +The mounting brackets optionally feature a 6 button keypad that +makes use of the keypad connector on the display modules. + + + +The kits allow to programmatically switch on/off their backlight. +Newer revisions of the kits also have programmable brighness as well +as 4 general purpose IO ports. + + + +The CW12232 come in 2 variants that differ how they communicate with the host: +The serial modules are connected to the PC using a serial RS232 connection getting +operating power using the standard floppy drive power connector, +while the USB modules only require an USB connection. + + + +For more information see the +CwLinux web site + + + + + Configuration in LCDd.conf diff --git a/docs/lcdproc-user/running.docbook b/docs/lcdproc-user/running.docbook index 855471b..8e43255 100644 --- a/docs/lcdproc-user/running.docbook +++ b/docs/lcdproc-user/running.docbook @@ -48,30 +48,31 @@ running LCDd from the source directory, e.g. after building. Running LCDd -h gives you an overview of the currently available -command line options, including a list of the compiled in drivers. +command line options. <command>LCDd -h</command> ] where are: - -h Display this help screen - -c Use a configuration file other than /etc/LCDd.conf - -d Add a driver to use (overrides drivers in config file) [curses] - -f Run in the foreground - -a Network (IP) address to bind to [127.0.0.1] - -p Network port to listen for connections on [13666] - -u User to run as [nobody] - -w Time to pause at each screen (in seconds) [4] - -s If set, reporting will be done using syslog - -r Report level [2] - -i Whether to rotate the server info screen + -h Display this help screen + -c Use a configuration file other than /etc/lcdproc/LCDd.conf + -d Add a driver to use (overrides drivers in config file) [curses] + -f Run in the foreground + -a Network (IP) address to bind to [127.0.0.1] + -p Network port to listen for connections on [13666] + -u User to run as [nobody] + -w Time to pause at each screen (in seconds) [4] + -s If set, reporting will be done using syslog + -r Report level [2] + -i Whether to rotate the server info screen ]]> @@ -101,31 +102,36 @@ command line options. <command>lcdproc -h</command> ] [ ...] +lcdproc - LCDproc system status information viewer + +Copyright (c) 1999-2006 Scott Scriven, William Ferrell, and misc. contributors. +This program is released under the terms of the GNU General Public License. + +Usage: lcdproc [] [ ...] where are - -s connect to LCDd daemon on - -p connect to LCDd daemon using - -f run in foreground - -e slow down initial announcement of modes (in 1/100s) - -c use a configuration file other than /etc/lcdproc.conf - -h show this help screen - -v display program version - and are - C CPU detailed CPU usage - P SMP-CPU CPU usage overview (one line per CPU) - G CPUGraph CPU usage histogram - L Load load histogram - M Memory memory & swap usage - S ProcSize biggest processes size - D Disk disk usage - I Iface network interface usage - B Battery battery status - T TimeDate time & date information - O OldTime old time screen - U Uptime uptime screen - K BigClock big clock - N MiniClock minimal clock - A About credits page + -s connect to LCDd daemon on + -p connect to LCDd daemon using + -f run in foreground + -e slow down initial announcement of screens (in 1/100s) + -c use a configuration file other than /etc/lcdproc/lcdproc.conf + -h show this help screen + -v display program version + and are + C CPU detailed CPU usage + P SMP-CPU CPU usage overview (one line per CPU) + G CPUGraph CPU usage histogram + L Load load histogram + M Memory memory & swap usage + S ProcSize biggest processes size + D Disk filling level of mounted file systems + I Iface network interface usage + B Battery battery status + T TimeDate time & date information + O OldTime old time screen + U Uptime uptime screen + K BigClock big clock + N MiniClock minimal clock + A About credits page Example: lcdproc -s my.lcdproc.server.com -p 13666 C M X