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

next round of documentation update

Browse Source
This commit is contained in:
marschap
2006-09-30 22:36:31 +00:00
parent 9a5915a214
commit 13533f49cc
3 changed files with 317 additions and 195 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/lcdproc-user/configuration.docbook
+235 -152
View File
@@ -89,121 +89,179 @@ settings for the LCDproc server <application>LCDd</application>.
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>Driver=</term> <term>Driver=</term>
<listitem> <listitem>
<para> <para>
Tells the server which driver(s) to use. See Tells the server which driver(s) to use. See
<link linkend="which-driver">above</link> for details <link linkend="which-driver">above</link> for details
</para> </para>
<note> <note>
<para> <para>
The default setting is Driver=none which makes the server exit right The default setting is Driver=none which makes the server exit right
after the start. This is neccessary to avoid trouble with package installations. after the start. This is neccessary to avoid trouble with package installations.
</para> </para>
</note> </note>
</listitem> </listitem>
</varlistentry>
<varlistentry>
<term>Bind=</term>
<listitem>
<para>
Tells the server to bind to the given interface. Default to Bind=127.0.0.1 which
is actually the safest variant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Port=</term>
<listitem>
<para>
Tells the server to listen to this specified port; defaults to 13666.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>ReportLevel=</term> <term>Bind=</term>
<listitem> <listitem>
<para> <para>
Sets the reporting level; defaults to 2 (warnings and errors only). Tells the server to bind to the given interface. Default to Bind=127.0.0.1 which
</para> is actually the safest variant.
</listitem> </para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>ReportToSyslog=</term> <term>Port=</term>
<listitem> <listitem>
<para> <para>
Should we report to syslog instead of stderr ? Defaults to no. Tells the server to listen to this specified port; defaults to 13666.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>WaitTime= <term>ReportLevel=</term>
</term> <listitem>
<listitem> <para>
<para> Sets the reporting level; defaults to 2 (warnings and errors only).
Sets the default time in seconds to display a screen. </para>
</para> </listitem>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>User= <term>ReportToSyslog=</term>
</term> <listitem>
<listitem> <para>
<para> Should we report to syslog instead of stderr ? Defaults to no.
User to run as. LCDd will drop its root privileges, </para>
if any, and run as this user instead. Defaults to User=nobody. </listitem>
</para> </varlistentry>
<note>
<para> <varlistentry>
If you want to use the server menu, to shutdown or reboot your system, <term>WaitTime=
</term>
<listitem>
<para>
Sets the default time in seconds to display a screen.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>User=
</term>
<listitem>
<para>
User to run as. LCDd will drop its root privileges,
if any, and run as this user instead. Defaults to User=nobody.
</para>
<note>
<para>
If you want to use the server menu, to shutdown or reboot your system,
you will have to set this to root. Otherwise LCDd does not have the you will have to set this to root. Otherwise LCDd does not have the
privileges to run commands like <command>init 6</command>. privileges to run commands like <command>init 6</command>.
</para> </para>
</note> </note>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>ServerScreen= <term>ServerScreen=
</term> </term>
<listitem> <listitem>
<para> <para>
Enables the server screen even when other screens are active. Defaults to Enables the server screen even when other screens are active. Defaults to
no. no.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Foreground=</term> <term>Foreground=</term>
<listitem> <listitem>
<para> <para>
The server will stay in the foreground if set to true. The server will stay in the foreground if set to true.
Otherwise the server will fork to background and report Otherwise the server will fork to background and report
to syslog. Defaults to yes. to syslog. Defaults to yes.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
<para>
The "...Key=" lines define what the server does with keypresses that
don't go to any client.
</para>
<variablelist>
<varlistentry>
<term>ToggleRotateKey=</term>
<listitem>
<para>
Defaults to <literal>Enter</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PrevScreenKey=</term>
<listitem>
<para>
Defaults to <literal>Left</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>NextScreenKey=</term>
<listitem>
<para>
Defaults to <literal>Right</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ScrollUpKey=</term>
<listitem>
<para>
Defaults to <literal>Up</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ScrollDownKey=</term>
<listitem>
<para>
Defaults to <literal>Down</literal>.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</sect2> </sect2>
<sect2 id="input-section"> <sect2 id="menu-section">
<title><filename>LCDd.conf</filename>: The [input] Section</title> <title><filename>LCDd.conf</filename>: The [menu] Section</title>
<para> <para>
The [input] section enables you to set some general ("global") The [menu] section enables you to set some general ("global")
options related to the way <application>LCDd</application> handles options related to the way <application>LCDd</application> handles
input "events". input "events".
</para> </para>
<!--
<table> <table>
<title>The Standard LCDd Input Keys</title> <title>The Standard LCDd Input Keys</title>
<tgroup cols="3"> <tgroup cols="3">
@@ -220,98 +278,123 @@ input "events".
</thead> </thead>
<tbody> <tbody>
<row> <row>
<entry>PauseKey</entry> <entry>MenuKey</entry>
<entry>Pause/Continue</entry> <entry>Open main menu</entry>
<entry>Enter/select</entry> <entry>Exit/Cancel</entry>
</row> </row>
<row> <row>
<entry>BackKey</entry> <entry>EnterKey</entry>
<entry>Toggle Hold/Rotate screens</entry>
<entry>Enter/Select</entry>
</row>
<row>
<entry>UpKey</entry>
<entry>Back (Go to previous screen)</entry> <entry>Back (Go to previous screen)</entry>
<entry>Up/Left</entry> <entry>Up/Left</entry>
</row> </row>
<row> <row>
<entry>ForwardKey</entry> <entry>DownKey</entry>
<entry>Forward (Go to next screen)</entry> <entry>Forward (Go to next screen)</entry>
<entry>Down/Right</entry> <entry>Down/Right</entry>
</row> </row>
<row> <row>
<entry>MainMenuKey</entry> <entry>LeftKey</entry>
<entry>Back (Go to previous screen)</entry>
<entry>Left</entry>
</row>
<row>
<entry>RightKey</entry>
<entry>Forward (Go to next screen)</entry>
<entry>Right</entry>
</row>
<row>
<entry>MenuKey</entry>
<entry>Open main menu</entry> <entry>Open main menu</entry>
<entry>Exit/Cancel</entry> <entry>Exit/Cancel</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
</table> </table>
-->
<note>
<para>
The way input keys are handled will change completely in LCDproc 0.5.
</para>
</note>
<sect3 id="freekeyoptions">
<title><filename>LCDd.conf</filename>: [input] Section: The Free*Key Options</title>
<para> <para>
The Free*Key Options are interesting for those users whose keypad (or other input source) The menu is an LCDproc client built into <application>rLCDd</application>.
has got only four (or less) keys. In this case LCDd would normally use all those You can configure what keys the menu should use. Note that the MenuKey
keys to enable you to control the server menu and the other server functions (like will be reserved exclusively, the others work in shared mode.
switching to the next screen). If these keys are used by a client to do anything
but noticing that the user has e.g. entered the menu or switched to another screen,
this will probably cause trouble, as one keypress has several effects at the same
time.
</para>
<para>
The Free*Key options enable you to influence this behaviour.
</para> </para>
<variablelist> <variablelist>
<varlistentry>
<term>FreePauseKey=</term>
<listitem>
<para>
If set to yes, this prevents LCDd from handling the PauseKey itself.
Then a client can request the key 'A' and handle it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>FreeBackKey=</term>
<listitem>
<para>
If set to yes, this prevents LCDd from handling the BackKey itself.
Then a client can request the key 'B' and handle it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>FreeForwardKey=</term>
<listitem>
<para>
If set to yes, this prevents LCDd from handling the ForwardKey itself.
Then a client can request the key 'C' and handle it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>FreeMainMenuKey=</term>
<listitem>
<para>
If set to yes, this prevents LCDd from handling the MainMenuKey itself.
Then a client can request the key 'D' and handle it.
</para>
<tip>
<para>
Even if you "free" the above keys, you can still use the menu
provided you set FreeMainMenuKey to no.
</para>
</tip>
</listitem>
</varlistentry>
</variablelist>
</sect3> <varlistentry>
<term>MenuKey=</term>
<listitem>
<para>
The key that switches into menu mode (=opens the main menu).
In menu mode it cancels any operation. Cancelling the main menu
means returning to the regular display mode.
It defaults to <literal>Escape</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>EnterKey=</term>
<listitem>
<para>
The key to enter a sub menu and/or, to select an entry.
It defaults to <literal>Enter</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>UpKey=</term>
<listitem>
<para>
The key to move to the previous menu item.
If the <replaceable>LeftKey</replaceable> is not set,
it is also used to move left in input fields.
It default to <literal>Up</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>DownKey=</term>
<listitem>
<para>
The key to move to the next menu item.
If the <replaceable>RightKey</replaceable> is not set,
it is also used to move right in input fields.
It default to <literal>Down</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>LeftKey=</term>
<listitem>
<para>
If defined, this optional key is used to
to move left in input fields and to select submenu entries.
It is not set by default, but if you have more than 4 keys,
a natural candidate is <literal>Left</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>RightKey=</term>
<listitem>
<para>
If defined, this optional key is used to to move right in input fields.
It is not set by default, but if you have more than 4 keys,
a natural candidate is <literal>Right</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2> </sect2>
@@ -393,7 +476,7 @@ sources distribution).
# Set SCREENS to the screens you want lcdproc to send to LCDd # Set SCREENS to the screens you want lcdproc to send to LCDd
# lcdproc --help will give you a list of the screens available # lcdproc --help will give you a list of the screens available
SCREENS="C X" SCREENS="C L"
</programlisting> </programlisting>
</example> </example>
docs/lcdproc-user/drivers/CwLnx.docbook
+35 -2
View File
@@ -2,10 +2,43 @@
<title>The CwLnx Driver</title> <title>The CwLnx Driver</title>
<para> <para>
This section talks about using LCDproc with LCD displays that use the This section talks about using LCDproc with the serial / USB LCDs CW12232
CwLnx chipset. by CwLinux.
</para> </para>
<sect2 id="CwLnx-features">
<title>Features</title>
<para>
The CwLinux CW12232 LCDs are graphical LCDs with 122 x 32 dots
that also have a text mode with 20 x 4 characters.
The modules can be ordered bare or as part of a kit mounted
on brackets that fit in half-height 5.25" drive bays.
The mounting brackets optionally feature a 6 button keypad that
makes use of the keypad connector on the display modules.
</para>
<para>
The kits allow to programmatically switch on/off their backlight.
Newer revisions of the kits also have programmable brighness as well
as 4 general purpose IO ports.
</para>
<para>
The CW12232 come in 2 variants that differ how they communicate with the host:
The serial modules are connected to the PC using a serial RS232 connection getting
operating power using the standard floppy drive power connector,
while the USB modules only require an USB connection.
</para>
<para>
For more information see the
<ulink url="http://www.cwlinux.com">CwLinux web site</ulink>
</para>
</sect2>
<!-- ## Cwlinux driver ## --> <!-- ## Cwlinux driver ## -->
<sect2 id="CwLnx-config"> <sect2 id="CwLnx-config">
<title>Configuration in LCDd.conf</title> <title>Configuration in LCDd.conf</title>
docs/lcdproc-user/running.docbook
+16 -10
View File
@@ -48,21 +48,22 @@ running LCDd from the source directory, e.g. after building.
<para> <para>
Running <command>LCDd -h</command> gives you an overview of the currently available Running <command>LCDd -h</command> gives you an overview of the currently available
command line options, including a list of the compiled in drivers. command line options.
</para> </para>
<example> <example>
<title><command>LCDd -h</command></title> <title><command>LCDd -h</command></title>
<screen> <![CDATA[ <screen> <![CDATA[
LCDd: LCDproc Server Daemon, 0.5dev LCDd - LCDproc Server Daemon, 0.5dev
Copyright (c) 1999-2006 Scott Scriven, William Ferrell, and misc contributors
This program is freely redistributable under the terms of the GNU Public License Copyright (c) 1999-2006 Scott Scriven, William Ferrell, and misc. contributors.
This program is released under the terms of the GNU General Public License.
Usage: LCDd [<options>] Usage: LCDd [<options>]
where <options> are: where <options> are:
-h Display this help screen -h Display this help screen
-c <config> Use a configuration file other than /etc/LCDd.conf -c <config> Use a configuration file other than /etc/lcdproc/LCDd.conf
-d <driver> Add a driver to use (overrides drivers in config file) [curses] -d <driver> Add a driver to use (overrides drivers in config file) [curses]
-f Run in the foreground -f Run in the foreground
-a <addr> Network (IP) address to bind to [127.0.0.1] -a <addr> Network (IP) address to bind to [127.0.0.1]
@@ -101,23 +102,28 @@ command line options.
<title><command>lcdproc -h</command></title> <title><command>lcdproc -h</command></title>
<screen> <![CDATA[ <screen> <![CDATA[
Usage: lcdproc [<options>] [<modes> ...] lcdproc - LCDproc system status information viewer
Copyright (c) 1999-2006 Scott Scriven, William Ferrell, and misc. contributors.
This program is released under the terms of the GNU General Public License.
Usage: lcdproc [<options>] [<screens> ...]
where <options> are where <options> are
-s <host> connect to LCDd daemon on <host> -s <host> connect to LCDd daemon on <host>
-p <port> connect to LCDd daemon using <port> -p <port> connect to LCDd daemon using <port>
-f run in foreground -f run in foreground
-e <delay> slow down initial announcement of modes (in 1/100s) -e <delay> slow down initial announcement of screens (in 1/100s)
-c <config> use a configuration file other than /etc/lcdproc.conf -c <config> use a configuration file other than /etc/lcdproc/lcdproc.conf
-h show this help screen -h show this help screen
-v display program version -v display program version
and <modes> are and <screens> are
C CPU detailed CPU usage C CPU detailed CPU usage
P SMP-CPU CPU usage overview (one line per CPU) P SMP-CPU CPU usage overview (one line per CPU)
G CPUGraph CPU usage histogram G CPUGraph CPU usage histogram
L Load load histogram L Load load histogram
M Memory memory & swap usage M Memory memory & swap usage
S ProcSize biggest processes size S ProcSize biggest processes size
D Disk disk usage D Disk filling level of mounted file systems
I Iface network interface usage I Iface network interface usage
B Battery battery status B Battery battery status
T TimeDate time & date information T TimeDate time & date information