diff --git a/docs/lcdproc-user/Makefile.am b/docs/lcdproc-user/Makefile.am index 6756600..9b09847 100644 --- a/docs/lcdproc-user/Makefile.am +++ b/docs/lcdproc-user/Makefile.am @@ -11,6 +11,7 @@ EXTRA_DIST = bookinfo.docbook \ introduction.docbook \ lcdproc-user.docbook \ license.docbook \ + parameters.ent \ running.docbook \ README.docbook diff --git a/docs/lcdproc-user/configuration.docbook b/docs/lcdproc-user/configuration.docbook index 6346338..9a7126b 100644 --- a/docs/lcdproc-user/configuration.docbook +++ b/docs/lcdproc-user/configuration.docbook @@ -228,11 +228,7 @@ settings for the LCDproc server LCDd. - ReportToSyslog = - { - no | - yes - } + ReportToSyslog = ¶meters.yesnodef; @@ -276,11 +272,7 @@ settings for the LCDproc server LCDd. - Foreground = - { - no | - yes - } + Foreground = ¶meters.yesnodef; diff --git a/docs/lcdproc-user/drivers/CFontz.docbook b/docs/lcdproc-user/drivers/CFontz.docbook index 2bba994..747ddf6 100644 --- a/docs/lcdproc-user/drivers/CFontz.docbook +++ b/docs/lcdproc-user/drivers/CFontz.docbook @@ -15,8 +15,8 @@ CFA632 and CFA634 series by CrystalFontz, Inc. - Device = - DEVICE + Device = + DEVICE Select the serial output device to use. @@ -26,12 +26,7 @@ CFA632 and CFA634 series by CrystalFontz, Inc. - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; Set the LCD's dimensions in terms of characters per line and lines. @@ -41,8 +36,8 @@ CFA632 and CFA634 series by CrystalFontz, Inc. - Contrast = - CONTRAST + Contrast = + CONTRAST Set the initial contrast. @@ -54,8 +49,8 @@ CFA632 and CFA634 series by CrystalFontz, Inc. - Brightness = - BRIGHTNESS + Brightness = + BRIGHTNESS Set the initial brightness. @@ -67,8 +62,8 @@ CFA632 and CFA634 series by CrystalFontz, Inc. - OffBrightness = - BRIGHTNESS + OffBrightness = + BRIGHTNESS Set the initial off-brightness. @@ -82,16 +77,14 @@ CFA632 and CFA634 series by CrystalFontz, Inc. - Speed = - - - 1200 - 2400 - 9600 - 19200 - 115200 - - + Speed = + { + 1200 | + 2400 | + 9600 | + 19200 | + 115200 | + } Set the the baud rate to use when communicating with the LCD. @@ -101,13 +94,7 @@ CFA632 and CFA634 series by CrystalFontz, Inc. - NewFirmware = - - - yes - no - - + NewFirmware = ¶meters.yesnodef; Set the firmware version (New means >= 2.0) [default: no; legal: yes, no] @@ -116,13 +103,7 @@ CFA632 and CFA634 series by CrystalFontz, Inc. - Reboot = - - - yes - no - - + Reboot = ¶meters.yesnodef; Reinitialize the LCD's BIOS [default: no; legal: yes, no] diff --git a/docs/lcdproc-user/drivers/CFontz633.docbook b/docs/lcdproc-user/drivers/CFontz633.docbook index eb2d132..d8abd1e 100644 --- a/docs/lcdproc-user/drivers/CFontz633.docbook +++ b/docs/lcdproc-user/drivers/CFontz633.docbook @@ -16,8 +16,8 @@ CFontz633 chipset. - Device = - DEVICE + Device = + DEVICE Select the output device to use [default: /dev/lcd] @@ -28,12 +28,7 @@ CFontz633 chipset. - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; Select the LCD type (size) [default: 16x2] @@ -42,8 +37,8 @@ CFontz633 chipset. - Contrast = - CONTRAST + Contrast = + CONTRAST Set the initial contrast. @@ -54,8 +49,8 @@ CFontz633 chipset. - Brightness = - BRIGHTNESS + Brightness = + BRIGHTNESS Set the initial brightness [default: 1000; legal: 0 - 1000] @@ -64,8 +59,8 @@ CFontz633 chipset. - OffBrightness = - BRIGHTNESS + OffBrightness = + BRIGHTNESS Set the initial off-brightness [default: 0; legal: 0 - 1000] @@ -76,16 +71,14 @@ CFontz633 chipset. - Speed = - - - 1200 - 2400 - 9600 - 19200 - 115200 - - + Speed = + { + 1200 | + 2400 | + 9600 | + 19200 | + 115200 + } Set the the baud rate for communication with the LCD. @@ -95,13 +88,7 @@ CFontz633 chipset. - NewFirmware = - - - yes - no - - + NewFirmware = ¶meters.yesnodef; Set the firmware version (New means >= 2.0) [default: no; legal: yes, no] @@ -111,13 +98,7 @@ CFontz633 chipset. - Reboot = - - - yes - no - - + Reboot = ¶meters.yesnodef; Reinitialize the LCD's BIOS [default: no; legal: yes, no] diff --git a/docs/lcdproc-user/drivers/CFontzPacket.docbook b/docs/lcdproc-user/drivers/CFontzPacket.docbook index e87aa25..af925fa 100644 --- a/docs/lcdproc-user/drivers/CFontzPacket.docbook +++ b/docs/lcdproc-user/drivers/CFontzPacket.docbook @@ -62,14 +62,12 @@ Currently this line of modules comprises the models: - Model = - - - 631 - 633 - 635 - - + Model = + { + 631 | + 633 | + 635 + } Select the LCD model that is connected. @@ -81,8 +79,8 @@ Currently this line of modules comprises the models: - Device = - DEVICE + Device = + DEVICE @@ -101,12 +99,7 @@ Currently this line of modules comprises the models: - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; Select the LCD size [default: depending on model: 635: 20x4, @@ -117,8 +110,8 @@ Currently this line of modules comprises the models: - Contrast = - CONTRAST + Contrast = + CONTRAST Set the initial contrast. @@ -129,8 +122,8 @@ Currently this line of modules comprises the models: - Brightness = - BRIGHTNESS + Brightness = + BRIGHTNESS Set the initial brightness [default: 1000; legal: 0 - 1000] @@ -139,8 +132,8 @@ Currently this line of modules comprises the models: - OffBrightness = - BRIGHTNESS + OffBrightness = + BRIGHTNESS Set the initial off-brightness [default: 0; legal: 0 - 1000] @@ -151,16 +144,14 @@ Currently this line of modules comprises the models: - Speed = - - - 1200 - 2400 - 9600 - 19200 - 115200 - - + Speed = + { + 1200 | + 2400 | + 9600 | + 19200 | + 115200 + } Set the the baud rate for communication with the LCD. @@ -171,13 +162,7 @@ Currently this line of modules comprises the models: - NewFirmware = - - - yes - no - - + NewFirmware = ¶meters.yesnodef; Set the firmware version (New means >= 2.0) [default: no; legal: yes, no] @@ -187,13 +172,7 @@ Currently this line of modules comprises the models: - Reboot = - - - yes - no - - + Reboot = ¶meters.yesnodef; Reinitialize the LCD's BIOS [default: no; legal: yes, no] diff --git a/docs/lcdproc-user/drivers/CwLnx.docbook b/docs/lcdproc-user/drivers/CwLnx.docbook index 3a1b781..dbbc30e 100644 --- a/docs/lcdproc-user/drivers/CwLnx.docbook +++ b/docs/lcdproc-user/drivers/CwLnx.docbook @@ -13,7 +13,7 @@ and CW1602 by CwLinux. The CwLinux CW12232 LCDs are graphical LCDs with 122 x 32 dots that also have a text mode with 20 x 4 characters, the CW12832 are graphical displays with 128 x 32 dots and a -21 x 4 character text mode, +21 x 4 character text mode, the CW1602 LCDs are character LCDs that are 16 characters wide and 2 lines high. @@ -40,7 +40,7 @@ power connector, while the USB modules only require an USB connection. -For more information see the +For more information see the CwLinux web site @@ -57,14 +57,12 @@ For more information see the - Model = - - - 12232 - 12832 - 1602 - - + Model = + { + 12232 | + 12832 | + 1602 + } Select the LCD model [default: 12232; @@ -74,8 +72,8 @@ For more information see the - Device = - DEVICE + Device = + DEVICE Select the output device to use [default: /dev/lcd] @@ -85,12 +83,7 @@ For more information see the - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; Select the LCD size [default: depending on model: 12232: 20x4, @@ -101,13 +94,11 @@ For more information see the - Speed = - - - 9600 - 19200 - - + Speed = + { + 9600 | + 19200 + } Set the the baud rate for communication with the LCD. @@ -117,13 +108,7 @@ For more information see the - Reboot = - - - yes - no - - + Reboot = ¶meters.yesnodef; Reinitialize the LCD's BIOS [default: no; legal: yes, no] @@ -133,13 +118,7 @@ For more information see the - Keypad = - - - yes - no - - + Keypad = ¶meters.yesnodef; Tells if you have a keypad connected. Keypad layout is currently not @@ -149,28 +128,28 @@ For more information see the - KeyMap_A = - KEY + KeyMap_A = + KEY - KeyMap_B = - KEY + KeyMap_B = + KEY - KeyMap_C = - KEY + KeyMap_C = + KEY - KeyMap_D = - KEY + KeyMap_D = + KEY - KeyMap_E = - KEY + KeyMap_E = + KEY - KeyMap_F = - KEY + KeyMap_F = + KEY If you have a non standard keypad you can associate any keystrings to keys. @@ -223,13 +202,7 @@ For more information see the - keypad_test_mode = - - - yes - no - - + keypad_test_mode = ¶meters.yesnodef; keypad_test_mode permit to test keypad assignment diff --git a/docs/lcdproc-user/drivers/IOWarrior.docbook b/docs/lcdproc-user/drivers/IOWarrior.docbook index 443cf57..b1ee130 100644 --- a/docs/lcdproc-user/drivers/IOWarrior.docbook +++ b/docs/lcdproc-user/drivers/IOWarrior.docbook @@ -119,12 +119,7 @@ as well as Darwin/MacOS X. - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; Set the display dimensions. If not given, it defaults to 20x4. @@ -133,8 +128,8 @@ as well as Darwin/MacOS X. - SerialNumber = - SERIALNO + SerialNumber = + SERIALNO Use the IOWarrior module with the serial number SERIALNO. @@ -144,13 +139,7 @@ as well as Darwin/MacOS X. - ExtendedMode = - - - yes - no - - + ExtendedMode = ¶meters.yesnodef; If you have a KS0073 or an other 'almost HD44780-compatible' display @@ -161,13 +150,7 @@ as well as Darwin/MacOS X. - Lastline = - - - yes - no - - + Lastline = ¶meters.yesdefno; Specifies if the last line is pixel addressable or it controls an diff --git a/docs/lcdproc-user/drivers/MD8800.docbook b/docs/lcdproc-user/drivers/MD8800.docbook index 78440e7..4f4bca1 100644 --- a/docs/lcdproc-user/drivers/MD8800.docbook +++ b/docs/lcdproc-user/drivers/MD8800.docbook @@ -25,8 +25,8 @@ You may find more information about the LCD on - Device = - DEVICE + Device = + DEVICE device to use [default: /dev/ttyS1] @@ -35,12 +35,7 @@ You may find more information about the LCD on - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; display size [default: 16x2] @@ -49,8 +44,8 @@ You may find more information about the LCD on - Brightness = - BRIGHTNESS + Brightness = + BRIGHTNESS Set the initial brightness [default: 1000; legal: 0 - 1000] @@ -59,8 +54,8 @@ You may find more information about the LCD on - OffBrightness = - BRIGHTNESS + OffBrightness = + BRIGHTNESS Set the initial off-brightness [default: 0; legal: 0 - 1000] diff --git a/docs/lcdproc-user/drivers/NoritakeVFD.docbook b/docs/lcdproc-user/drivers/NoritakeVFD.docbook index 6bb4d89..5d6a1fc 100644 --- a/docs/lcdproc-user/drivers/NoritakeVFD.docbook +++ b/docs/lcdproc-user/drivers/NoritakeVFD.docbook @@ -16,8 +16,8 @@ This section talks about using LCDproc with text mode VFD displays from - Device = - DEVICE + Device = + DEVICE Port where the VFD is. Usual values are /dev/ttyS0 and /dev/ttyS1 @@ -27,12 +27,7 @@ This section talks about using LCDproc with text mode VFD displays from - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; Specifies the size of the LCD. @@ -42,8 +37,8 @@ This section talks about using LCDproc with text mode VFD displays from - Brightness = - BRIGHTNESS + Brightness = + BRIGHTNESS Set the initial brightness [default: 1000; legal: 0 - 1000] @@ -52,8 +47,8 @@ This section talks about using LCDproc with text mode VFD displays from - OffBrightness = - BRIGHTNESS + OffBrightness = + BRIGHTNESS Set the initial off-brightness [default: 0; legal: 0 - 1000] @@ -64,16 +59,14 @@ This section talks about using LCDproc with text mode VFD displays from - Speed = - - - 1200 - 2400 - 9600 - 19200 - 115200 - - + Speed = + { + 1200 | + 2400 | + 9600 | + 19200 | + 115200 + } Set the the baud rate to use when communicating with the VFD. @@ -83,14 +76,12 @@ This section talks about using LCDproc with text mode VFD displays from - Parity = - - - 0 - 1 - 2 - - + Parity = + { + 0 | + 1 | + 2 + } Set the parity for communication with the device to even parity (2), @@ -101,13 +92,7 @@ This section talks about using LCDproc with text mode VFD displays from - Reboot = - - - yes - no - - + Reboot = ¶meters.yesnodef; Reinitialize the VFD [default: no; legal: yes, no] diff --git a/docs/lcdproc-user/drivers/bayrad.docbook b/docs/lcdproc-user/drivers/bayrad.docbook index 13827b8..1f08d40 100644 --- a/docs/lcdproc-user/drivers/bayrad.docbook +++ b/docs/lcdproc-user/drivers/bayrad.docbook @@ -38,8 +38,8 @@ For more information see the - Device = - DEVICE + Device = + DEVICE Select the serial output device to use. @@ -49,15 +49,13 @@ For more information see the - Speed = - - - 1200 - 2400 - 9600 - 19200 - - + Speed = + { + 1200 | + 2400 | + 9600 | + 19200 + } Set the the baud rate to use when communicating with the LCD. diff --git a/docs/lcdproc-user/drivers/curses.docbook b/docs/lcdproc-user/drivers/curses.docbook index f49a4fe..89d3a66 100644 --- a/docs/lcdproc-user/drivers/curses.docbook +++ b/docs/lcdproc-user/drivers/curses.docbook @@ -16,8 +16,8 @@ curses chipset. - Foreground = - COLOUR + Foreground = + COLOUR @@ -26,7 +26,7 @@ curses chipset. - Legal values for COLOUR are + Legal values for COLOUR are red, black, green, yellow, blue, magenta, @@ -37,8 +37,8 @@ curses chipset. - Background = - COLOUR + Background = + COLOUR @@ -47,16 +47,16 @@ curses chipset. - The legal values for COLOUR are - the same as for the Foreground setting. + The legal values for COLOUR are + the same as for the Foreground setting. - Backlight = - COLOUR + Backlight = + COLOUR @@ -65,20 +65,15 @@ curses chipset. - The legal values for COLOUR are - the same as for the Foreground setting. + The legal values for COLOUR are + the same as for the Foreground setting. - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; display size [default: 20x4] @@ -87,12 +82,12 @@ curses chipset. - TopLeftx = - X-OFFSET + TopLeftx = + X-OFFSET - TopLefty = - Y-OFFSET + TopLefty = + Y-OFFSET What position (X,Y) to start the left top corner at. @@ -102,29 +97,17 @@ curses chipset. - UseACS = - - - yes - no - - + UseACS = ¶meters.yesnodef; Tell whether to use ACS (alternative character set) symbols for icons and bars - instead of simple ASCII characters. + instead of simple ASCII characters. - DrawBorder = - - - yes - no - - + DrawBorder = ¶meters.yesdefno; Tell whether to draw a border around the screen. diff --git a/docs/lcdproc-user/drivers/ea65.docbook b/docs/lcdproc-user/drivers/ea65.docbook index 780dde8..250870c 100644 --- a/docs/lcdproc-user/drivers/ea65.docbook +++ b/docs/lcdproc-user/drivers/ea65.docbook @@ -2,31 +2,33 @@ The ea65 driver - This section describes the ea65 driver which works with the front panel - VFD display on the AOpen XC Cube-AV EA65 media barebone. +This section describes the ea65 driver which works with the front panel +VFD display on the AOpen XC Cube-AV EA65 media barebone. - EA65 front panel VFD - - The AOpen XC Cube-AV is a barebone designed for using as a media center. - It comes with a front panel display which is capable of displaying one line - of 9 characters. - - - The display is internally connected to the serial port - (/dev/ttyS1) with a fixed rate of 9600 baud. - - - The display uses 13 segments per character. That's why the driver provides - no custom characters like the ones for dot matrix displays do. - - - The front panel furthermore has 9 keys which are illuminated by blue LEDs. - The LEDs can be controlled with the backlight functions. The keys are not - supported by this driver. The red LED (RECORD) can be controlled with the - output command of LCDd. - +EA65 front panel VFD + + + The AOpen XC Cube-AV is a barebone designed for using as a media center. + It comes with a front panel display which is capable of displaying one line + of 9 characters. + + + The display is internally connected to the serial port + (/dev/ttyS1) with a fixed rate of 9600 baud. + + + The display uses 13 segments per character. That's why the driver provides + no custom characters like the ones for dot matrix displays do. + + + The front panel furthermore has 9 keys which are illuminated by blue LEDs. + The LEDs can be controlled with the backlight functions. The keys are not + supported by this driver. The red LED (RECORD) can be controlled with the + output command of LCDd. + + @@ -38,8 +40,8 @@ - Brightness = - BRIGHTNESS + Brightness = + BRIGHTNESS Set the brightness for the front LEDs if backlight is switched on. @@ -54,8 +56,8 @@ - OffBrightness = - OFFBRIGHTNESS + OffBrightness = + OFFBRIGHTNESS Set the brightness for the front LEDs if backlight is switched off. diff --git a/docs/lcdproc-user/drivers/eyeboxone.docbook b/docs/lcdproc-user/drivers/eyeboxone.docbook index b27b504..bebf19a 100644 --- a/docs/lcdproc-user/drivers/eyeboxone.docbook +++ b/docs/lcdproc-user/drivers/eyeboxone.docbook @@ -2,50 +2,59 @@ The Eyebox One Driver (EyeboxOne) - This section describes the Eyebox One. - +This section describes the Eyebox One. + - Eyebox One LCD Module - - Eyebox One is a small rackmounted server marketed by Rightvision - (). - This server has an LCD module, a keypad, two graphbars and some leds. - - - The LCD is a 20x4 alphanumeric module connected via standard DB-9 cabling and - connector. - - - I couldn't find any documentation about it. - All I know has been obtained with some reverse engineering. - It seems that it can run only at 19.200 baud. - Sending ASCII to the module will make it simply display that text at - its current cursor position. - The module has a built-in BIOS that recognizes commands (sent by transmitting a - single-byte "marker" signifying that a command is on the way, followed by - the single-byte command character itself along with any parameters, if needed) - allowing the programmer to clear the screen, position the cursor anywhere, - hide/show the cursor, on/off the backlight, and so on. - - - This module is fast. If updating less than the whole screen, the LCD can - update faster than can be seen by the human eye. This, of course, - more than meets LCDproc's needs. - - - - Eyebox One Driver and lcdproc client - - You can use the two Eyebox One graphbars, one as a free CPU meter, and one as a free RAM meter - with lcdproc client (see eyebox.c in lcdproc client sources). - - In order to use it, you must execute ./configure with a special parameter: - CPPFLAGS=-DLCDPROC_EYEBOXONE ./configure --enable-drivers=EyeboxOne - - This is only a BETA version modification, take it as a demo... - - +Eyebox One LCD Module + + + Eyebox One is a small rackmounted server marketed by Rightvision + (). + This server has an LCD module, a keypad, two graphbars and some leds. + + + The LCD is a 20x4 alphanumeric module connected via standard DB-9 cabling and + connector. + + + I couldn't find any documentation about it. + All I know has been obtained with some reverse engineering. + It seems that it can run only at 19.200 baud. + Sending ASCII to the module will make it simply display that text at + its current cursor position. + The module has a built-in BIOS that recognizes commands (sent by transmitting a + single-byte "marker" signifying that a command is on the way, followed by + the single-byte command character itself along with any parameters, if needed) + allowing the programmer to clear the screen, position the cursor anywhere, + hide/show the cursor, on/off the backlight, and so on. + + + This module is fast. If updating less than the whole screen, the LCD can + update faster than can be seen by the human eye. This, of course, + more than meets LCDproc's needs. + + + + + +Eyebox One Driver and lcdproc client + + You can use the two Eyebox One graphbars, one as a free CPU meter, and one as a free RAM meter + with lcdproc client (see eyebox.c in lcdproc client sources). + + + + In order to use it, you must execute ./configure with a special parameter: + CPPFLAGS=-DLCDPROC_EYEBOXONE ./configure --enable-drivers=EyeboxOne + + + +This is only a BETA version modification, take it as a demo... + + + + Copyright @@ -68,8 +77,8 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info) - Device = - DEVICE + Device = + DEVICE Select the output device to use [default: /dev/ttyS1] @@ -78,12 +87,7 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info) - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; Set the display size [default: 20x4] @@ -92,13 +96,7 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info) - Backlight = - - - yes - no - - + Backlight = ¶meters.yesdefno; Switch on the backlight? [default: yes; legal: yes, no] @@ -112,13 +110,7 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info) - Cursor = - - - yes - no - - + Cursor = ¶meters.yesnodef; Switch on the cursor? [default: no; legal: yes, no] @@ -128,15 +120,13 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info) - Speed = - - - 1200 - 2400 - 9600 - 19200 - - + Speed = + { + 1200 | + 2400 | + 9600 | + 19200 + } Set the the baud rate to use when communicating with the LCD. @@ -150,28 +140,28 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info) - LeftKey = - D + LeftKey = + D - RightKey = - C + RightKey = + C - UpKey = - A + UpKey = + A - DownKey = - B + DownKey = + B - EscapeKey = - P + EscapeKey = + P - EnterKey = - + EnterKey = + The following table translate from EyeboxOne Key to Logical Key. @@ -181,13 +171,7 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info) - keypad_test_mode = - - - yes - no - - + keypad_test_mode = ¶meters.yesnodef; You can find out which key of your display sends which diff --git a/docs/lcdproc-user/drivers/glcdlib.docbook b/docs/lcdproc-user/drivers/glcdlib.docbook index 9c82d54..ef2ffd1 100644 --- a/docs/lcdproc-user/drivers/glcdlib.docbook +++ b/docs/lcdproc-user/drivers/glcdlib.docbook @@ -39,9 +39,9 @@ before configuring the LCDproc build process --enable-drivers=glcdlib. - -Driver = - GRAPHLCD-DRIVER + + Driver = + GRAPHLCD-DRIVER Specify which graphical display supported by graphlcd-base to use. @@ -58,13 +58,7 @@ before configuring the LCDproc build process --enable-drivers=glcdlib. - UseFT2 = - - - yes - no - - + UseFT2 = ¶meters.yesdefno; Tell whether to use FreeType2 or not. @@ -79,12 +73,7 @@ before configuring the LCDproc build process --enable-drivers=glcdlib. - TextResolution = - - WIDTH - x - HEIGHT - + TextResolution = ¶meters.size; Give text resolution in fixed width characters. If it won't fit according @@ -96,8 +85,8 @@ before configuring the LCDproc build process --enable-drivers=glcdlib. - FontFile = - FILENAME + FontFile = + FILENAME Set path to font file to use, e.g. /usr/share/fonts/corefonts/courbd.ttf. @@ -106,14 +95,14 @@ before configuring the LCDproc build process --enable-drivers=glcdlib. -The following parameters only apply if UseFT2 = yes: +The following parameters only apply if UseFT2 = yes: - CharEncoding = - CHARSET + CharEncoding = + CHARSET Specify character encoding to use, e.g. iso8859-2. @@ -123,12 +112,12 @@ The following parameters only apply if UseFT2 = yes< - MinFontFaceSize = - + MinFontFaceSize = + COLUMNS x ROWS - + minimum size in pixels in which fonts should be rendered @@ -142,8 +131,8 @@ The following parameters only apply if UseFT2 = yes< Optional settings - Brightness = - BRIGHTNESS + Brightness = + BRIGHTNESS Brightness (in %) if applicable @@ -154,8 +143,8 @@ The following parameters only apply if UseFT2 = yes< - Contrast = - CONTRAST + Contrast = + CONTRAST Set the contrast (in %) if applicable. @@ -166,13 +155,7 @@ The following parameters only apply if UseFT2 = yes< - Backlight = - - - yes - no - - + Backlight = ¶meters.yesnodef; Backlight if applicable @@ -181,13 +164,7 @@ The following parameters only apply if UseFT2 = yes< - UpsideDown = - - - yes - no - - + UpsideDown = ¶meters.yesnodef; flip image upside down @@ -196,13 +173,7 @@ The following parameters only apply if UseFT2 = yes< - Invert = - - - yes - no - - + Invert = ¶meters.yesnodef; invert light/dark pixels @@ -211,13 +182,7 @@ The following parameters only apply if UseFT2 = yes< - ShowDebugFrame = - - - yes - no - - + ShowDebugFrame = ¶meters.yesnodef; turns on/off 1 pixel thick debugging @@ -229,13 +194,7 @@ The following parameters only apply if UseFT2 = yes< - ShowBigBorder = - - - yes - no - - + ShowBigBorder = ¶meters.yesnodef; border around the unused area @@ -244,13 +203,7 @@ The following parameters only apply if UseFT2 = yes< - ShowThinBorder = - - - yes - no - - + ShowThinBorder = ¶meters.yesnodef; border around the unused area @@ -259,12 +212,17 @@ The following parameters only apply if UseFT2 = yes< - PixelShiftX=0 + PixelShiftX = + SHIFTX - PixelShiftY=2 + PixelShiftY = + SHIFTY + Shifts the content of the display by SHIFTX + (default: 0) and SHIFTY + (default: 0) pixels. diff --git a/docs/lcdproc-user/drivers/glk.docbook b/docs/lcdproc-user/drivers/glk.docbook index 72f85ed..ef2f08d 100644 --- a/docs/lcdproc-user/drivers/glk.docbook +++ b/docs/lcdproc-user/drivers/glk.docbook @@ -16,8 +16,8 @@ Matrix Orbital GLK chipset. - Device = - DEVICE + Device = + DEVICE select the serial device to use [default: /dev/lcd] @@ -26,8 +26,8 @@ Matrix Orbital GLK chipset. - Contrast = - CONTRAST + Contrast = + CONTRAST Set the initial contrast. @@ -38,14 +38,12 @@ Matrix Orbital GLK chipset. - Speed = - - - 9600 - 19200 - 38400 - - + Speed = + { + 9600 | + 19200 | + 38400 + } Set the the baud rate for communication with the LCD. diff --git a/docs/lcdproc-user/drivers/hd44780.docbook b/docs/lcdproc-user/drivers/hd44780.docbook index a5d5150..78eea10 100644 --- a/docs/lcdproc-user/drivers/hd44780.docbook +++ b/docs/lcdproc-user/drivers/hd44780.docbook @@ -360,7 +360,7 @@ By default, the following keystrokes are generated by the different keys: You can change the mapping using the -KeyDirect_NUM +KeyDirect_NUM configuration option, where NUM is the subscript to the X in the table above. @@ -485,7 +485,7 @@ To be more precise, it assumes this mapping: This mapping can be changed using the -KeyMatrix_X_Y +KeyMatrix_X_Y configuration option, where X and Y are the subscripts to the respective axes above. @@ -720,9 +720,9 @@ This wiring is originally based on "lcdtext" (by Matthias Prinke). -The RW (pin 5) line of the display decides whether the display receives data from the -LPT port, or whether it sends data to the LPT port: if grounded it receives, if High or connected -to nothing at all it "sends" (i.e., will not work as intended). So, if you are not sure that +The RW (pin 5) line of the display decides whether the display receives data from the +LPT port, or whether it sends data to the LPT port: if grounded it receives, if High or connected +to nothing at all it "sends" (i.e., will not work as intended). So, if you are not sure that you need it otherwise, then connect it to GND. This certainly applies if you have only one display. @@ -1053,9 +1053,9 @@ This type of connection should work with winamp. -(*) on the RW line of the display: this line decides whether the display receives data from the -LPT port, or whether it sends data to the LPT port: if grounded it receives, if High or connected -to nothing at all it "sends" (i.e., will not work as intended). So, if you are not sure that +(*) on the RW line of the display: this line decides whether the display receives data from the +LPT port, or whether it sends data to the LPT port: if grounded it receives, if High or connected +to nothing at all it "sends" (i.e., will not work as intended). So, if you are not sure that you need it otherwise, then connect it to GND. This certainly applies if you have only one display. @@ -1315,9 +1315,9 @@ The LCD connections are: -(*) on the RW line of the display: this line decides whether the display receives data from the -LPT port, or whether it sends data to the LPT port: if grounded it receives, if High or connected -to nothing at all it "sends" (i.e., will not work as intended). So, if you are not sure that +(*) on the RW line of the display: this line decides whether the display receives data from the +LPT port, or whether it sends data to the LPT port: if grounded it receives, if High or connected +to nothing at all it "sends" (i.e., will not work as intended). So, if you are not sure that you need it otherwise, then connect it to GND. @@ -1915,7 +1915,7 @@ Please address Matteo Pillon for further information. The VDR-Wake module by Frank Jepsen is a serial IO extension module for the -famous Linux-based VDR that allows to connect an LCD to it and supports LCDproc. +famous Linux-based VDR that allows to connect an LCD to it and supports LCDproc. @@ -1932,7 +1932,7 @@ See The Pertelian X2040 includes an HD44780 display with enclosure and USB connection. -In order to work with LCDproc in Linux you need +In order to work with LCDproc in Linux you need the usbserial.ko and ftdi_sio.ko kernel modules loaded. The display will then be available on a serial port /dev/ttyUSBx. @@ -1954,7 +1954,7 @@ serial port /dev/ttyUSBx. The PIC-an-LCD module is also supported. It is not connected to the LPT port but to a serial port, which saves you from a lot of potential problems. To use it, specify the device to which you have connected the module in the -config file with the Device setting. +config file with the Device setting. The default is /dev/lcd. It does not support a keypad nor backlight switching. @@ -2147,7 +2147,7 @@ Refer to burning section in BWCT USB LCD module "bwctusb" -The BWCT USB LCD module, sold by Bernd Walter Computing Technology +The BWCT USB LCD module, sold by Bernd Walter Computing Technology () is a little board that can be piggy-packed to a HD44780 display and connects that to USB. @@ -2157,7 +2157,7 @@ The board, driven by the bwctusb connection type, does neither support a keypad for input, nor more than one single-controller display, nor does it allow setting the backlight or brightness. But you can set the display's contrast using software -(see the Contrast configuration parameter). +(see the Contrast configuration parameter). @@ -2165,7 +2165,7 @@ But you can set the display's contrast using software If there is more than one BWCT USB module connected to the system, -the SerialNumber configuration parameter allows +the SerialNumber configuration parameter allows selecting which display is used in LCDd. @@ -2187,7 +2187,7 @@ as well as dual controller displays (required for 4*27 and 4*40). It is based upon an Atmel AVR Mega8 CPU with a pure software implementation -of the USB protocol for the Atmel AVR microcontroller series. +of the USB protocol for the Atmel AVR microcontroller series. @@ -2199,7 +2199,7 @@ for your own interface e.g. for a graphic LCD. Two keys can be connected to the LCD2USB interface board. They can generate three key events that can be mapped to key names using -the DirectKey_1 to DirectKey_3 commands: +the DirectKey_1 to DirectKey_3 commands: one for each key and the third if the keys are pressed simultaneously. With this 3-key setup, menus can be used (see example below). @@ -2216,9 +2216,9 @@ or those developed by -The USS-720 USB-to-IEEE 1284 Bridge is a fully featured USB to parallel chip that is used -in most (but not all) Belkin F5U002 USB Parallel Printer Adapters. Because these adapters are -inexpensive and readily available on the second-hand market, they provide an excellent solution -for users who want to experiment with a parallel port but only have USB ports on their computers. +The USS-720 USB-to-IEEE 1284 Bridge is a fully featured USB to parallel chip that is used +in most (but not all) Belkin F5U002 USB Parallel Printer Adapters. Because these adapters are +inexpensive and readily available on the second-hand market, they provide an excellent solution +for users who want to experiment with a parallel port but only have USB ports on their computers. -Because the chip acts as a parallel port, the driver maintains the same features and wiring as -the 8-bit "winamp" driver. However, because most USB Parallel Printer Adapters use a centronics -printer connector, be sure to convert the pin numbering of the parallel port pins in the "winamp" -wiring to the pin numbering of the centronics port. Many tables are available on the internet +Because the chip acts as a parallel port, the driver maintains the same features and wiring as +the 8-bit "winamp" driver. However, because most USB Parallel Printer Adapters use a centronics +printer connector, be sure to convert the pin numbering of the parallel port pins in the "winamp" +wiring to the pin numbering of the centronics port. Many tables are available on the internet that illustrate how the pin numbering differs between the two. @@ -2280,15 +2280,15 @@ that illustrate how the pin numbering differs between the two. Special configuration options -Because several manufacturers used the USS720 chip in their USB Parallel Printer Adapters, the -VendorID and ProductID options are configurable in the +Because several manufacturers used the USS720 chip in their USB Parallel Printer Adapters, the +VendorID and ProductID options are configurable in the LCDd.conf file. -Not all Belkin F5U002 USB Parallel Printer Adapters used the USS720 chip. Look for the dark grey -adapters with the removable USB cable for best results. +Not all Belkin F5U002 USB Parallel Printer Adapters used the USS720 chip. Look for the dark grey +adapters with the removable USB cable for best results. @@ -2332,7 +2332,7 @@ port expander there (PCF8574P in this example). +-----|A1 | ___ Here: 0x00 | | | +---|___|--o 15 backlight === | | |c 10R - | |12 ___ b|/ + | |12 ___ b|/ |13 P7|-----|___|-----| -|INT | 1k |\ | | bc557 |e @@ -2354,7 +2354,7 @@ port expander there (PCF8574P in this example). -Configuration +Configuration HD44780: Configuration for I<superscript>2</superscript>C with port expander @@ -2374,15 +2374,15 @@ Keypad=no -The Device configuration setting denotes the device file +The Device configuration setting denotes the device file of your I2C bus (here /dev/i2c-0). You have to load the kernel standard module i2c-dev.ko and -the bus driver, but no I2C +the bus driver, but no I2C chip modules (e.g. pcf8574.ko)! -The Port config option contains the I2C +The Port config option contains the I2C address of the I2C port expander (here 0x20, the PCF8574 from the example above, with all address bits set to 0). @@ -2481,7 +2481,7 @@ is the wiring - instead of connecting the display directly to PC (via serial/par it is connected via ethernet and the communication is done over TCP connection. The main feature is - that to power and control the LCD is needed single UTP cable. To use the driver, specify the device IP address or hostname, on which the ethlcd device -is accessible by setting in config file the Device value. +is accessible by setting in config file the Device value. The default is ethlcd. @@ -2539,8 +2539,8 @@ This can be done by specifying or by inclu - Port = - PORT + Port = + PORT For parallel connections, specify the address of the parallel port the LCD is connected to. @@ -2552,8 +2552,8 @@ This can be done by specifying or by inclu - Device = - DEVICE + Device = + DEVICE If you are using a serial or I2C connection, @@ -2566,28 +2566,26 @@ This can be done by specifying or by inclu - ConnectionType = - - - 4bit - 8bit - winamp - serialLpt - picanlcd - lcdserializer - los-panel - vdr-lcd - vdr-wakeup - pertelian - bwctusb - lcd2usb - lis2 - mplay - i2c - ftdi - usblcd - - + ConnectionType = + { + 4bit | + 8bit | + winamp | + serialLpt | + picanlcd | + lcdserializer | + los-panel | + vdr-lcd | + vdr-wakeup | + pertelian | + bwctusb | + lcd2usb | + lis2 | + mplay | + i2c | + ftdi | + usblcd + } @@ -2602,7 +2600,7 @@ This can be done by specifying or by inclu - + 4bit 4bit Wiring to parallel port(default) @@ -2619,7 +2617,7 @@ This can be done by specifying or by inclu serialLpt Serial LPT Wiring - + picanlcd PIC-an-LCD serial device "picanlcd" @@ -2640,7 +2638,7 @@ This can be done by specifying or by inclu vdr-wakeup VDR-Wakeup module "vdr-wakeup" - + pertelian Pertelian X2040 LCD display () @@ -2669,7 +2667,7 @@ This can be done by specifying or by inclu usblcd USBLCD adapter from Adams IT Services () - + i2c LCD driven by PCF8574(A)/PCA9554(A) connected via I2C @@ -2692,8 +2690,8 @@ This can be done by specifying or by inclu - Speed = - BITRATE + Speed = + BITRATE For a serial connection, set to the serial port bitrate. To use @@ -2703,15 +2701,13 @@ This can be done by specifying or by inclu - CharMap = - - - hd44780_default - hd44780_euro - ea_ks0073 - sed12780f_0b - - + CharMap = + { + hd44780_default | + hd44780_euro | + ea_ks0073 | + sed12780f_0b + } Set the character mapping depending on the display you have: @@ -2719,21 +2715,21 @@ This can be done by specifying or by inclu The default, hd44780_default, is for "classic" HD44780 displays. - - + + hd44780_euro is for displays with a ROM mask supporting the european charset (ROM code A02). - - + + ea_ks0073 is the charmap for Electronic Assembly's KS0073 based displays. These devices have a richer charset, including many icons and many more characters of the ISO-8859-1 than standard HD44780s. - - - sed12780f_0b is for some SED 1278 displays. - - + + + sed12780f_0b is for some SED 1278 displays. + + You only need to set this parameter if you have a non-standard HD44780 display. @@ -2749,13 +2745,7 @@ This can be done by specifying or by inclu - Keypad = - - - yes - no - - + Keypad = ¶meters.yesnodef; Tell whether you have a keypad connected. @@ -2765,8 +2755,8 @@ This can be done by specifying or by inclu - Brightness = - BRIGHTNESS + Brightness = + BRIGHTNESS Set the initial brightness when the backlight is on @@ -2778,8 +2768,8 @@ This can be done by specifying or by inclu - OffBrightness = - BRIGHTNESS + OffBrightness = + BRIGHTNESS Set the initial off-brightness, i.e. the brightness when the backlight is off, @@ -2791,8 +2781,8 @@ This can be done by specifying or by inclu - Contrast = - CONTRAST + Contrast = + CONTRAST Set the initial contrast for the bwctusb and @@ -2808,13 +2798,7 @@ This can be done by specifying or by inclu - Backlight = - - - yes - no - - + Backlight = ¶meters.yesnodef; Specifiy if you have a switchable backlight. @@ -2823,13 +2807,7 @@ This can be done by specifying or by inclu - OutputPort = - - - yes - no - - + OutputPort = ¶meters.yesnodef; Tell if you have the additional output port ("bargraph") and you want to @@ -2839,29 +2817,18 @@ This can be done by specifying or by inclu - Lastline = - - - yes - no - - + Lastline = ¶meters.yesdefno; Specifies whether the lowest pixel line of a character is pixel addressable - or if it controls an underline effect. + or if it controls an underline effect. The default is yes, meaning a pixel addressable last pixel line. - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; Specifies the size of the LCD. @@ -2872,11 +2839,11 @@ This can be done by specifying or by inclu - vSpan = - + vSpan = + HEIGHT ,… - + The "vertical span" when using the driver with multi-controller displays @@ -2898,13 +2865,7 @@ This can be done by specifying or by inclu - ExtendedMode = - - - yes - no - - + ExtendedMode = ¶meters.yesnodef; If you have a KS0073 or an other 'almost HD44780-compatible', set this @@ -2914,8 +2875,8 @@ This can be done by specifying or by inclu - LineAddress = - ADDR + LineAddress = + ADDR If the next line of your display doesn't start 0x20 higher in @@ -2925,8 +2886,8 @@ This can be done by specifying or by inclu - DelayMult = - DELAY + DelayMult = + DELAY If your display is slow and cannot keep up with the flow of data from @@ -2938,13 +2899,7 @@ This can be done by specifying or by inclu - DelayBus = - - - yes - no - - + DelayBus = ¶meters.yesdefno; You can reduce the inserted delays by setting this to no. @@ -2955,8 +2910,8 @@ This can be done by specifying or by inclu - KeepAliveDisplay = - SECONDS + KeepAliveDisplay = + SECONDS Some displays (e.g. vdr-wakeup) need a message from the driver to @@ -2969,8 +2924,8 @@ This can be done by specifying or by inclu - RefreshDisplay = - SECONDS + RefreshDisplay = + SECONDS If you experience occasional garbage on your display you can use this @@ -2982,12 +2937,12 @@ This can be done by specifying or by inclu - KeyDirect_NUM = - KEY + KeyDirect_NUM = + KEY - KeyMatrix_X_Y = - KEY + KeyMatrix_X_Y = + KEY @@ -3008,36 +2963,36 @@ This can be done by specifying or by inclu - VendorID = - VENDORID + VendorID = + VENDORID - USB vendor ID to look for in certain USB connection types. - When using an FTDI chip with connection type ftdi, the default value is - 0x4003. - When using a USS720 chip with connection type uss720, the default value is + USB vendor ID to look for in certain USB connection types. + When using an FTDI chip with connection type ftdi, the default value is + 0x4003. + When using a USS720 chip with connection type uss720, the default value is 0x1293. - ProductID = - PRODUCTID + ProductID = + PRODUCTID - USB product ID to look for in certain USB connection types. - When using an FTDI chip with connection type ftdi, the default value is + USB product ID to look for in certain USB connection types. + When using an FTDI chip with connection type ftdi, the default value is 0x6001. - When using a USS720 chip with connection type uss720, the default value is + When using a USS720 chip with connection type uss720, the default value is 0x0002. - SerialNumber = - SERIALNO + SerialNumber = + SERIALNO Serial number of the USB device to look for with @@ -3052,36 +3007,6 @@ This can be done by specifying or by inclu - - - Miscellania diff --git a/docs/lcdproc-user/drivers/icp_a106.docbook b/docs/lcdproc-user/drivers/icp_a106.docbook index 1dfde75..dc17fb9 100644 --- a/docs/lcdproc-user/drivers/icp_a106.docbook +++ b/docs/lcdproc-user/drivers/icp_a106.docbook @@ -25,10 +25,11 @@ very nice. - Device = - DEVICE + Device = + DEVICE + Sets the device to use. Defaults to /dev/lcd. diff --git a/docs/lcdproc-user/drivers/imon.docbook b/docs/lcdproc-user/drivers/imon.docbook index eb675d5..f73d578 100644 --- a/docs/lcdproc-user/drivers/imon.docbook +++ b/docs/lcdproc-user/drivers/imon.docbook @@ -56,12 +56,7 @@ For further details, please consult the page and the forum at - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; Set the display size. The default 16x2 should be safe @@ -73,8 +68,8 @@ For further details, please consult the page and the forum at - Device = - DEVICE + Device = + DEVICE Select the output device to use. Change this from the default diff --git a/docs/lcdproc-user/drivers/imonlcd.docbook b/docs/lcdproc-user/drivers/imonlcd.docbook index 500600d..52f58f0 100644 --- a/docs/lcdproc-user/drivers/imonlcd.docbook +++ b/docs/lcdproc-user/drivers/imonlcd.docbook @@ -38,22 +38,20 @@ The 15c2:0038 device may require LIRC v0.8.5 or newer. - Protocol = - - PROTOCOL - + Protocol = + PROTOCOL Specify which version of iMON LCD is installed. The default, 0 specifies the :ffdc device. 1 should be used for the :0038 device. - - + + - OnExit = - ONEXIT + OnExit = + ONEXIT Specify the exit behavior. @@ -65,8 +63,8 @@ The 15c2:0038 device may require LIRC v0.8.5 or newer. - Device = - DEVICE + Device = + DEVICE Select the output device to use. Change this from the default @@ -78,8 +76,8 @@ The 15c2:0038 device may require LIRC v0.8.5 or newer. - Contrast = - CONTRAST + Contrast = + CONTRAST Select the display's contrast 200 is the default. @@ -89,12 +87,7 @@ The 15c2:0038 device may require LIRC v0.8.5 or newer. - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; Set the display size in pixels. The default 96x16 should @@ -105,8 +98,8 @@ The 15c2:0038 device may require LIRC v0.8.5 or newer. - Backlight = - BACKLIGHT + Backlight = + BACKLIGHT Set the backlight state. The default is 1, which turns @@ -116,8 +109,8 @@ The 15c2:0038 device may require LIRC v0.8.5 or newer. - DiscMode = - DISCMODE + DiscMode = + DISCMODE Sets the disc mode. The default is 0 which spins the diff --git a/docs/lcdproc-user/drivers/irman.docbook b/docs/lcdproc-user/drivers/irman.docbook index f3118ac..d817de9 100644 --- a/docs/lcdproc-user/drivers/irman.docbook +++ b/docs/lcdproc-user/drivers/irman.docbook @@ -68,8 +68,8 @@ The keys are mapped according to the following table: - Device = - DEVICE + Device = + DEVICE Select the input device to use, e.g. /dev/irman. @@ -78,8 +78,8 @@ The keys are mapped according to the following table: - Config = - FILENAME + Config = + FILENAME Select the IrMan configuration file to use, e.g. /etc/irman.cfg. diff --git a/docs/lcdproc-user/drivers/irtrans.docbook b/docs/lcdproc-user/drivers/irtrans.docbook index 70d5c93..8e8b280 100644 --- a/docs/lcdproc-user/drivers/irtrans.docbook +++ b/docs/lcdproc-user/drivers/irtrans.docbook @@ -13,7 +13,7 @@ devices, that are preinstalled in cases such as the Ahanix MCE303. The IRTrans VFD sports a vacuum fluorescent display with 16x2 characters that connects to the computer using USB. Although the device is shipped -with an IR remote control, LCDproc's driver currently only supports +with an IR remote control, LCDproc's driver currently only supports the display part of the device. @@ -34,24 +34,18 @@ from . - Backlight = - - - no - yes - - + Backlight = ¶meters.yesnodef; Tell whether te device has a backlight, or whether the backlight shall be used. - If not goven, it defaults to no. + If not goven, it defaults to no. - Hostname = - HOSTNAME_OR_IP-ADDRESS + Hostname = + HOSTNAME_OR_IP-ADDRESS Set the hostname or IP address of the IRTrans device to connect to. @@ -61,12 +55,7 @@ from . - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; Select the display size [default: 16x2] diff --git a/docs/lcdproc-user/drivers/joy.docbook b/docs/lcdproc-user/drivers/joy.docbook index f31f10d..4e87aa3 100644 --- a/docs/lcdproc-user/drivers/joy.docbook +++ b/docs/lcdproc-user/drivers/joy.docbook @@ -15,8 +15,8 @@ This section covers the joystick input driver for LCDd. - Device = - DEVICE + Device = + DEVICE Select the input device to use [default: /dev/js0] @@ -25,12 +25,12 @@ This section covers the joystick input driver for LCDd. - Map_AxisNUMneg = - KEY + Map_AxisNUMneg = + KEY - Map_AxisNUMpos = - KEY + Map_AxisNUMpos = + KEY @@ -46,7 +46,7 @@ This section covers the joystick input driver for LCDd. KEY can be one of the keys that LCDd recognizes - (Left, Right, Up, + (Left, Right, Up, Down, Enter or Escape) or any other string that a client can parse. @@ -55,8 +55,8 @@ This section covers the joystick input driver for LCDd. - Map_ButtonNUM = - KEY + Map_ButtonNUM = + KEY @@ -71,7 +71,7 @@ This section covers the joystick input driver for LCDd. KEY can be one of the keys that LCDd recognizes - (Left, Right, Up, + (Left, Right, Up, Down, Enter or Escape) or any other string that a client can parse. diff --git a/docs/lcdproc-user/drivers/lb216.docbook b/docs/lcdproc-user/drivers/lb216.docbook index 174f44b..448a2d1 100644 --- a/docs/lcdproc-user/drivers/lb216.docbook +++ b/docs/lcdproc-user/drivers/lb216.docbook @@ -35,8 +35,8 @@ made in australia :-) - Device = - DEVICE + Device = + DEVICE Select the output device to use [default: /dev/lcd] @@ -45,8 +45,8 @@ made in australia :-) - Brightness = - BRIGHTNESS + Brightness = + BRIGHTNESS Set the initial brightness [default: 255; legal: 0 - 255] @@ -55,13 +55,11 @@ made in australia :-) - Speed = - - - 2400 - 9600 - - + Speed = + { + 2400 | + 9600 + } Set the the baud rate to use when communicating with the LCD. @@ -71,13 +69,7 @@ made in australia :-) - Reboot = - - - yes - no - - + Reboot = ¶meters.yesnodef; Reinitialize the LCD's BIOS [default: no; legal: yes, no] diff --git a/docs/lcdproc-user/drivers/lcdm001.docbook b/docs/lcdproc-user/drivers/lcdm001.docbook index 46b6da9..330f31d 100644 --- a/docs/lcdproc-user/drivers/lcdm001.docbook +++ b/docs/lcdproc-user/drivers/lcdm001.docbook @@ -16,8 +16,8 @@ lcdm001 chipset. - Device = - DEVICE + Device = + DEVICE Default: /dev/lcd @@ -26,20 +26,20 @@ lcdm001 chipset. - PauseKey = - KEY + PauseKey = + KEY - BackKey = - KEY + BackKey = + KEY - ForwardKey = - KEY + ForwardKey = + KEY - MainMenuKey = - KEY + MainMenuKey = + KEY @@ -75,7 +75,7 @@ lcdm001 chipset. Open main menu Exit/Cancel - + diff --git a/docs/lcdproc-user/drivers/lcterm.docbook b/docs/lcdproc-user/drivers/lcterm.docbook index e3451b3..0fac62a 100644 --- a/docs/lcdproc-user/drivers/lcterm.docbook +++ b/docs/lcdproc-user/drivers/lcterm.docbook @@ -16,8 +16,8 @@ lcterm chipset. - Device = - DEVICE + Device = + DEVICE Default: /dev/lcd @@ -26,15 +26,10 @@ lcterm chipset. - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; - 16x2 + Default: 16x2. diff --git a/docs/lcdproc-user/drivers/lircin.docbook b/docs/lcdproc-user/drivers/lircin.docbook index d5b73a2..37887b2 100644 --- a/docs/lcdproc-user/drivers/lircin.docbook +++ b/docs/lcdproc-user/drivers/lircin.docbook @@ -81,14 +81,14 @@ Then you have to modify the [lirc] section of your - lircrc = - FILENAME + lircrc = + FILENAME Normally all LIRC clients scan the file ~/.lircrc. - However, you might want to have a separate file to configure the LCDproc lirc driver only. + 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. @@ -99,8 +99,8 @@ Then you have to modify the [lirc] section of your - Prog = - PROGRAM + Prog = + PROGRAM diff --git a/docs/lcdproc-user/drivers/lis.docbook b/docs/lcdproc-user/drivers/lis.docbook index c2d1a19..796278b 100644 --- a/docs/lcdproc-user/drivers/lis.docbook +++ b/docs/lcdproc-user/drivers/lis.docbook @@ -58,12 +58,7 @@ USB library. - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; Set the display size. The default 20x2 should be safe @@ -75,10 +70,8 @@ USB library. - VendorID = - - VENDORID - + VendorID = + VENDORID @@ -96,16 +89,14 @@ USB library. - ProductID = - - PRODUCTID - + ProductID = + PRODUCTID The USB Product ID of the device to use. If not given, it defaults to 0x6001 for a VLSystems L.I.S. MCE 2005 VFD - based on a FT232BL USB-to-RS232 converter by FTDI, which was produced + based on a FT232BL USB-to-RS232 converter by FTDI, which was produced before March 2007. @@ -117,12 +108,12 @@ USB library. - Brightness = - BRIGHTNESS + Brightness = + BRIGHTNESS - Set the initial brightness [default: 1000; + Set the initial brightness [default: 1000; legal: 0 - 1000. Values between 0 and 250 give 25% brightness, 251 to 500 give 50% brightness, 501 and 750, give 75% brightness, and values higher than 751 give 100% diff --git a/docs/lcdproc-user/drivers/ms6931.docbook b/docs/lcdproc-user/drivers/ms6931.docbook index 6493227..94c15ea 100644 --- a/docs/lcdproc-user/drivers/ms6931.docbook +++ b/docs/lcdproc-user/drivers/ms6931.docbook @@ -16,8 +16,8 @@ ms6931 chipset. - Device = - DEVICE + Device = + DEVICE device to use [default: /dev/ttyS1] @@ -26,12 +26,7 @@ ms6931 chipset. - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; display size [default: 16x2] diff --git a/docs/lcdproc-user/drivers/mtc_s16209x.docbook b/docs/lcdproc-user/drivers/mtc_s16209x.docbook index 9e5df0d..bb6f8f1 100644 --- a/docs/lcdproc-user/drivers/mtc_s16209x.docbook +++ b/docs/lcdproc-user/drivers/mtc_s16209x.docbook @@ -16,8 +16,8 @@ mtc_s16209x chipset. - Device = - DEVICE + Device = + DEVICE Select the output device to use [default: /dev/lcd] @@ -26,8 +26,8 @@ mtc_s16209x chipset. - Brightness = - BRIGHTNESS + Brightness = + BRIGHTNESS Set the initial brightness [default: 255; legal: 0 - 255] @@ -36,13 +36,7 @@ mtc_s16209x chipset. - Reboot = - - - yes - no - - + Reboot = ¶meters.yesnodef; Reinitialize the LCD's BIOS [default: no; legal: yes, no] diff --git a/docs/lcdproc-user/drivers/mtxorb.docbook b/docs/lcdproc-user/drivers/mtxorb.docbook index c20cba4..9d31667 100644 --- a/docs/lcdproc-user/drivers/mtxorb.docbook +++ b/docs/lcdproc-user/drivers/mtxorb.docbook @@ -233,8 +233,8 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne - Device = - DEVICE + Device = + DEVICE Select the output device to use [default: /dev/lcd] @@ -243,12 +243,7 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; Set the display size [default: 20x4] @@ -257,15 +252,13 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne - Type = - - - lcd - lkd - vfd - vkd - - + Type = + { + lcd | + lkd | + vfd | + vkd + } Set the display type [default: lcd; legal: lcd, @@ -277,8 +270,8 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne - Contrast = - CONTRAST + Contrast = + CONTRAST Set the initial contrast. @@ -294,13 +287,7 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne - hasAdjustableBacklight = - - - yes - no - - + hasAdjustableBacklight = ¶meters.yesdefno; Some old firmware versions of Matrix Orbital modules do not support an @@ -313,8 +300,8 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne - Brightness = - BRIGHTNESS + Brightness = + BRIGHTNESS Set the initial brightness [default: 1000; legal: 0 - 1000] @@ -323,8 +310,8 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne - OffBrightness = - BRIGHTNESS + OffBrightness = + BRIGHTNESS Set the initial off-brightness [default: 0; legal: 0 - 1000] @@ -335,15 +322,13 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne - Speed = - - - 1200 - 2400 - 9600 - 19200 - - + Speed = + { + 1200 | + 2400 | + 9600 | + 19200 + } Set the the baud rate to use when communicating with the LCD. @@ -353,8 +338,8 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne - KeyMap_LETTER = - KEY + KeyMap_LETTER = + KEY @@ -365,7 +350,7 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne These settings allow to map the letter LETTER, that is generated by the display when a key is pressed, to be mapped to - a key name KEY that LCDd + a key name KEY that LCDd can understand (see for more information). @@ -384,55 +369,13 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne KeyMap_E=Enter KeyMap_F=Escape - + - - - - - keypad_test_mode = - - - yes - no - - + keypad_test_mode = ¶meters.yesnodef; You can find out which key of your display sends which diff --git a/docs/lcdproc-user/drivers/mx5000.docbook b/docs/lcdproc-user/drivers/mx5000.docbook index c0c1d2e..092c4ae 100644 --- a/docs/lcdproc-user/drivers/mx5000.docbook +++ b/docs/lcdproc-user/drivers/mx5000.docbook @@ -24,8 +24,8 @@ This drivers uses the library from mx5000tools. - Device = - DEVICE + Device = + DEVICE Select the output device to use [default: /dev/hiddev0] @@ -34,8 +34,8 @@ This drivers uses the library from mx5000tools. - WaitAfterRefresh = - MS + WaitAfterRefresh = + MS Set the time (in ms) to wait after each screen sent to the keyboard. diff --git a/docs/lcdproc-user/drivers/picolcd.docbook b/docs/lcdproc-user/drivers/picolcd.docbook index 1a47cd0..bfae242 100644 --- a/docs/lcdproc-user/drivers/picolcd.docbook +++ b/docs/lcdproc-user/drivers/picolcd.docbook @@ -45,7 +45,7 @@ When pre-installed in enclosures like the Mini-Box M300 LCD - it comes equipped with an InfraRed receiver as well as key pad with + it comes equipped with an InfraRed receiver as well as key pad with 12 keys labeled Plus, Minus, F1, F2, F3, F4, F5, Up, @@ -57,7 +57,7 @@ Finally, the picoLCD 20x2 (OEM) supports 8 general purpose outputs and 10 custom splash screens. Although these features are not supported by this driver, the - splash screens can be changed using the usblcd + splash screens can be changed using the usblcd tool, that can be built from the Linux SDK available on the picoLCD web page. @@ -110,58 +110,44 @@ [picolcd] - - Brightness = - BRIGHTNESS + Brightness = + BRIGHTNESS Set the initial brightness. Legal values are: 0 - 1000. - If not given, it defaults to 1000. + If not given, it defaults to 1000. - Contrast = - CONTRAST + Contrast = + CONTRAST Contrast: 0-1000. 0 is visible, and 1000 is not on my M300. - Default is 1000. + Default is 1000. - KeyLights = - - - yes - no - - + KeyLights = ¶meters.yesdefno; Allow key LEDs to be turned on or off. Default is yes. @@ -170,118 +156,82 @@ - Key0Light = - - - yes - no - - + Key0Light = ¶meters.yesdefno; - If Keylights is set, you can disable the directional pad LED by + If Keylights is set, you can disable the directional pad LED by setting this value to no. Default is yes. - Key1Light = - - - yes - no - - + Key1Light = ¶meters.yesdefno; - If Keylights is set, you can disable the F1 LED by setting this value + If Keylights is set, you can disable the F1 LED by setting this value to no. Default is yes. - Key2Light = - - - yes - no - - + Key2Light = ¶meters.yesdefno; - If Keylights is set, you can disable the F2 LED by setting this value + If Keylights is set, you can disable the F2 LED by setting this value to no. Default is yes. - Key3Light = - - - yes - no - - + Key3Light = ¶meters.yesdefno; - If Keylights is set, you can disable the F3 LED by setting this value + If Keylights is set, you can disable the F3 LED by setting this value to no. Default is yes. - Key4Light = - - - yes - no - - + Key4Light = ¶meters.yesdefno; - If Keylights is set, you can disable the F4 LED by setting this value + If Keylights is set, you can disable the F4 LED by setting this value to no. Default is yes. - Key5Light = - - - yes - no - - + Key5Light = ¶meters.yesdefno; - If Keylights is set, you can disable the F5 LED by setting this value + If Keylights is set, you can disable the F5 LED by setting this value to no. Default is yes. - KeyTimeout = - DURATION + KeyTimeout = + DURATION - (Advanced) This value controls how long LCDd waits for a key press when + (Advanced) This value controls how long LCDd waits for a key press when get_key() is called. The value represents microseconds and the default is 500 - or .5 seconds. Lowering this value will make LCDd more responsive but also causes LCDd to use - more CPU time and, as the timeout grows shorter, key presses become harder to detect. - Larger values make key presses more reliable if somewhat slow to take effect. + or .5 seconds. Lowering this value will make LCDd more responsive but also causes LCDd to use + more CPU time and, as the timeout grows shorter, key presses become harder to detect. + Lparameterer values make key presses more reliable if somewhat slow to take effect. - LircHost = - HOSTNAME_OR_IP-ADDRESS + LircHost = + HOSTNAME_OR_IP-ADDRESS @@ -289,53 +239,53 @@ If not set or set to an empty value, IR support for LIRC will be disabled. - LIRC should be configured to use the driver "udp", which will cause it to listen on some - UDP port for packets containing a series of integers, representing pulse and mark - intervals from the sensor. It doesn't matter whether LCDd or LIRC is started first; if LIRC - isn't listening, the packets from LCDd will be discarded. When LIRC comes back, it will - start picking up the packets. Similarly, LCDd can be stopped and restarted without affecting - anything, because UDP is a connectionless protocol. + LIRC should be configured to use the driver "udp", which will cause it to listen on some + UDP port for packets containing a series of integers, representing pulse and mark + intervals from the sensor. It doesn't matter whether LCDd or LIRC is started first; if LIRC + isn't listening, the packets from LCDd will be discarded. When LIRC comes back, it will + start picking up the packets. Similarly, LCDd can be stopped and restarted without affecting + anything, because UDP is a connectionless protocol. - LircPort = - PORTNUM + LircPort = + PORTNUM This value determines the UDP port to which the driver will send IR data from the sensor. It - defaults to 8765, which is also the default port on which LIRC will listen. + defaults to 8765, which is also the default port on which LIRC will listen. - LircSync = - DURATION + LircSync = + DURATION - This value determines the length in jiffies (1/16384 seconds) of the synthesized sync pulse added - to the beginning of the UDP packet sent to LIRC. Values up to 255 are permitted. Setting a length - of zero will suppress the synthesized pulse (I can't make it work without it, though). The default is - 64 jiffies (3.9ms). + This value determines the length in jiffies (1/16384 seconds) of the synthesized sync pulse added + to the beginning of the UDP packet sent to LIRC. Values up to 255 are permitted. Setting a length + of zero will suppress the synthesized pulse (I can't make it work without it, though). The default is + 64 jiffies (3.9ms). - LircLength = - DURATION + LircLength = + DURATION - This value determines the length in jiffies (1/16384 seconds) of the entire LIRC code for a single remote - command. It depends on the notion that all commands are of the same duration, and are padded with a trailing + This value determines the length in jiffies (1/16384 seconds) of the entire LIRC code for a single remote + property. It depends on the notion that all propertys are of the same duration, and are padded with a trailing gap (space) to make up the time. No such gap is emitted by the picolcd hardware. Values up to MAXINT are permitted. Setting a length of zero will suppress the synthesized gap. The default is 2048 jiffies (125ms). @@ -351,13 +301,13 @@ picolcd driver status - The hardware also reports key-up events. Normally this would be of no issue (they are - usually a 0 or 'no key') except that when keys are used in combonation, the key-up - event may actually come back as multiple events depending on how the user released the - keys. If the key-up event for a multiple key press comes back as two events, the first - up event will actually look like a new key press. The algorithm in get_key tries to - deal with this in a sane way and toss out all key-up events for now. The hardware is - touchy and both combo key-down and key-up actions may be reported as mutiple events if + The hardware also reports key-up events. Normally this would be of no issue (they are + usually a 0 or 'no key') except that when keys are used in combonation, the key-up + event may actually come back as multiple events depending on how the user released the + keys. If the key-up event for a multiple key press comes back as two events, the first + up event will actually look like a new key press. The algorithm in get_key tries to + deal with this in a sane way and toss out all key-up events for now. The hardware is + touchy and both combo key-down and key-up actions may be reported as mutiple events if the user is more than a tenth of a second (maybe less?) off in motions. @@ -365,20 +315,20 @@ Infrared sensor status - LIRC expects sensor data that starts with a longish 'sync' space, denoting the start of - a command; followed by the code data, a sequence of mark/space pairs; sometimes followed by - a 'gap', which should be a space long enough to make the entire command up to a preset - duration in milliseconds. The 'sync' and the 'gap' are absent from the data - emitted by the picolcd hardware. I found that LIRC configuration files for remotes similar to the - ones I tested all used such a fixed-duration encoding, and as that was the only way I could get it - working, this driver by default adds the gap as well as the sync. However I have - still had trouble getting irrecord to work; you need at least - to feed it a template configuration containing sync and gap data. + LIRC expects sensor data that starts with a longish 'sync' space, denoting the start of + a command; followed by the code data, a sequence of mark/space pairs; sometimes followed by + a 'gap', which should be a space long enough to make the entire command up to a preset + duration in milliseconds. The 'sync' and the 'gap' are absent from the data + emitted by the picolcd hardware. I found that LIRC configuration files for remotes similar to the + ones I tested all used such a fixed-duration encoding, and as that was the only way I could get it + working, this driver by default adds the gap as well as the sync. However I have + still had trouble getting irrecord to work; you need at least + to feed it a template configuration containing sync and gap data. This code could therefore use more testing, more research, and more work. - + @@ -388,7 +338,7 @@ Copyright - The lcdproc picolcd driver originally was written by Gatewood Green (woody@nitrosecurity.com) + The lcdproc picolcd driver originally was written by Gatewood Green (woody@nitrosecurity.com) or (woody@linif.org) and paid for by NitroSecurity, Inc (nitrosecurity.com), but has been extended with code from various contributors since then. diff --git a/docs/lcdproc-user/drivers/pylcd.docbook b/docs/lcdproc-user/drivers/pylcd.docbook index b59a9d1..6a13d85 100644 --- a/docs/lcdproc-user/drivers/pylcd.docbook +++ b/docs/lcdproc-user/drivers/pylcd.docbook @@ -23,7 +23,7 @@ to show system data, and to allow the user to change important parameters or shut down the appliance in a controlled manner. The LCD module, accessible via USB, can be integrated by Pyramid's BTO server and appliance manufacturing division at the customer's request or it can be -made available separately for self-integration, e.g. as a 5.25" module. +made available separately for self-integration, e.g. as a 5.25" module. @@ -42,7 +42,7 @@ buttons as well as 3 (or 9) LEDs which can also be software controlled. Connector -The display is connected to the host system using USB, with the +The display is connected to the host system using USB, with the usual USB pinout as shown below. The +5V VCC pin is marked with red colour. @@ -79,7 +79,7 @@ The +5V VCC pin is marked with red colour. For Linux the driver depends on features of the ftdi_sio.ko that have only been added to version 2.6.15 version of the 2.6 kernel series. For older Linux kernels of the 2.6 series these patches to -ftdi_sio.c may help: +ftdi_sio.c may help: @@ -105,7 +105,7 @@ For older Linux kernels of the 2.6 series these patches to I've added support for the LEDs on the Pyramid LC-Display to the -"pyramid" driver of lcdproc. +"pyramid" driver of lcdproc. @@ -208,8 +208,8 @@ More information on the Pyramid LC-Display can be found here: - Device = - DEVICE + Device = + DEVICE Device to connect to. Default: /dev/lcd diff --git a/docs/lcdproc-user/drivers/sed1330.docbook b/docs/lcdproc-user/drivers/sed1330.docbook index 6ca6dae..35873a7 100644 --- a/docs/lcdproc-user/drivers/sed1330.docbook +++ b/docs/lcdproc-user/drivers/sed1330.docbook @@ -513,31 +513,24 @@ use the following circuit. - CellSize = - - WIDTH - x - HEIGHT - + CellSize = ¶meters.size; Specify the size of a character in pixels. WIDTH may vary between 6 and 8; legal values for HEIGHT range from 7 to 16. - If not given CellSize defaults to 6x10. + If not given CellSize defaults to 6x10. - ConnectionType = - - - classic - bitshaker - - + ConnectionType = + { + classic | + bitshaker + } @@ -573,8 +566,8 @@ use the following circuit. - Port = - PORT + Port = + PORT Specify the address of the parallel port the LCD is connected to. @@ -586,17 +579,15 @@ use the following circuit. - Type = - - - G321D - G121C - G242C - G191D - G2446 - SP14Q002 - - + Type = + { + G321D | + G121C | + G242C | + G191D | + G2446 | + SP14Q002 + } diff --git a/docs/lcdproc-user/drivers/sed1520.docbook b/docs/lcdproc-user/drivers/sed1520.docbook index 08433a0..a207028 100644 --- a/docs/lcdproc-user/drivers/sed1520.docbook +++ b/docs/lcdproc-user/drivers/sed1520.docbook @@ -16,8 +16,8 @@ sed1520 chipset. - Port = - PORT + Port = + PORT Specify the address of the parallel port the LCD is connected to. diff --git a/docs/lcdproc-user/drivers/serialPOS.docbook b/docs/lcdproc-user/drivers/serialPOS.docbook index 6323f39..a0f2661 100644 --- a/docs/lcdproc-user/drivers/serialPOS.docbook +++ b/docs/lcdproc-user/drivers/serialPOS.docbook @@ -6,13 +6,13 @@ This section talks about using LCDproc with a point of sale ("POS") character-di -The serialPOS driver is currently working with the AEDEX emulation protocol, -and may support Epson ESC/POS and Logic Controls. It can be extended to work with various +The serialPOS driver is currently working with the AEDEX emulation protocol, +and may support Epson ESC/POS and Logic Controls. It can be extended to work with various other protocol displays. -The driver should operate most character POS displays with a serial (RS-232) input. +The driver should operate most character POS displays with a serial (RS-232) input. Because these displays use a standardized protocol, if the protocol is supported by your display, it should work as expected. Feedback is welcome. @@ -83,7 +83,7 @@ Feedback is welcome. Connecting the display should consist of simply plugging it into your computer's -RS-232 serial port. Because these displays typically support full RS-232, no additional +RS-232 serial port. Because these displays typically support full RS-232, no additional wiring is needed. If your computer does not have such a port (many newer computers don't), you can use a USB to serial adapter with a driver provided by the adapter manufacturer. @@ -118,8 +118,8 @@ arrow, delete, and return keys by default. - Device = - DEVICE + Device = + DEVICE Device to use in serial mode. Usual values are /dev/ttyS0 or @@ -129,12 +129,7 @@ arrow, delete, and return keys by default. - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; Specifies the size of the VFD in characters. @@ -144,18 +139,16 @@ arrow, delete, and return keys by default. - Type = - - - IEE - AEDEX - Epson - Emax - IBM - LogicControls - Ultimate - - + Type = + { + IEE | + AEDEX | + Epson | + Emax | + IBM | + LogicControls | + Ultimate + } Set the communication protocol to use with the POS display. @@ -166,16 +159,14 @@ arrow, delete, and return keys by default. - Speed = - - - 1200 - 2400 - 9600 - 19200 - 115200 - - + Speed = + { + 1200 | + 2400 | + 9600 | + 19200 | + 115200 + } Set the the baud rate communication with the POS display. diff --git a/docs/lcdproc-user/drivers/serialVFD.docbook b/docs/lcdproc-user/drivers/serialVFD.docbook index 9cbfd98..e99fef1 100644 --- a/docs/lcdproc-user/drivers/serialVFD.docbook +++ b/docs/lcdproc-user/drivers/serialVFD.docbook @@ -186,7 +186,7 @@ If your display isn't working 100% satisfactorily you can add a new device with commands to the driver if you want. To do that you have to add a new section to the display Type-switch-case in ./server/drivers/serialVFD-displays.c and to write a new "load" function with the correct commands for the display. -(Try which display Type works best with your display, +(Try which display Type works best with your display, then copy, rename and modify this function to your needs - that is the easiest way I guess.) @@ -339,7 +339,7 @@ It must be connected directly with the serial port. -More detailed information can be found in the users manual of +More detailed information can be found in the users manual of the display. @@ -433,13 +433,7 @@ optional - use_parallel = - - - yes - no - - + use_parallel = ¶meters.yesdefno; "no" if display connected serial, "yes" if connected parallel [default: no(serial)]. @@ -448,8 +442,8 @@ optional - Port = - PORT + Port = + PORT Portaddress where the LPT is. Used in parallelmode only. Usual values are 0x278, 0x378 and 0x3BC [default: 0x278]. @@ -458,18 +452,18 @@ optional - PortWait = - DELAY + PortWait = + DELAY - Set parallel port timingdelay (us). Used in parallelmode only. [default: 2; legal: 0 - 255]. + Set parallel port timingdelay (us). Used in parallel mode only. [default: 2; legal: 0 - 255]. - Device = - DEVICE + Device = + DEVICE Device to use in serial mode. Usual values are /dev/ttyS0 and /dev/ttyS1 @@ -479,22 +473,17 @@ optional - Custom-Characters = - CUSTOM-CHARACTERS + Custom-Characters = + CUSTOM-CHARACTERS -Number of Custom-Characters [default: Display-Type dependent]. +Number of Custom-Characters [default: Display-Type dependent]. - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; Specifies the size of the VFD. @@ -504,8 +493,8 @@ Number of Custom-Characters [default: Display-Type dependent] - Type = - CODE + Type = + CODE @@ -522,7 +511,7 @@ Number of Custom-Characters [default: Display-Type dependent] - 0 + 0 NEC (FIPC8367 based) VFDs @@ -568,8 +557,8 @@ Number of Custom-Characters [default: Display-Type dependent] - Brightness = - BRIGHTNESS + Brightness = + BRIGHTNESS Set the initial brightness [default: 1000; legal: 0 - 1000] @@ -579,8 +568,8 @@ Set the initial brightness [default: 1000; legal: 0 - 1000] - OffBrightness = - OFFBRIGHTNESS + OffBrightness = + OFFBRIGHTNESS Set the initial off-brightness [default: 0; legal: 0 - 1000]. @@ -592,16 +581,14 @@ Set the initial off-brightness [default: 0; legal: 0 - 1000]. - Speed = - - - 1200 - 2400 - 9600 - 19200 - 115200 - - + Speed = + { + 1200 | + 2400 | + 9600 | + 19200 | + 115200 + } Set the the baud rate communication with the VFD. @@ -611,13 +598,7 @@ Set the initial off-brightness [default: 0; legal: 0 - 1000]. - ISO_8859_1 = - - - yes - no - - + ISO_8859_1 = ¶meters.yesdefno; Enable ISO-8859-1 compatibility [default is yes]. diff --git a/docs/lcdproc-user/drivers/sli.docbook b/docs/lcdproc-user/drivers/sli.docbook index 33be2fe..fd8b82d 100644 --- a/docs/lcdproc-user/drivers/sli.docbook +++ b/docs/lcdproc-user/drivers/sli.docbook @@ -16,8 +16,8 @@ sli chipset. - Device = - DEVICE + Device = + DEVICE Select the output device to use [default: /dev/lcd] @@ -26,18 +26,16 @@ sli chipset. - Speed = - - - 1200 - 2400 - 9600 - 19200 - 38400 - 57600 - 115200 - - + Speed = + { + 1200 | + 2400 | + 9600 | + 19200 | + 38400 | + 57600 | + 115200 + } Set the the baud rate communication with the LCD. diff --git a/docs/lcdproc-user/drivers/stv5730.docbook b/docs/lcdproc-user/drivers/stv5730.docbook index 93f78b6..9636595 100644 --- a/docs/lcdproc-user/drivers/stv5730.docbook +++ b/docs/lcdproc-user/drivers/stv5730.docbook @@ -16,8 +16,8 @@ stv5730 chipset. - Port = - PORT + Port = + PORT Specify the address of the parallel port the LCD is connected to. diff --git a/docs/lcdproc-user/drivers/svga.docbook b/docs/lcdproc-user/drivers/svga.docbook index e8a68aa..b81b216 100644 --- a/docs/lcdproc-user/drivers/svga.docbook +++ b/docs/lcdproc-user/drivers/svga.docbook @@ -16,8 +16,8 @@ svga chipset. - Mode = - SCGALIB-MODE + Mode = + SCGALIB-MODE svgalib mode to use [default: G320x240x256] @@ -29,12 +29,7 @@ svga chipset. - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; set display size [default: 20x4] @@ -43,8 +38,8 @@ svga chipset. - Contrast = - CONTRAST + Contrast = + CONTRAST Set the initial contrast. @@ -59,8 +54,8 @@ svga chipset. - Brightness = - BRIGHTNESS + Brightness = + BRIGHTNESS Set the initial brightness [default: 1000; legal: 1 - 1000] @@ -69,8 +64,8 @@ svga chipset. - OffBrightness = - BRIGHTNESS + OffBrightness = + BRIGHTNESS Set the initial off-brightness [default: 500; legal: 1 - 1000] diff --git a/docs/lcdproc-user/drivers/t6963.docbook b/docs/lcdproc-user/drivers/t6963.docbook index feca54d..481ed50 100644 --- a/docs/lcdproc-user/drivers/t6963.docbook +++ b/docs/lcdproc-user/drivers/t6963.docbook @@ -2,8 +2,8 @@ The Toshiba T6963 Driver -This section talks about using LCDproc with LCD displays that use the -T6963 chipset from Toshiba. Usually, this chipset is used on big character LCD +This section talks about using LCDproc with LCD displays that use the +T6963 chipset from Toshiba. Usually, this chipset is used on big character LCD displays that can often act as a screen. @@ -75,12 +75,7 @@ can be done by specifying "--enable-drivers=all" or by - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; set display size [default: 20x6] @@ -89,8 +84,8 @@ can be done by specifying "--enable-drivers=all" or by - Port = - PORT + Port = + PORT Specify the address of the parallel port the LCD is connected to. @@ -103,13 +98,7 @@ can be done by specifying "--enable-drivers=all" or by - ECPlpt = - - - yes - no - - + ECPlpt = ¶meters.yesdefno; Is ECP mode on? [default: yes; legal: yes, no] @@ -118,13 +107,7 @@ can be done by specifying "--enable-drivers=all" or by - graphic = - - - yes - no - - + graphic = ¶meters.yesnodef; Use graphic? [default: no; legal: yes, no] diff --git a/docs/lcdproc-user/drivers/text.docbook b/docs/lcdproc-user/drivers/text.docbook index d97f66f..57e4324 100644 --- a/docs/lcdproc-user/drivers/text.docbook +++ b/docs/lcdproc-user/drivers/text.docbook @@ -16,12 +16,7 @@ text chipset. - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; Set the display size [default: 20x4] diff --git a/docs/lcdproc-user/drivers/tyan.docbook b/docs/lcdproc-user/drivers/tyan.docbook index fd67c7d..d56e7bb 100644 --- a/docs/lcdproc-user/drivers/tyan.docbook +++ b/docs/lcdproc-user/drivers/tyan.docbook @@ -18,7 +18,7 @@ To the right of the display there is a 6 button keypad: -For more information see the +For more information see the LCD pack from the Tyan support page. Besides a useless old version of LCDproc it contains some @@ -39,8 +39,8 @@ of the LCD display by its manufacturer. - Device = - DEVICE + Device = + DEVICE Select the output device to use [default: /dev/lcd] @@ -49,13 +49,11 @@ of the LCD display by its manufacturer. - Speed = - - - 4800 - 9600 - - + Speed = + { + 4800 | + 9600 + } Set the the baud rate communication with the LCD. @@ -65,12 +63,7 @@ of the LCD display by its manufacturer. - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; set display size [default: 16x2] diff --git a/docs/lcdproc-user/drivers/ula200.docbook b/docs/lcdproc-user/drivers/ula200.docbook index e2f124e..588a170 100644 --- a/docs/lcdproc-user/drivers/ula200.docbook +++ b/docs/lcdproc-user/drivers/ula200.docbook @@ -121,12 +121,7 @@ a standard character which looks good. - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; Select the LCD size [default: 20x4] @@ -135,28 +130,28 @@ a standard character which looks good. - KeyMap_A = - KEY + KeyMap_A = + KEY - KeyMap_B = - KEY + KeyMap_B = + KEY - KeyMap_C = - KEY + KeyMap_C = + KEY - KeyMap_D = - KEY + KeyMap_D = + KEY - KeyMap_E = - KEY + KeyMap_E = + KEY - KeyMap_F = - KEY + KeyMap_F = + KEY If you have a non standard keypad you can associate any keystrings to keys. diff --git a/docs/lcdproc-user/drivers/xosd.docbook b/docs/lcdproc-user/drivers/xosd.docbook index edb98f9..307ff32 100644 --- a/docs/lcdproc-user/drivers/xosd.docbook +++ b/docs/lcdproc-user/drivers/xosd.docbook @@ -22,12 +22,7 @@ on-screen display (OSD) used by most modern televisions and video-players. - Size = - - WIDTH - x - HEIGHT - + Size = ¶meters.size; set display size [default: 20x4] @@ -36,12 +31,12 @@ on-screen display (OSD) used by most modern televisions and video-players. - Offset = - + Offset = + X-OFFSET x Y-OFFSET - + Offset (in pixels) of the top-left corner of LCDproc's @@ -52,18 +47,18 @@ on-screen display (OSD) used by most modern televisions and video-players. - Font = - FONT + Font = + FONT X font to use, in XLFD (X Logical Font Description) format, - as given by the xfontsel command. + as given by the xfontsel property. E.g. -*-terminus-*-r-*-*-*-320-*-*-*-*-*. For best results it is recommended to use a mono-spaced font - to mimic the aspect of a physical LCD display that most + to mimic the aspect of a physical LCD display that most clients expect with regard to their screen layouts. @@ -71,8 +66,8 @@ on-screen display (OSD) used by most modern televisions and video-players. - Contrast = - CONTRAST + Contrast = + CONTRAST Set the initial contrast. @@ -87,8 +82,8 @@ on-screen display (OSD) used by most modern televisions and video-players. - Brightness = - BRIGHTNESS + Brightness = + BRIGHTNESS Set the initial brightness [default: 1000; legal: 1 - 1000] @@ -97,8 +92,8 @@ on-screen display (OSD) used by most modern televisions and video-players. - OffBrightness = - BRIGHTNESS + OffBrightness = + BRIGHTNESS Set the initial off-brightness [default: 500; legal: 1 - 1000] diff --git a/docs/lcdproc-user/lcdproc-user.docbook b/docs/lcdproc-user/lcdproc-user.docbook index 8fdcda1..64d1d21 100644 --- a/docs/lcdproc-user/lcdproc-user.docbook +++ b/docs/lcdproc-user/lcdproc-user.docbook @@ -1,6 +1,7 @@ @@ -59,10 +60,11 @@ + + %parameters; ]> - &bookinfo; &introduction; diff --git a/docs/lcdproc-user/parameters.ent b/docs/lcdproc-user/parameters.ent new file mode 100644 index 0000000..398bb61 --- /dev/null +++ b/docs/lcdproc-user/parameters.ent @@ -0,0 +1,21 @@ + +yes | + no + }" > + + +yes | + no + }" > + + + + WIDTH + x + HEIGHT + " > diff --git a/scripts/debian/patches/userguide_Makefile.diff b/scripts/debian/patches/userguide_Makefile.diff deleted file mode 100644 index 91c52e3..0000000 --- a/scripts/debian/patches/userguide_Makefile.diff +++ /dev/null @@ -1,23 +0,0 @@ -diff -ur lcdproc-0.5dev.orig/docs/lcdproc-user/Makefile.am lcdproc-0.5dev/docs/lcdproc-user/Makefile.am ---- lcdproc-0.5dev.orig/docs/lcdproc-user/Makefile.am 2008-10-10 12:08:10.000000000 +0200 -+++ lcdproc-0.5dev/docs/lcdproc-user/Makefile.am 2009-06-07 15:27:45.000000000 +0200 -@@ -23,6 +23,6 @@ - - install-html-userguide: $(xmlto) lcdproc-user.docbook - $(mkinstalldirs) $(userguidedir) -- $(xmlto) html -o $(userguidedir) lcdproc-user.docbook -+ $(xmlto) html -o $(userguidedir) --skip-validation lcdproc-user.docbook - - ## EOF -diff -ur lcdproc-0.5dev.orig/docs/lcdproc-user/Makefile.in lcdproc-0.5dev/docs/lcdproc-user/Makefile.in ---- lcdproc-0.5dev.orig/docs/lcdproc-user/Makefile.in 2009-06-07 15:14:20.000000000 +0200 -+++ lcdproc-0.5dev/docs/lcdproc-user/Makefile.in 2009-06-07 15:29:21.000000000 +0200 -@@ -491,7 +491,7 @@ - - install-html-userguide: $(xmlto) lcdproc-user.docbook - $(mkinstalldirs) $(userguidedir) -- $(xmlto) html -o $(userguidedir) lcdproc-user.docbook -+ $(xmlto) html -o $(userguidedir) --skip-validation lcdproc-user.docbook - # Tell versions [3.59,3.63) of GNU make to not export all variables. - # Otherwise a system limit (for SysV at least) may be exceeded. - .NOEXPORT: