doc update

This commit is contained in:
marschap
2006-10-02 21:35:27 +00:00
parent 960b039b98
commit 3aa5832267
3 changed files with 212 additions and 217 deletions
+205 -169
View File
@@ -89,78 +89,94 @@ settings for the LCDproc server <application>LCDd</application>.
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>Driver=</term> <term>
<listitem> <command>Driver=</command>
<para> <arg choice="plain"><replaceable>DRIVERNAME</replaceable></arg>
</term>
<listitem><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> If not specified <replaceable>DRIVERNAME</replaceable>
<note> defaults to <literal>curses</literal>, a driver that is supposed
<para> to work on any half-way decent UNIX console.
The default setting is Driver=none which makes the server exit right </para></listitem>
after the start. This is neccessary to avoid trouble with package installations.
</para>
</note>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Bind=</term> <term>
<listitem> <command>Bind=</command>
<para> <arg choice="plain"><replaceable>ADDRESS</replaceable></arg>
Tells the server to bind to the given interface. Default to Bind=127.0.0.1 which </term>
<listitem><para>
Tells the server to bind to the given local IP address and listen for incoming client connections.
The default value for <replaceable>ADDRESS</replaceable> is <literal>127.0.0.1</literal>, which
is actually the safest variant. is actually the safest variant.
</para> </para></listitem>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Port=</term> <term>
<listitem> <command>Port=</command>
<para> <arg choice="plain"><replaceable>PORTNUMBER</replaceable></arg>
Tells the server to listen to this specified port; defaults to 13666.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ReportLevel=</term>
<listitem>
<para>
Sets the reporting level; defaults to 2 (warnings and errors only).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ReportToSyslog=</term>
<listitem>
<para>
Should we report to syslog instead of stderr ? Defaults to no.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>WaitTime=
</term> </term>
<listitem> <listitem><para>
<para> Tells the server to listen to this specified port.
If not specified <replaceable>PORTNUMBER</replaceable> defaults to <literal>13666</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>ReportLevel=</command>
<arg choice="plain"><replaceable>LEVEL</replaceable></arg>
</term>
<listitem><para>
Sets the reporting level.
Legal values for <replaceable>LEVEL</replaceable> range from <literal>0</literal>
(only critical errors) to <literal>5</literal> (everything including debugging information).
If not specified it defaults to <literal>2</literal> (warnings and errors only).
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>ReportToSyslog=</command>
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
<arg choice="plain"><literal>yes</literal></arg>
</group>
</arg>
</term>
<listitem><para>
Should we report to <filename>syslog</filename> instead of <filename>stderr</filename>?
Default value is <literal>no</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>WaitTime=</command>
<arg choice="plain"><replaceable>SECONDS</replaceable></arg>
</term>
<listitem><para>
Sets the default time in seconds to display a screen. Sets the default time in seconds to display a screen.
</para> If not specified the default value for <replaceable>SECONDS</replaceable> is <literal>4</literal>.
</listitem> </para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>User= <term>
<command>User=</command>
<arg choice="plain"><replaceable>USER</replaceable></arg>
</term> </term>
<listitem> <listitem>
<para> <para>
User to run as. LCDd will drop its root privileges, User to run as. When started as root LCDd will drop its privileges,
if any, and run as this user instead. Defaults to User=nobody. and run as this user instead. Defaults to <literal>nobody</literal>.
</para> </para>
<!--
<note> <note>
<para> <para>
If you want to use the server menu, to shutdown or reboot your system, If you want to use the server menu, to shutdown or reboot your system,
@@ -168,31 +184,43 @@ settings for the LCDproc server <application>LCDd</application>.
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>
<command>ServerScreen=</command>
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>yes</emphasis></literal></arg>
<arg choice="plain"><literal>no</literal></arg>
</group>
</arg>
</term> </term>
<listitem> <listitem><para>
<para> Include the server screen, that shows the number of active clients and screens,
Enables the server screen even when other screens are active. Defaults to into the screen rotation scheme when other screens exist.
no. Defaults to <literal>yes</literal>.
</para> </para></listitem>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Foreground=</term> <term>
<listitem> <command>Foreground=</command>
<para> <arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
<arg choice="plain"><literal>yes</literal></arg>
</group>
</arg>
</term>
<listitem><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 <literal>no</literal>.
</para> </para></listitem>
</listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
@@ -202,50 +230,54 @@ don't go to any client.
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>ToggleRotateKey=</term> <term>
<listitem> <command>ToggleRotateKey=</command>
<para> <arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<listitem><para>
Defaults to <literal>Enter</literal>. Defaults to <literal>Enter</literal>.
</para> </para></listitem>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>PrevScreenKey=</term> <term>
<listitem> <command>PrevScreenKey=</command>
<para> <arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<listitem><para>
Defaults to <literal>Left</literal>. Defaults to <literal>Left</literal>.
</para> </para></listitem>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>NextScreenKey=</term> <term>
<listitem> <command>NextScreenKey=</command>
<para> <arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<listitem><para>
Defaults to <literal>Right</literal>. Defaults to <literal>Right</literal>.
</para> </para></listitem>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>ScrollUpKey=</term> <term>
<listitem> <command>ScrollUpKey=</command>
<para> <arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<listitem><para>
Defaults to <literal>Up</literal>. Defaults to <literal>Up</literal>.
</para> </para></listitem>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>ScrollDownKey=</term> <term>
<listitem> <command>ScrollDownKey=</command>
<para> <arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<listitem><para>
Defaults to <literal>Down</literal>. Defaults to <literal>Down</literal>.
</para> </para></listitem>
</listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
@@ -307,97 +339,98 @@ input "events".
<entry>Forward (Go to next screen)</entry> <entry>Forward (Go to next screen)</entry>
<entry>Right</entry> <entry>Right</entry>
</row> </row>
<row>
<entry>MenuKey</entry>
<entry>Open main menu</entry>
<entry>Exit/Cancel</entry>
</row>
</tbody> </tbody>
</tgroup> </tgroup>
</table> </table>
--> -->
<para> <para>
The menu is an LCDproc client built into <application>rLCDd</application>. The menu is an LCDproc client built into <application>LCDd</application>.
You can configure what keys the menu should use. Note that the MenuKey You can configure what keys the menu should use.
will be reserved exclusively, the others work in shared mode. Note that the <literal>MenuKey</literal> will be reserved exclusively,
while the others work in shared mode.
</para> </para>
<variablelist> <variablelist>
<varlistentry>
<term>
<command>MenuKey=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<listitem><para>
The key that switches into menu mode (=open 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>Menu</literal>.
</para></listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term>MenuKey=</term> <term>
<listitem> <command>EnterKey=</command>
<para> <arg choice="plain"><replaceable>KEY</replaceable></arg>
The key that switches into menu mode (=opens the main menu). </term>
In menu mode it cancels any operation. Cancelling the main menu <listitem><para>
means returning to the regular display mode. The key to enter a sub menu and/or, to select an entry.
It defaults to <literal>Escape</literal>. It defaults to <literal>Enter</literal>.
</para> </para></listitem>
</listitem> </varlistentry>
</varlistentry>
<varlistentry> <varlistentry>
<term>EnterKey=</term> <term>
<listitem> <command>UpKey=</command>
<para> <arg choice="plain"><replaceable>KEY</replaceable></arg>
The key to enter a sub menu and/or, to select an entry. </term>
It defaults to <literal>Enter</literal>. <listitem><para>
</para> The key to move to the previous menu item.
</listitem> If the <replaceable>LeftKey</replaceable> is not set,
</varlistentry> it is also used to move left in input fields.
It default to <literal>Up</literal>.
</para></listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term>UpKey=</term> <term>
<listitem> <command>DownKey=</command>
<para> <arg choice="plain"><replaceable>KEY</replaceable></arg>
The key to move to the previous menu item. </term>
If the <replaceable>LeftKey</replaceable> is not set, <listitem><para>
it is also used to move left in input fields. The key to move to the next menu item.
It default to <literal>Up</literal>. If the <replaceable>RightKey</replaceable> is not set,
</para> it is also used to move right in input fields.
</listitem> It default to <literal>Down</literal>.
</varlistentry> </para></listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term>DownKey=</term> <term>
<listitem> <command>LeftKey=</command>
<para> <arg choice="plain"><replaceable>KEY</replaceable></arg>
The key to move to the next menu item. </term>
If the <replaceable>RightKey</replaceable> is not set, <listitem><para>
it is also used to move right in input fields. If defined, this optional key is used to
It default to <literal>Down</literal>. to move left in input fields and to select submenu entries.
</para> It is not set by default, but if you have more than 4 keys,
</listitem> a natural candidate is <literal>Left</literal>.
</varlistentry> </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>
<varlistentry>
<term>
<command>RightKey=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</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> </variablelist>
</sect2> </sect2>
<sect2 id="driver-section"> <sect2 id="driver-section">
<title><filename>LCDd.conf</filename>: The Driver Section</title> <title><filename>LCDd.conf</filename>: The Driver Section</title>
@@ -407,14 +440,17 @@ As mentioned earlier, each driver has its own section in the
</para> </para>
<para> <para>
The settings are more or less self-explanatory. So, read through the Although the settings are more or less self-explanatory,
section of your driver and change everything neccessary. they are explained in the next chapter in the section for each driver.
So, read through the section of your driver and changei
everything neccessary.
</para> </para>
</sect2> </sect2>
</sect1> </sect1>
<sect1 id="init-scripts"> <sect1 id="init-scripts">
<title>The LCDproc Init Scripts</title> <title>The LCDproc Init Scripts</title>
+4 -4
View File
@@ -26,19 +26,19 @@ lcdm001 chipset.
<varlistentry> <varlistentry>
<term> <term>
<command>PauseKey=<replaceable>LeftKey</replaceable></command> <command>PauseKey=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg> <arg choice="plain"><replaceable>KEY</replaceable></arg>
</term> </term>
<term> <term>
<command>BackKey=<replaceable>UpKey</replaceable></command> <command>BackKey=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg> <arg choice="plain"><replaceable>KEY</replaceable></arg>
</term> </term>
<term> <term>
<command>ForwardKey=<replaceable>DownKey</replaceable></command> <command>ForwardKey=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg> <arg choice="plain"><replaceable>KEY</replaceable></arg>
</term> </term>
<term> <term>
<command>MainMenuKey=<replaceable>RightKey</replaceable></command> <command>MainMenuKey=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg> <arg choice="plain"><replaceable>KEY</replaceable></arg>
</term> </term>
<listitem> <listitem>
+3 -44
View File
@@ -69,47 +69,6 @@ Then you have to modify the [lirc] section of your
<filename>LCDd.conf</filename>. <filename>LCDd.conf</filename>.
</para> </para>
<sect3 id="lirc-section">
<title><filename>LCDd.conf</filename>: The [lirc] Section</title>
<para>
The [lirc] section of the <filename>LCDd.conf</filename> contains the
settings for the lirc LCDproc driver.
</para>
<variablelist>
<varlistentry>
<term>lircrc=</term>
<listitem>
<para>
<anchor id="which-lircrc" />Normally all LIRC clients scan the file <filename>~/.lircrc</filename>.
However, you might want to have a separate file to configure the
LCDproc lirc driver only.
</para>
<para>
This option enables you to specify the file you want the lirc
driver to scan.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>prog=</term>
<listitem>
<para>
All LIRC keys are assigned to a program using the prog=... option
in the <filename>~/.lircrc</filename> (or the file you have specified
with lircrc=...).
</para>
<para>
The prog=... line must be the same as in your <filename>~/.lircrc</filename>
(or the file you have specified with lircrc=...).
</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<!-- ## LIRC input driver ## --> <!-- ## LIRC input driver ## -->
<sect2 id="lirc-config"> <sect2 id="lirc-config">
@@ -143,8 +102,8 @@ The prog=... line must be the same as in your <filename>~/.lircrc</filename>
</term> </term>
<listitem> <listitem>
<para> <para>
All LIRC keys are assigned to a program using the prog=... option All LIRC keys are assigned to a program using the <literal>prog=...</literal>
in the lirc configuration file. directive in the lirc configuration file.
</para> </para>
<para> <para>
<replaceable>PROGRAM</replaceable> must be the same as in iyour lirc <replaceable>PROGRAM</replaceable> must be the same as in iyour lirc
@@ -175,7 +134,7 @@ lines to the file:
</para> </para>
<example> <example>
<title><filename>~/.lircrc</filename>: Specify the associations from buttons to keysi <title><filename>~/.lircrc</filename>: Specify the associations from buttons to keys
for the lirc driver</title> for the lirc driver</title>
<programlisting> <programlisting>