mangavalk/lcdproc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

replace LCDd.8 by an extended, generated version

Browse Source
This commit is contained in:
marschap
2006-09-18 14:00:40 +00:00
parent 5a14b72a7c
commit 470b5ee00d
2 changed files with 58 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/LCDd.8 → docs/LCDd.8.in
+54 -43
View File
@@ -1,6 +1,8 @@
.TH LCDd 8 "18 June 2006" LCDproc "LCDproc suite" .TH LCDd 8 "18 September 2006" LCDproc "LCDproc suite"
.SH NAME .SH NAME
LCDd - LCDproc server daemon LCDd - LCDproc server daemon
.SH SYNOPSIS .SH SYNOPSIS
.B LCDd .B LCDd
[\fB\-hfis\fP] [\fB\-hfis\fP]
@@ -17,8 +19,9 @@ LCDd is the server part of LCDproc, a deamon which listens to a certain port (no
and displays information on an LCD display. It works with several types and displays information on an LCD display. It works with several types
and sizes of displays. and sizes of displays.
.PP .PP
Most settings of LCDproc are configured through the LCDd configuration file, Most settings of LCDd are configured through its configuration file
which is normally /etc/LCDd.conf. Before running LCDd you should carefully @SYSCONFDIR@/LCDd.conf, some of them can be overriden using command line options.
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
@@ -28,39 +31,49 @@ To make full use of LCDd, a client such as lcdproc(1) is required.
Available LCDd options are: Available LCDd options are:
.TP .TP
.B \-h .B \-h
Display this help screen Display help screen
.TP .TP
.B \-c \fIconfig\fP .B \-c \fIconfig\fP
Use a configuration file other than /etc/LCDd.conf Use a configuration file other than @SYSCONFDIR@/LCDd.conf
.TP .TP
.B \-d \fIdriver\fP .B \-d \fIdriver\fP
Add a driver to use (output only to first) Specify a driver to use (output only to first), overriding
the \fBDriver\fP parameter in the config file's \fB[Server]\fP section.
.TP .TP
.B \-f .B \-f
Run in the foreground Run in the foreground, override the \fBForegound\fP parameter
in the config file's \fB[Server]\fP section.
.TP .TP
.B \-i .B \-i
Disable showing the main LCDproc server screen in rotation Disable showing the main LCDproc server screen in 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) Time to pause at each screen (in seconds), overriding the
\fBWaitTime\fP parameter in the config file's \fB[Server]\fP section.
.TP .TP
.B \-a \fIaddr\fP .B \-a \fIaddr\fP
Network IP address to bind to Bind to network address \fIaddr\fP, overriding the
\fPBind\fP parameter in the config file's \fB[Server]\fP section.
.TP .TP
.B \-p \fIport\fP .B \-p \fIport\fP
Network port to listen for connections on Listen on port \fIport\fP for incoming connections, overriding the
\fPPort\fP parameter in the config file's \fB[Server]\fP section.
.TP .TP
.B \-u \fIuser\fP .B \-u \fIuser\fP
User to run as Run as user \fIuser\fP, overriding the
\fPUser\fP parameter in the config file's \fB[Server]\fP section.
.TP .TP
.B \-s .B \-s
Output messages to syslog Output messages to syslog instead of STDOUT, overriding the
\fPReportToSyslog\fP parameter in the config file's \fB[Server]\fP section.
.TP .TP
.B \-r \fIlevel\fP .B \-r \fIlevel\fP
Report level (default=2) Set reporting level to \fIlevel\fP, overriding th
\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:
.TP .TP
.B bayrad .B bayrad
@@ -202,7 +215,7 @@ Toshiba T6963 based LCD displays
Standard "hard-copy" text display Standard "hard-copy" text display
.TP .TP
.B tyan .B tyan
LCDi module in Tyan Barebone GS series LCD module in Tyan Barebone GS series
.TP .TP
.B ula200 .B ula200
ULA-200 device from ELV (http://www.elv.de) ULA-200 device from ELV (http://www.elv.de)
@@ -214,48 +227,45 @@ 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
.R LCDd -d MtxOrb -d joy .RI "LCDd -d MtxOrb -d joy"
.PP .PP
As of version 0.4.3, driver parameters are read from a configuration file The invocation example above will start LCDd reading its configuration from the
(default location /etc/LCDd.conf) rather than being passed on the command default configuration file @SYSCONFDIR@/LCDd.conf but overriding the drivers
line as arguments. specified therein with the Matrix Orbital driver and the Joystick input driver.
The invocation example above will start LCDd with the Matrix Orbital driver
and the Joystick input driver,and attempt to load the driver parameters
from the default configuration file.
.SH LCDPROC CLIENT-SERVER PROTOCOL .SH LCDPROC CLIENT-SERVER PROTOCOL
There is a basic sequence: There is a basic sequence:
.TP 8 .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 8
2. Say "hello" 2. Say "hello"
.TP 8 .TP
3. The server will return some information on the type 3. The server will return some information on the type
of display available. of display available.
.TP 8 .TP
4. Define (and use) a new screen and its widgets. 4. Define (and use) a new screen and its widgets.
.TP 8 .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: There are many commands for the LCDd server:
.TP 8 .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
server will return a data string detailing the type of display server will return a data string detailing the type of display
and its size. and its size.
.TP 8 .TP
.B client_set -name \fIname\fP .B client_set -name \fIname\fP
Set the client's name. Set the client's name.
.TP 8 .TP
.B screen_add \fI#id\fP .B screen_add \fI#id\fP
Add a new screen to the display. Add a new screen to the display.
.TP 8 .TP
.B screen_del \fI#id\fP .B screen_del \fI#id\fP
Remove a screen from the display. Remove a screen from the display.
.TP 8 .TP
.B screen_set \fI#id\fP [\fB-name\fI "name"\fP] [\fB-wid\fI width\fP] [\fB-hgt\fI height\fP] [\fB-priority\fI prio\fP] [\fB-duration\fI int\fP] [\fB-timeout\fI int\fP] [\fB-heartbeat\fI mode\fP] [\fB-backlight\fI mode\fP] [\fB-cursor\fI mode\fP] [\fB-cursor_x\fI xpos\fP] [\fB-cursor_y\fI ypos\fP] .B screen_set \fI#id\fP [\fB-name\fI "name"\fP] [\fB-wid\fI width\fP] [\fB-hgt\fI height\fP] [\fB-priority\fI prio\fP] [\fB-duration\fI int\fP] [\fB-timeout\fI int\fP] [\fB-heartbeat\fI mode\fP] [\fB-backlight\fI mode\fP] [\fB-cursor\fI mode\fP] [\fB-cursor_x\fI xpos\fP] [\fB-cursor_y\fI ypos\fP]
Initialize a screen, or reset its data. Initialize a screen, or reset its data.
.TP 8 .TP
.B widget_add \fI#screen #id type\fR [\fB-in \fI#frame\fR] .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\fPto screen \fI#screen\fR.
.TP .TP
@@ -269,13 +279,13 @@ Set the data used to define a particular widget \fI#id\fR on screen
.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
.BR on .B on
Display pulsing heart symbol. Display pulsing heart symbol.
.TP .TP
.BR off .B off
No heartbeat display. No heartbeat display.
.TP .TP
.BR 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
@@ -376,6 +386,7 @@ 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. 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:
@@ -430,16 +441,16 @@ of options will be misread and thus fail.
Try using the -d option last. Try using the -d option last.
.SH FILES .SH FILES
.na \fB@SYSCONFDIR@/LCDd.conf\fR, LCDd default configuration file
.nf
\fB/etc/LCDd.conf\fR, LCDd default configuration file
.Sh SEE ALSO .SH SEE ALSO
.Xr lcdproc 1 lcdproc-config(5),
lcdproc(1),
lcdexec(1)
.SH AUTHOR .SH AUTHOR
LCDd was originally written by William Ferrell (wwf@splatwerks.org) and Scott Scriv LCDd was originally written by William Ferrell (wwf@splatwerks.org) and
en (scriven@cs.colostate.edu). Scott Scriven (scriven@cs.colostate.edu).
Since that time various people have contributed to LCDproc. Since that time various people have contributed to LCDproc.
docs/Makefile.am
+4 -1
View File
@@ -12,11 +12,14 @@ EXTRA_DIST = README.dg \
netstuff.txt \ netstuff.txt \
lcdproc.1 \ lcdproc.1 \
lcdexec.1 \ lcdexec.1 \
LCDd.8 \ LCDd.8.in \
lcdproc-config.5.in \ lcdproc-config.5.in \
$(doxygen_input) $(doxygen_input)
## generate man pages ## generate man pages
LCDd.8: LCDd.8.in
sed -e 's#@SYSCONFDIR@#@sysconfdir@#' $< > $@
lcdproc-config.5: lcdproc-config.5.in lcdproc-config.5: lcdproc-config.5.in
sed -e 's#@SYSCONFDIR@#@sysconfdir@#' $< > $@ sed -e 's#@SYSCONFDIR@#@sysconfdir@#' $< > $@