From 5108e4931e91353eb34f7529e52e40d693c5e280 Mon Sep 17 00:00:00 2001 From: mmdolze Date: Thu, 11 Jun 2009 15:34:41 +0000 Subject: [PATCH] First round of Docbook updates: * Update Docbook to version 4.5 * Fix some errors --- docs/lcdproc-user/configuration.docbook | 247 ++++++------------ .../lcdproc-user/drivers/CFontzPacket.docbook | 26 +- docs/lcdproc-user/drivers/IOWarrior.docbook | 40 +-- docs/lcdproc-user/drivers/curses.docbook | 2 - docs/lcdproc-user/drivers/eyeboxone.docbook | 5 +- docs/lcdproc-user/drivers/glcdlib.docbook | 24 +- docs/lcdproc-user/drivers/hd44780.docbook | 86 +++--- docs/lcdproc-user/drivers/irman.docbook | 3 +- docs/lcdproc-user/drivers/lb216.docbook | 17 +- docs/lcdproc-user/drivers/lcdm001.docbook | 2 +- docs/lcdproc-user/drivers/lircin.docbook | 3 +- docs/lcdproc-user/drivers/pylcd.docbook | 26 +- docs/lcdproc-user/drivers/sed1330.docbook | 8 + docs/lcdproc-user/drivers/serialVFD.docbook | 4 +- docs/lcdproc-user/drivers/ula200.docbook | 10 +- docs/lcdproc-user/drivers/xosd.docbook | 4 - docs/lcdproc-user/lcdproc-user.docbook | 4 +- 17 files changed, 223 insertions(+), 288 deletions(-) diff --git a/docs/lcdproc-user/configuration.docbook b/docs/lcdproc-user/configuration.docbook index b7d3370..6346338 100644 --- a/docs/lcdproc-user/configuration.docbook +++ b/docs/lcdproc-user/configuration.docbook @@ -44,11 +44,11 @@ When quoted, the following character sequences are evaluated as in literal C str - escape sequence character + \a @@ -132,8 +132,8 @@ settings for the LCDproc server LCDd. - DriverPath = - DRIVERPATH + DriverPath = + DRIVERPATH Tells the server where to look for the driver files. @@ -147,8 +147,8 @@ settings for the LCDproc server LCDd. - Driver = - DRIVERNAME + Driver = + DRIVERNAME @@ -173,8 +173,8 @@ settings for the LCDproc server LCDd. - Bind = - ADDRESS + Bind = + ADDRESS @@ -192,8 +192,8 @@ settings for the LCDproc server LCDd. - Port = - PORTNUMBER + Port = + PORTNUMBER @@ -209,8 +209,8 @@ settings for the LCDproc server LCDd. - ReportLevel = - LEVEL + ReportLevel = + LEVEL @@ -228,13 +228,11 @@ settings for the LCDproc server LCDd. - ReportToSyslog = - - - no - yes - - + ReportToSyslog = + { + no | + yes + } @@ -261,8 +259,8 @@ settings for the LCDproc server LCDd. - User = - USER + User = + USER @@ -278,13 +276,11 @@ settings for the LCDproc server LCDd. - Foreground = - - - no - yes - - + Foreground = + { + no | + yes + } @@ -301,8 +297,8 @@ settings for the LCDproc server LCDd. - Hello = - HELLOMSG + Hello = + HELLOMSG @@ -333,8 +329,8 @@ settings for the LCDproc server LCDd. - GoodBye = - GOODBYEMSG + GoodBye = + GOODBYEMSG @@ -366,8 +362,8 @@ settings for the LCDproc server LCDd. - WaitTime = - SECONDS + WaitTime = + SECONDS @@ -383,14 +379,12 @@ settings for the LCDproc server LCDd. - ServerScreen = - - - yes - no - blank - - + ServerScreen = + { + yes | + no | + blank + } @@ -421,14 +415,12 @@ settings for the LCDproc server LCDd. - Backlight = - - - off - open - on - - + Backlight = + { + off | + open | + on + } Set the master backlight setting. @@ -442,14 +434,12 @@ settings for the LCDproc server LCDd. - Heartbeat = - - - off - open - on - - + Heartbeat = + { + off | + open | + on + } Set the master heartbeat, the oscillating icon in the top right corner @@ -463,8 +453,8 @@ settings for the LCDproc server LCDd. - TitleSpeed = - SPEED + TitleSpeed = + SPEED Set the speed how fast over-long title lines shall scroll. @@ -486,8 +476,8 @@ don't go to any client. - ToggleRotateKey = - KEY + ToggleRotateKey = + KEY Defaults to Enter. @@ -496,8 +486,8 @@ don't go to any client. - PrevScreenKey = - KEY + PrevScreenKey = + KEY Defaults to Left. @@ -506,8 +496,8 @@ don't go to any client. - NextScreenKey = - KEY + NextScreenKey = + KEY Defaults to Right. @@ -516,8 +506,8 @@ don't go to any client. - ScrollUpKey = - KEY + ScrollUpKey = + KEY Defaults to Up. @@ -526,8 +516,8 @@ don't go to any client. - ScrollDownKey = - KEY + ScrollDownKey = + KEY Defaults to Down. @@ -547,57 +537,6 @@ options related to the way LCDd handles input "events". - - The menu is a special LCDproc client built into LCDd that allows changing server and display settings as well as extending it @@ -611,8 +550,8 @@ You can configure what keys the menu should use. - MenuKey = - KEY + MenuKey = + KEY @@ -621,18 +560,18 @@ You can configure what keys the menu should use. means returning to the regular display mode. It has no default, but a natural candidate is Menu. - + The MenuKey will be reserved exclusively, while the others work in shared mode and can thus be used by a client application when not in the menu. - + - EnterKey = - KEY + EnterKey = + KEY The key to enter a sub menu, to select an entry and/or @@ -648,8 +587,8 @@ You can configure what keys the menu should use. - UpKey = - KEY + UpKey = + KEY The key to move to the previous item in a menu and/or to select @@ -663,8 +602,8 @@ You can configure what keys the menu should use. - DownKey = - KEY + DownKey = + KEY The key to move to the next item in a menu andi/or to select @@ -678,8 +617,8 @@ You can configure what keys the menu should use. - LeftKey = - KEY + LeftKey = + KEY If defined, this optional key is used to @@ -691,8 +630,8 @@ You can configure what keys the menu should use. - RightKey = - KEY + RightKey = + KEY If defined, this optional key is used to to move right in input fields. @@ -766,7 +705,7 @@ Refer to your system's manual on how to install the scripts. init-LCDd The file scripts/init-LCDd.* is the init script for the -LCDproc server LCDd. It does not require modification. +LCDproc server LCDd. It does not require modification. @@ -774,7 +713,7 @@ LCDproc server LCDd. It does not require modification. init-lcdproc The file scripts/init-lcdproc.* is the init script for the -LCDproc "main" client lcdproc. +LCDproc "main" client lcdproc. @@ -783,35 +722,23 @@ You can retrieve a listing of all options of lcdproc running lcdproc -- - - diff --git a/docs/lcdproc-user/drivers/CFontzPacket.docbook b/docs/lcdproc-user/drivers/CFontzPacket.docbook index 6e5b690..e87aa25 100644 --- a/docs/lcdproc-user/drivers/CFontzPacket.docbook +++ b/docs/lcdproc-user/drivers/CFontzPacket.docbook @@ -17,10 +17,10 @@ Currently this line of modules comprises the models: CFA-631 - 20x2 character LCD with backlight - keypad with 4 keys: Up, Down, enter & Escape - USB connection for data and power - mounting bracket to fit into 3,5" drive bays + 20x2 character LCD with backlight + keypad with 4 keys: Up, Down, enter & Escape + USB connection for data and power + mounting bracket to fit into 3,5" drive bays @@ -29,10 +29,10 @@ Currently this line of modules comprises the models: CFA-633 - 16x2 character LCDi with backlight - keypad with 6 keys: 4 directions, Enter & Escape - serial or USB connection - mounting bracket to fit into 5,25" drive bays + 16x2 character LCDi with backlight + keypad with 6 keys: 4 directions, Enter & Escape + serial or USB connection + mounting bracket to fit into 5,25" drive bays @@ -41,11 +41,11 @@ Currently this line of modules comprises the models: CFA-635 - 20x4 characters LCDi with backlight - keypad with 6 keys: 4 directions, Enter & Escape - USB connection for data and power - four bi-color LEDs to show status information - optional mounting bracket to fit into 5,25" drive bays + 20x4 characters LCDi with backlight + keypad with 6 keys: 4 directions, Enter & Escape + USB connection for data and power + four bi-color LEDs to show status information + optional mounting bracket to fit into 5,25" drive bays diff --git a/docs/lcdproc-user/drivers/IOWarrior.docbook b/docs/lcdproc-user/drivers/IOWarrior.docbook index 4577128..443cf57 100644 --- a/docs/lcdproc-user/drivers/IOWarrior.docbook +++ b/docs/lcdproc-user/drivers/IOWarrior.docbook @@ -15,13 +15,13 @@ support controlling LCD displays: IOWarrior24 - USB 1.1 Low Speed - 16 generic I/O Pins, typ. 125Hz read rate - I2C master function, 100kHz, throughput typ. 750 bytes/sec - SPI master interface, up to 2MHz, throughput typ. 750 bytes/sec - control an HD44780 compatible LCD - drive a matrix of up to 8x32 LEDs - decode RC5 compatible infrared remote controls + USB 1.1 Low Speed + 16 generic I/O Pins, typ. 125Hz read rate + I2C master function, 100kHz, throughput typ. 750 bytes/sec + SPI master interface, up to 2MHz, throughput typ. 750 bytes/sec + control an HD44780 compatible LCD + drive a matrix of up to 8x32 LEDs + decode RC5 compatible infrared remote controls @@ -30,12 +30,12 @@ support controlling LCD displays: IOWarrior40 - USB 1.1 Low Speed - 32 generic I/O Pins, typ. 125Hz read rate - I2C master function, 100kHz, throughput typ. 750 bytes/sec - control an HD44780 compatible LCD - drive a matrix of up to 8x32 LEDs - drive a 8x8 switch or button matrix + USB 1.1 Low Speed + 32 generic I/O Pins, typ. 125Hz read rate + I2C master function, 100kHz, throughput typ. 750 bytes/sec + control an HD44780 compatible LCD + drive a matrix of up to 8x32 LEDs + drive a 8x8 switch or button matrix @@ -44,13 +44,13 @@ support controlling LCD displays: IOWarrior56 - USB 1.1 Full Speed - 50 generic I/O Pins, typ. 1000Hz read rate - I2C master function, 50, 100, or 400kHz - SPI master interface, up to 12MHz, throughput up to 62Kbytes/sec - control various display modules, including most graphic modules - drive a matrix of up to 8x64 LEDs - drive a 8x8 switch or button matrix + USB 1.1 Full Speed + 50 generic I/O Pins, typ. 1000Hz read rate + I2C master function, 50, 100, or 400kHz + SPI master interface, up to 12MHz, throughput up to 62Kbytes/sec + control various display modules, including most graphic modules + drive a matrix of up to 8x64 LEDs + drive a 8x8 switch or button matrix diff --git a/docs/lcdproc-user/drivers/curses.docbook b/docs/lcdproc-user/drivers/curses.docbook index 97739d9..f49a4fe 100644 --- a/docs/lcdproc-user/drivers/curses.docbook +++ b/docs/lcdproc-user/drivers/curses.docbook @@ -14,8 +14,6 @@ curses chipset. [curses] - color settings - Foreground = diff --git a/docs/lcdproc-user/drivers/eyeboxone.docbook b/docs/lcdproc-user/drivers/eyeboxone.docbook index 2b198c0..b27b504 100644 --- a/docs/lcdproc-user/drivers/eyeboxone.docbook +++ b/docs/lcdproc-user/drivers/eyeboxone.docbook @@ -141,10 +141,11 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info) Set the the baud rate to use when communicating with the LCD. If not specified, it defaults to 19200. - - + + As I said, I think only 19200 is a good choice. + diff --git a/docs/lcdproc-user/drivers/glcdlib.docbook b/docs/lcdproc-user/drivers/glcdlib.docbook index 40989f4..9c82d54 100644 --- a/docs/lcdproc-user/drivers/glcdlib.docbook +++ b/docs/lcdproc-user/drivers/glcdlib.docbook @@ -1,4 +1,10 @@ + + + Lucian + Muresan + + The glcdlib Driver @@ -20,12 +26,6 @@ from before configuring the LCDproc build process --enable-drivers=glcdlib. -Author - -Lucian -Muresan - - @@ -35,7 +35,7 @@ Author [glcdlib] -## mandatory: +Mandatory settings: @@ -105,8 +105,9 @@ Author - + The following parameters only apply if UseFT2 = yes: + @@ -130,12 +131,15 @@ The following parameters only apply if UseFT2 = yes< - minumum size in pixels in which fonts should be rendered + minimum size in pixels in which fonts should be rendered + +Optional settings: -## optional: + +Optional settings Brightness = diff --git a/docs/lcdproc-user/drivers/hd44780.docbook b/docs/lcdproc-user/drivers/hd44780.docbook index 4cbbee0..a5d5150 100644 --- a/docs/lcdproc-user/drivers/hd44780.docbook +++ b/docs/lcdproc-user/drivers/hd44780.docbook @@ -30,25 +30,25 @@ historically connected to, the driver supports the connection types: - + 4bit: 4bit Wiring - + - + 8bit: 8bit Wiring ("lcdtime") - + - + winamp: 8bit Wiring "winamp" Style - + - + serialLpt: Serial LPT Wiring - + @@ -56,30 +56,30 @@ For serial RS-232 ports you can choose among these connection types: - + picanlcd: PIC-an-LCD serial device - + - + lcdserializer: LCD serializer - + - + los-panel: LCD on Serial panel device () - + - + vdr-lcd: VDR LCD serial device - + - + vdr-wakeup: VDR-Wakeup module - + @@ -89,45 +89,45 @@ more important. Here are the USB connection types the HD44780 driver supports: - + pertelian: Pertelian X2040 LCD display () - + - + bwctusb: BWCT USB LCD module () - + - + lcd2usb: Till Harbaum's LCD2USB () - + - + uss720: Display connected to USS-720 USB-to-IEEE 1284 Bridge (Belkin F5U002) - + - + lis2: LIS2 from VLSystem () - + - + mplay: MPlay Blast from VLSystem () - + - + ftdi: Display connected to a dual channel FTDI 2232D USB chip - + - + usblcd: USBLCD from Adams IT Services () - + @@ -135,15 +135,15 @@ Last but not least, for special purposes, there are even more connection types: - + i2c: LCD driven by PCF8574(A)/PCA9554(A) connected via I2C - + - + ethlcd: Display connected via TCP to PoE powered ethlcd device () - + @@ -151,10 +151,10 @@ Last but not least, for special purposes, there are even more connection types: Depending on the connection type and the display connected, the driver supports various special features. - Input keys - software controllable brightness / backlight - software controllable contrast - multiple displays / multi-controller displays + Input keys + software controllable brightness / backlight + software controllable contrast + multiple displays / multi-controller displays @@ -483,10 +483,12 @@ To be more precise, it assumes this mapping: + This mapping can be changed using the KeyMatrix_X_Y configuration option, where X and Y are the subscripts to the respective axes above. + If you only need e.g. 10 keys, leave the rest away. diff --git a/docs/lcdproc-user/drivers/irman.docbook b/docs/lcdproc-user/drivers/irman.docbook index e6903db..f3118ac 100644 --- a/docs/lcdproc-user/drivers/irman.docbook +++ b/docs/lcdproc-user/drivers/irman.docbook @@ -7,8 +7,9 @@ to control the LCDproc server LCDd and/or clients that can handle input. - + The keys are mapped according to the following table: + Mapping between LCDproc keys and IrMan commands diff --git a/docs/lcdproc-user/drivers/lb216.docbook b/docs/lcdproc-user/drivers/lb216.docbook index 76bf91d..174f44b 100644 --- a/docs/lcdproc-user/drivers/lb216.docbook +++ b/docs/lcdproc-user/drivers/lb216.docbook @@ -1,4 +1,11 @@ + + + Chris + Debenham + chris.debenham@aus.sun.com + + The lb216 Driver @@ -6,16 +13,6 @@ This section talks about using LCDproc with LCD displays that use the lb216 chipset. - -Connections - - - -Chris -Debenham -Sun Systems Engineer -chris.debenham@aus.sun.com - Heres a bit more info on the display. It is the LB216 and is made by R.T.N. Australia diff --git a/docs/lcdproc-user/drivers/lcdm001.docbook b/docs/lcdproc-user/drivers/lcdm001.docbook index 3b3d8db..46b6da9 100644 --- a/docs/lcdproc-user/drivers/lcdm001.docbook +++ b/docs/lcdproc-user/drivers/lcdm001.docbook @@ -85,7 +85,7 @@ lcdm001 chipset. - If your device is broken, have a look at server/drivers/lcdm001.h +If your device is broken, have a look at server/drivers/lcdm001.h diff --git a/docs/lcdproc-user/drivers/lircin.docbook b/docs/lcdproc-user/drivers/lircin.docbook index 05a0797..d5b73a2 100644 --- a/docs/lcdproc-user/drivers/lircin.docbook +++ b/docs/lcdproc-user/drivers/lircin.docbook @@ -69,6 +69,7 @@ Then you have to modify the [lirc] section of your LCDd.conf. + @@ -118,8 +119,6 @@ Then you have to modify the [lirc] section of your - - Modify Your <filename>~/.lircrc</filename> diff --git a/docs/lcdproc-user/drivers/pylcd.docbook b/docs/lcdproc-user/drivers/pylcd.docbook index c846c8e..b59a9d1 100644 --- a/docs/lcdproc-user/drivers/pylcd.docbook +++ b/docs/lcdproc-user/drivers/pylcd.docbook @@ -1,4 +1,15 @@ + + + Stefan + Reinauer + + + The pyramid Driver @@ -15,6 +26,7 @@ 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. + Features @@ -170,13 +182,13 @@ hello output 67 -will light up LEDs 3, 4 and 9. +will light up LEDs 3, 4 and 9. output 0 -will clear all LEDs. +will clear all LEDs. @@ -186,16 +198,6 @@ More information on the Pyramid LC-Display can be found here: -Author - - Stefan - Reinauer - - -coresystems GmbH · Brahmsstr. 16 · D-79104 Freiburg i. Br. -Tel.: +49 761 7668825 · Fax: +49 761 7664613 -Email: info@coresystems.de · http://www.coresystems.de/ - Configuration in LCDd.conf diff --git a/docs/lcdproc-user/drivers/sed1330.docbook b/docs/lcdproc-user/drivers/sed1330.docbook index e961705..6ca6dae 100644 --- a/docs/lcdproc-user/drivers/sed1330.docbook +++ b/docs/lcdproc-user/drivers/sed1330.docbook @@ -5,7 +5,9 @@ This section talks about using LCDproc with graphical LCD displays driven by the EPSON/SMOS SED1330 or SED1335 LCD controllers, which may also be known by their new names: S1D13300 (= SED1330) and S1D13305 (= SED1335). + + The displays are driven in text mode using their built-in character generator. @@ -434,7 +436,9 @@ the connections given here are also correct for your display !
+ The potentiometer should be connected like this on these display modules: + + The G242C generates -24V internally. It is available on Vlc. + + To generate -24 from the +5V without an external power source, you can use the following circuit. + No 2 - IEE 36657 + IEE 36657-01 (= 02S-93290-VFD 36657-01) ? @@ -329,7 +329,7 @@ Pin 19 ------ RxD ]]> - + Siemens/Wincor Nixdorf BA63/66: This display doesn't need the inverter! It must be connected directly with the serial port. diff --git a/docs/lcdproc-user/drivers/ula200.docbook b/docs/lcdproc-user/drivers/ula200.docbook index 5976831..e2f124e 100644 --- a/docs/lcdproc-user/drivers/ula200.docbook +++ b/docs/lcdproc-user/drivers/ula200.docbook @@ -16,11 +16,11 @@ Additionally it provides 6 digital inputs that can be used for keys. The ula200 driver controls this board supporting the features: - display on a single-controller HD44780 display - standard icons (heart, checkbox) - backlight control - input buttons - no horizontal or vertical bars + display on a single-controller HD44780 display + standard icons (heart, checkbox) + backlight control + input buttons + no horizontal or vertical bars diff --git a/docs/lcdproc-user/drivers/xosd.docbook b/docs/lcdproc-user/drivers/xosd.docbook index c92d2e7..edb98f9 100644 --- a/docs/lcdproc-user/drivers/xosd.docbook +++ b/docs/lcdproc-user/drivers/xosd.docbook @@ -50,8 +50,6 @@ on-screen display (OSD) used by most modern televisions and video-players. -Offset=200x200 - Font = @@ -71,7 +69,6 @@ Offset=200x200 - diff --git a/docs/lcdproc-user/lcdproc-user.docbook b/docs/lcdproc-user/lcdproc-user.docbook index d4e9784..8fdcda1 100644 --- a/docs/lcdproc-user/lcdproc-user.docbook +++ b/docs/lcdproc-user/lcdproc-user.docbook @@ -1,6 +1,6 @@ -