From 23bf9ba9c71bed802bde6656f5840451c503e1b1 Mon Sep 17 00:00:00 2001 From: mmdolze Date: Thu, 26 Feb 2009 19:55:38 +0000 Subject: [PATCH] Proofread man pages --- docs/LCDd.8.in | 22 ++++++++++++++-------- docs/lcdexec.1 | 14 +++++++------- 2 files changed, 21 insertions(+), 15 deletions(-) diff --git a/docs/LCDd.8.in b/docs/LCDd.8.in index 4c26f40..f6a7f73 100644 --- a/docs/LCDd.8.in +++ b/docs/LCDd.8.in @@ -1,4 +1,4 @@ -.TH LCDd 8 "18 September 2006" LCDproc "LCDproc suite" +.TH LCDd 8 "26 February 2009" LCDproc "LCDproc suite" .SH NAME LCDd - LCDproc server daemon @@ -27,7 +27,7 @@ Before running \fBLCDd\fP you should carefully read through that file and modify everything neccessary according to your needs. Otherwise you might encounter \fBLCDd\fP not running properly on your system. .PP -To make full use of \fBLCDd\fP, a client such as lcdproc(1), lcdexec(1), or lcdvd +To make full use of \fBLCDd\fP, a client such as lcdproc(1), lcdexec(1), or lcdvc is required. .SH OPTIONS @@ -174,6 +174,9 @@ USB connection via a FTDI FT2232D chip in bitbang mode TCP connection using open source/open hardware ethlcd (http://manio.skyboo.net/ethlcd/) .RE .TP +.B i2500vfd +140x32 pixel VFD Display of the Intra2net Intranator 2500 appliance +.TP .B icp_a106 ICP A106 alarm/LCD board in 19" rack cases by ICP .TP @@ -238,6 +241,9 @@ SED1330/SED1335 (aka S1D13300/S1D13305) based graphical displays .B sed1520 122x32 pixel graphic displays based on SED1520 controllers .TP +.B serialPOS +Driver for Point Of Sale ("POS") devices using various protocols (currently AEDEX only) +.TP .B serialVFD Text VFDs of various manufacturers, see LCDproc user-documentation for further details. .TP @@ -267,9 +273,6 @@ ULA-200 device from ELV (http://www.elv.de) .TP .B xosd On Screen Display on X11 -.TP -.B i2500vfd -140x32 pixel VFD Display of the Intra2net Intranator 2500 appliance .PP Multiple drivers can be used simultaneously; thus, for example, a Matrix Orbital display (MtxOrb driver) can be combined with an infrared driver (irmanin driver). @@ -318,7 +321,7 @@ Remove a screen from the display. Initialize a screen, or reset its data. .TP .B widget_add \fI#screen #id type\fR [\fB-in \fI#frame\fR] -Add a widget of type \fItype\fPto screen \fI#screen\fR. +Add a widget of type \fItype\fP to screen \fI#screen\fR. .TP .B widget_del \fI#screen #id\fR Delete widget \fI#id\fR from screen \fI#screen\fR. @@ -399,8 +402,8 @@ Imagine you're making an mp3 player for lcdproc. When the song changes, it's nice to display the new name immediately. So, you could set your screen's priority to \fBforeground\fP, wait for the server to display (or ignore) your screen, then set the -screen back to i\fBnormal\fP. This would cause the mp3 screen to -show up as soon as the one onscreen was finished, then +screen back to \fBnormal\fP. This would cause the mp3 screen to +show up as soon as the one on screen was finished, then return to normal priority afterward. .PP Or, let's say your client monitors the health of hospital @@ -435,6 +438,9 @@ A scrolling text display, scrolling either horizontally or vertically. A \fIcontainer\fR to contain other widgets, permitting them to be refered to as a single unit. A widget is put inside a frame by using the -in \fI#id\fR parameter, where \fI#id\fR refers to the id of the frame. +.TP +.B num +Displays a large decimal digit .PP Widgets are drawn on the screen in the order they are created. diff --git a/docs/lcdexec.1 b/docs/lcdexec.1 index 61c5e57..64ac7d1 100644 --- a/docs/lcdexec.1 +++ b/docs/lcdexec.1 @@ -1,4 +1,4 @@ -.TH lcdexec 1 "18 June 2006" LCDproc "LCDproc suite" +.TH lcdexec 1 "26 February 2009" LCDproc "LCDproc suite" .SH NAME lcdexec - LCDproc client to execute commands from the LCDd menu .SH SYNOPSIS @@ -18,7 +18,7 @@ You can access the menu by pressing the menu key configured for LCDd. .SH OPTIONS .I lcdexec understands the following command line options., that override the -icorresponding options given in the configuration file: +corresponding options given in the configuration file: .TP 8 .B \-c \fIfilename\fP Set the name of the config file to read, /etc/lcdexec.conf by default @@ -48,9 +48,9 @@ a configuration file. This file is expected to have a "INI-file" like format with sections introduced by section headers in square brackets and options lines consisting of key=value pairs. .PP -Section and option names may contain only characters from the range [a-za-Z0-9_]i, +Section and option names may contain only characters from the range [a-zA-Z0-9_], while value strings may contain any printable character. -Value strings with characters outside the range [a-za-Z0-9_] must be quoted with double quotes. +Value strings with characters outside the range [a-zA-Z0-9_] must be quoted with double quotes. To get a double quote or backslashes in the string, they must be escaped by preceding it by a backslash. .PP @@ -82,7 +82,7 @@ Default is 2 (errors and warnings only) Tell whether to report to syslog (TRUE) or to stderr (FALSE). .TP 8 .B Foreground=\fIbool\fP -Tell whether to run in fore foreground (TRUE) or in background (FALSE). +Tell whether to run in foreground (TRUE) or in background (FALSE). If not given, the default is FALSE for daemon mode. .TP 8 .B DisplayName=\fIDisplay\fP @@ -214,13 +214,13 @@ lcdexec -c /usr/local/etc/lcdexec.conf This will allow you to eject the CD-ROM by opening the LCDd menu, selecting "lcdexec" and selecting "Eject CD-ROM". Further it allows you to do various shutdowns, among others the "Shutdown in 5 minutes" -by opening the LCDd menu, selecting "lcdexec", selecting "Shutdown menu " +by opening the LCDd menu, selecting "lcdexec", selecting "Shutdown menu" and selecting "Shutdown in 5 minutes". .Sh SEE ALSO .Xr LCDd 8 .SH AUTHOR -lcdexec is wriitten by Joris Robijn and Peter Marschall. It is part of the LCDproc suite. +lcdexec is written by Joris Robijn and Peter Marschall. It is part of the LCDproc suite. The newest version of LCDproc should be available from here: