fix typos, bring LCDd man page in sync with program

This commit is contained in:
marschap
2006-09-18 14:40:20 +00:00
parent 470b5ee00d
commit 6dbcc7d1f3
2 changed files with 37 additions and 37 deletions
+36 -36
View File
@@ -5,14 +5,17 @@ LCDd - LCDproc server daemon
.SH SYNOPSIS .SH SYNOPSIS
.B LCDd .B LCDd
[\fB\-hfis\fP] [\fB\-h\fP]
[\fB\-c\fP \fIconfig\fP] [\fB\-c\fP \fIconfig\fP]
[\fB\-d\fP \fIdriver\fP] [\fB\-d\fP \fIdriver\fP]
[\fB\-f\fP \fIbool\fP]
[\fB\-i\fP \fIbool\fP]
[\fB\-a\fP \fIaddr\fP] [\fB\-a\fP \fIaddr\fP]
[\fB\-p\fP \fIport\fP] [\fB\-p\fP \fIport\fP]
[\fB\-u\fP \fIuser\fP] [\fB\-u\fP \fIuser\fP]
[\fB\-w\fP \fItime\fP] [\fB\-w\fP \fItime\fP]
[\fB\-r\fP \fIlevel\fP] [\fB\-r\fP \fIlevel\fP]
[\fB\-s\fP \fIbool\fP]
.SH DESCRIPTION .SH DESCRIPTION
LCDd is the server part of LCDproc, a deamon which listens to a certain port (normally 13666) LCDd is the server part of LCDproc, a deamon which listens to a certain port (normally 13666)
@@ -25,7 +28,8 @@ Before running LCDd you should carefully
read through that file and modify everything neccessary according to your needs. read through that file and modify everything neccessary according to your needs.
Otherwise you might encounter LCDd not running properly on your system. Otherwise you might encounter LCDd not running properly on your system.
.PP .PP
To make full use of LCDd, a client such as lcdproc(1) is required. To make full use of LCDd, a client such as lcdproc(1), lcdexec(1), or lcdvd
is required.
.SH OPTIONS .SH OPTIONS
Available LCDd options are: Available LCDd options are:
@@ -40,13 +44,14 @@ Use a configuration file other than @SYSCONFDIR@/LCDd.conf
Specify a driver to use (output only to first), overriding Specify a driver to use (output only to first), overriding
the \fBDriver\fP parameter in the config file's \fB[Server]\fP section. the \fBDriver\fP parameter in the config file's \fB[Server]\fP section.
.TP .TP
.B \-f .B \-f \fIbool\fp
Run in the foreground, override the \fBForegound\fP parameter Tell whether to run in the foreground (\fI1\fP) or background (\fI0\fP),
in the config file's \fB[Server]\fP section. overriding the \fBForeground\fP parameter in the config file's \fB[Server]\fP section.
.TP .TP
.B \-i .B \-i \fIbool\fP
Disable showing the main LCDproc server screen in rotation, overriding Tell whether the to enable (\fI1\fP) or disable (\fI0\fP) showing the LCDproc
\fBServerScreen\fP in the config file's \fB[Server]\fP section. server screen in n the screen rotation, overriding \fBServerScreen\fP
in the config file's \fB[Server]\fP section.
.TP .TP
.B \-w \fIwaittime\fP .B \-w \fIwaittime\fP
Time to pause at each screen (in seconds), overriding the Time to pause at each screen (in seconds), overriding the
@@ -54,24 +59,23 @@ Time to pause at each screen (in seconds), overriding the
.TP .TP
.B \-a \fIaddr\fP .B \-a \fIaddr\fP
Bind to network address \fIaddr\fP, overriding the Bind to network address \fIaddr\fP, overriding the
\fPBind\fP parameter in the config file's \fB[Server]\fP section. \fBBind\fP parameter in the config file's \fB[Server]\fP section.
.TP .TP
.B \-p \fIport\fP .B \-p \fIport\fP
Listen on port \fIport\fP for incoming connections, overriding the Listen on port \fIport\fP for incoming connections, overriding the
\fPPort\fP parameter in the config file's \fB[Server]\fP section. \fBPort\fP parameter in the config file's \fB[Server]\fP section.
.TP .TP
.B \-u \fIuser\fP .B \-u \fIuser\fP
Run as user \fIuser\fP, overriding the Run as user \fIuser\fP, overriding the
\fPUser\fP parameter in the config file's \fB[Server]\fP section. \fBUser\fP parameter in the config file's \fB[Server]\fP section.
.TP .TP
.B \-s .B \-s \fIbool\fP
Output messages to syslog instead of STDOUT, overriding the Output messages to syslog (\fI1\fP) or to stdout (\fI0\fP), overriding the
\fPReportToSyslog\fP parameter in the config file's \fB[Server]\fP section. \fBReportToSyslog\fP parameter in the config file's \fB[Server]\fP section.
.TP .TP
.B \-r \fIlevel\fP .B \-r \fIlevel\fP
Set reporting level to \fIlevel\fP, overriding th Set reporting level to \fIlevel\fP, overriding th
\fBReportLevel\fP parameter in the config file's \fB[Server]\fP section. \fBReportLevel\fP parameter in the config file's \fB[Server]\fP section.
.PP
.SS SUPPORTED DRIVERS .SS SUPPORTED DRIVERS
Currently supported display drivers include: Currently supported display drivers include:
@@ -227,8 +231,9 @@ Multiple drivers can be used simultaneously; thus, for example, a Matrix Orbital
can be combined with an infrared driver (irmanin driver). can be combined with an infrared driver (irmanin driver).
.SH INVOCATION .SH INVOCATION
.RI "LCDd -d MtxOrb -d joy" .RS
.PP .I LCDd -d MtxOrb -d joy
.RE
The invocation example above will start LCDd reading its configuration from the The invocation example above will start LCDd reading its configuration from the
default configuration file @SYSCONFDIR@/LCDd.conf but overriding the drivers default configuration file @SYSCONFDIR@/LCDd.conf but overriding the drivers
specified therein with the Matrix Orbital driver and the Joystick input driver. specified therein with the Matrix Orbital driver and the Joystick input driver.
@@ -237,7 +242,7 @@ specified therein with the Matrix Orbital driver and the Joystick input driver.
There is a basic sequence: There is a basic sequence:
.TP .TP
1. Open a TCP connection to the LCDd server port (usually 13666). 1. Open a TCP connection to the LCDd server port (usually 13666).
.TP 8 .TP
2. Say "hello" 2. Say "hello"
.TP .TP
3. The server will return some information on the type 3. The server will return some information on the type
@@ -247,7 +252,9 @@ of display available.
.TP .TP
5. Close the socket when done displaying data. 5. Close the socket when done displaying data.
.PP .PP
There are many commands for the LCDd server:
.SS CLIENT COMMANDS
There are many commands for the client to send to the LCDd server:
.TP .TP
.B hello .B hello
This starts a client-server session with the LCDd server; the This starts a client-server session with the LCDd server; the
@@ -276,7 +283,7 @@ Delete widget \fI#id\fR from screen \fI#screen\fR.
Set the data used to define a particular widget \fI#id\fR on screen Set the data used to define a particular widget \fI#id\fR on screen
\fI#screen\fR. \fI#screen\fR.
.SS Heartbeat Modes .SS HEARTBEAT MODES
Valid heartbeat mode values (for the \fBscreen_set\fR command) are: Valid heartbeat mode values (for the \fBscreen_set\fR command) are:
.TP .TP
.B on .B on
@@ -288,7 +295,7 @@ No heartbeat display.
.B open .B open
Use client's heartbeat setting. This is the default. Use client's heartbeat setting. This is the default.
.SS Backlight Modes .SS BACKLIGHT MODES
Valid heartbeat mode values (for the \fBscreen_set\fR command) are: Valid heartbeat mode values (for the \fBscreen_set\fR command) are:
.TP .TP
.B on .B on
@@ -359,7 +366,7 @@ would be displayed immediately. It wouldn't even wait for
the previous screen to finish. Also, the display would stay the previous screen to finish. Also, the display would stay
on screen most of the time until the user did something about it. on screen most of the time until the user did something about it.
.SS Widget Types .SS WIDGET TYPES
Widgets can be any of the following: Widgets can be any of the following:
.TP .TP
.B string .B string
@@ -387,39 +394,32 @@ parameter, where \fI#id\fR refers to the id of the frame.
.PP .PP
Widgets are drawn on the screen in the order they are created. Widgets are drawn on the screen in the order they are created.
.SS Setting Widget Data .SS SETTING WIDGET DATA
In the \fBwidget_set\fR command, the \fIdata\fR argument depends on which widget is being In the \fBwidget_set\fR command, the \fIdata\fR argument depends on which widget is being
set. Each widget takes a particular set of arguments which defines its form and behavior: set. Each widget takes a particular set of arguments which defines its form and behavior:
.TP .TP
.B string \fIx y text\fP .B string \fIx y text\fP
.sp
Displays \fItext\fP at position (\fIx\fP,\fIy\fP). Displays \fItext\fP at position (\fIx\fP,\fIy\fP).
.TP .TP
.B title \fItext .B title \fItext
.sp
Uses \fItext\fP as title to display. Uses \fItext\fP as title to display.
.TP .TP
.B hbar \fIx y length\fP .B hbar \fIx y length\fP
.sp
Displays a horizontal bar starting at position (\fIx\fP,\fIy\fP) that is \fIlength\fP pixels wide. Displays a horizontal bar starting at position (\fIx\fP,\fIy\fP) that is \fIlength\fP pixels wide.
.TP .TP
.B vbar \fIx y length\fP .B vbar \fIx y length\fP
.sp
Displays a vertical bar starting at position (\fIx\fP,\fIy\fP) that is \fIlength\fP pixels high. Displays a vertical bar starting at position (\fIx\fP,\fIy\fP) that is \fIlength\fP pixels high.
.TP .TP
.B icon \fIx y name\fP .B icon \fIx y name\fP
.sp
Displays the icon \fIname\fP at position (\fIx\fP,\fIy\fP). Displays the icon \fIname\fP at position (\fIx\fP,\fIy\fP).
.TP .TP
.B scroller \fIleft top right bottom direction speed text\fP .B scroller \fIleft top right bottom direction speed text\fP
.sp
The \fItext\fR defined will scroll in the direction defined. Valid directions The \fItext\fR defined will scroll in the direction defined. Valid directions
are \fBh\fR (horizontal) and \fBv\fR (vertical). The speed defines how many are \fBh\fR (horizontal) and \fBv\fR (vertical). The speed defines how many
"movements" (or changes) will occur per frame. A positive number indicates "movements" (or changes) will occur per frame. A positive number indicates
frames per movement; a negative number indicates movements per frame. frames per movement; a negative number indicates movements per frame.
.TP .TP
.B frame \fIleft top right bottom wid hgt dir speed\fP .B frame \fIleft top right bottom wid hgt dir speed\fP
.sp
Frames define a visible "box" on screen, Frames define a visible "box" on screen,
from the (\fIleft\fR, \fItop\fR) corner to the from the (\fIleft\fR, \fItop\fR) corner to the
(\fIright\fR, \fIbottom\fR) corner. The actual data may be bigger, (\fIright\fR, \fIbottom\fR) corner. The actual data may be bigger,
@@ -428,17 +428,17 @@ bigger, then the frame will scroll in the direction (\fIdir\fR)
and \fIspeed\fR defined. and \fIspeed\fR defined.
.TP .TP
.B num \fIx int\fP .B num \fIx int\fP
.sp
Displays large decimal digit \fIint\fP at the horizontal position \fIx\fP, Displays large decimal digit \fIint\fP at the horizontal position \fIx\fP,
which is a normal character x coordinate on the display. which is a normal character x coordinate on the display.
The special value 10 for \fIint\fP displays a colon. The special value 10 for \fIint\fP displays a colon.
.SH BUGS .SH BUGS
If LCDd seems to quietly disappear upon invocation or other similar problems, If LCDd seems not to work as expected try to run it with reporting level test to maximum,
check the order of the options and the quoting involved. Some combinations reporting to stderr and running it in the foreground.
of options will be misread and thus fail. This can be achieved without changes to the config file by using the following command line:
.PP .RS
Try using the -d option last. .I LCDd -f 1 -r 5 -s 0
.RE
.SH FILES .SH FILES
\fB@SYSCONFDIR@/LCDd.conf\fR, LCDd default configuration file \fB@SYSCONFDIR@/LCDd.conf\fR, LCDd default configuration file
+1 -1
View File
@@ -48,7 +48,7 @@ continues with the next line.
.SH EXAMPLE .SH EXAMPLE
Here is fully working example of an LCDd.conf Here is fully working example of an LCDd.conf
(formatted somehat strange to show the features): (formatted somewhat strange to show the features):
.na .na
.nf .nf
# the server section # the server section