document DriverPath=, use more DocBook tags, various updates

This commit is contained in:
marschap
2007-04-02 21:39:40 +00:00
parent 6a1511bb72
commit c109e27930
4 changed files with 75 additions and 55 deletions
+3 -2
View File
@@ -31,8 +31,8 @@
</authorgroup> </authorgroup>
<date>2006-10-06</date> <date>2007-04-02</date>
<releaseinfo>0.0.3</releaseinfo> <releaseinfo>0.0.4</releaseinfo>
<abstract> <abstract>
<para> <para>
@@ -42,6 +42,7 @@ This document is a guide to LCDproc written for users. It covers LCDproc 0.5.x
<copyright> <copyright>
<year>2006</year> <year>2006</year>
<year>2007</year>
<holder>Peter Marschall</holder> <holder>Peter Marschall</holder>
</copyright> </copyright>
<copyright> <copyright>
+58 -41
View File
@@ -6,57 +6,60 @@
<para> <para>
As mentioned in the <link linkend="introduction">introduction</link> As mentioned in the <link linkend="introduction">introduction</link>
LCDd, the LCDproc server, now (with version 0.4.3 of LCDproc) has its <application>LCDd</application>, the LCDproc server, has its own configuration file,
own configuration file, which is normally <filename>/etc/LCDd.conf</filename>. which is usually <filename>/etc/LCDd.conf</filename>.
</para> </para>
<note> <note>
<para> <para>
If you have not installed LCDproc from the sources the configuration If you have not installed <package>LCDproc</package> from the sources the configuration
file might have a different location. You should find it when making file might have a different location. You should be able to find it by making
your system's package manager list all the files in the LCDproc package. your system's package manager list all the files in the <package>LCDproc</package> package.
</para> </para>
</note> </note>
<para> <para>
The format of the <filename>/etc/LCDd.conf</filename> is ini-file-like. The format of the <filename>/etc/LCDd.conf</filename> is ini-file-like.
</para> </para>
<para> <para>
It is divided into sections that start at It is divided into sections that start at markers that look like
markers that look like [section]. Comments are all line-based comments, <code>[<replaceable>section</replaceable>]</code>.
and are lines that start with '#' or ';'. Comments are all line-based comments,
and are lines that start with '<literal>#</literal>' or '<literal>;</literal>'.
</para> </para>
<para> <para>
The server has a 'central' section named [Server]. Further each driver The server has a 'central' section named <code>[Server]</code>.
has a section which defines how the driver acts. Those sections start with Further each driver has a section which defines how the driver acts.
[drivername]. Those sections start with <code>[<replaceable>drivername</replaceable>]</code>.
</para>
<para>
<anchor id="which-driver" />The drivers are activated by specifiying them in a driver= line in the
server section, like:
</para> </para>
<example> <para>
<anchor id="which-driver" />The drivers are activated by specifiying them in a <code>Driver=</code>
line in the server section, like:
</para>
<example id="configure-lcdd.example">
<title><filename>LCDd.conf</filename>: Specify which driver to use</title> <title><filename>LCDd.conf</filename>: Specify which driver to use</title>
<programlisting> <programlisting>
[Server]
Driver=curses Driver=curses
</programlisting> </programlisting>
</example> </example>
<para> <para>
This tells LCDd to use the curses driver. The first driver specified here This tells <application>LCDd</application> to use the <literal>curses</literal> driver.
that is capable of output functionality will be used as 'the' output driver. The first driver specified here that is capable of output functionality
All extra drivers can only serve as input. will be used as <emphasis>the</emphasis> output driver.
The default driver to use is curses. All other drivers can only serve as input drivers.
The default driver to use is <literal>curses</literal>.
</para> </para>
<warning> <warning>
<para> <para>
If LCDd is started automatically by an init-script using the curses driver If LCDd is started automatically by an init-script using the curses driver,
will lock <filename>/dev/tty1</filename>! So, be careful about what you are it will lock <filename>/dev/tty1</filename>! So, be careful about what you are
doing here. doing here.
</para> </para>
</warning> </warning>
@@ -72,23 +75,35 @@ For this purpose they use the config sections that are named like the driver.
<note> <note>
<para> <para>
The -d option still works, but does not allow driverargs any more. If <option>-d</option> is specified on the command line, the
</para> <code>Driver=</code> options in the configuration file are ignored.
<para>
If -d is specified on the command line, the Driver= options in the
config file are ignored.
</para> </para>
</note> </note>
<sect2 id="server-section"> <sect2 id="server-section">
<title id="server-section.title"><filename>LCDd.conf</filename>: The [Server] Section</title> <title id="server-section.title"><filename>LCDd.conf</filename>: The <code>[Server]</code> Section</title>
<para> <para>
The [server] section of the <filename>LCDd.conf</filename> contains the The <code>[Server]</code> section of the <filename>LCDd.conf</filename> contains the
settings for the LCDproc server <application>LCDd</application>. settings for the LCDproc server <application>LCDd</application>.
</para> </para>
<variablelist> <variablelist>
<varlistentry>
<term>
<command>DriverPath=</command>
<arg choice="plain"><replaceable>DRIVERPATH</replaceable></arg>
</term>
<listitem><para>
Tells the server where to look for the driver files.
See <link linkend="which-driver">above</link> for details.
If not specified <replaceable>DRIVERPATH</replaceable>
defaults to the empty string, resulting in drivers being
searched
in the directory LCDd is started in.
</para></listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<command>Driver=</command> <command>Driver=</command>
@@ -254,11 +269,13 @@ settings for the LCDproc server <application>LCDd</application>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<para> <para>
The "...Key=" lines define what the server does with keypresses that The <code>&hellip;Key=</code> lines define what the server does with keypresses that
don't go to any client. don't go to any client.
</para> </para>
@@ -318,10 +335,10 @@ don't go to any client.
</sect2> </sect2>
<sect2 id="menu-section"> <sect2 id="menu-section">
<title id="menu-section.title"><filename>LCDd.conf</filename>: The [Menu] Section</title> <title id="menu-section.title"><filename>LCDd.conf</filename>: The <code>[Menu]</code> Section</title>
<para> <para>
The [Menu] section enables you to set some general ("global") The <code>[Menu]</code> 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>
@@ -488,8 +505,12 @@ everything neccessary.
<title>The LCDproc Init Scripts</title> <title>The LCDproc Init Scripts</title>
<para> <para>
The LCDproc distribution contains init scripts for RedHat- and Debian-based The <package>LCDproc</package> distribution contains init scripts for
GNU/Linux distributions. You can find them in the <filename>scripts/</filename> <acronym>LSB</acronym> 3.1 (Linux Standard Base 3.1) conforming
GNU/Linux distributions.
In addition to those it contains init scripts for older RedHat- and Debian-based
distributions that do not adhere to LSB 3.1.
You can find iall of them in the <filename>scripts/</filename>
directory of the LCDproc sources. directory of the LCDproc sources.
</para> </para>
@@ -519,10 +540,6 @@ LCDproc server LCDd. It does not require modification.
The file <filename>scripts/init-lcdproc.*</filename> is the init script for the The file <filename>scripts/init-lcdproc.*</filename> is the init script for the
LCDproc "main" client lcdproc. LCDproc "main" client lcdproc.
</para> </para>
<!--
As lcdproc itself does not (yet) have a configuration file
you may want to modify the options the init script passes to lcdproc.
-->
<note> <note>
<para> <para>
@@ -539,8 +556,8 @@ sources distribution).
<example> <example>
<title><filename>lcdproc.conf</filename>: Modify the option passed to lcdproc</title> <title><filename>lcdproc.conf</filename>: Modify the option passed to lcdproc</title>
<programlisting>
<programlisting>
# /etc/lcdproc.conf # /etc/lcdproc.conf
# #
# Configuration file of the main LCDproc client "lcdproc" # Configuration file of the main LCDproc client "lcdproc"
+2 -1
View File
@@ -109,7 +109,8 @@ you should (you don't have to) copy them to another place on your machine:
<title>apt-get</title> <title>apt-get</title>
<para> <para>
Debian GNU/Linux users can get the debian package of LCDproc, which is in the unstable and testing distributions. Debian GNU/Linux users can get the Debian package of <package>LCDproc</package>,
which is in the unstable and testing distributions.
</para> </para>
<para> <para>
+12 -11
View File
@@ -5,20 +5,21 @@
<title>Build LCDproc</title> <title>Build LCDproc</title>
<para> <para>
Now that you have downloaded the LCDproc distribution you can Now that you have downloaded the <package>LCDproc</package> distribution you can
start building it. start building it.
</para> </para>
<note> <note>
<para> <para>
If you have installed the debian package with apt-get (or another If you have installed the Debian package with <application>apt-get</application>
debian tool), you can skip this this chapter. (or another Debian package management tool), you can skip this this chapter.
</para> </para>
</note> </note>
<para> <para>
If you're building this version from CVS, you'll need If you're building this version from CVS, you'll need
autoconf, automake, aclocal &amp; autoheader installed. <application>autoconf</application>, <application>automake</application>,
<application>aclocal</application> and <application>autoheader</application> installed.
</para> </para>
<para> <para>
@@ -30,8 +31,8 @@ If you have autoconf and friends, run:
</screen> </screen>
<para> <para>
This produces the configure script and supporting files. It has already This produces the configure script and supporting files.
been run if you are using the tarball distribution. It has already been run if you are using the tarball distribution.
</para> </para>
<para> <para>
@@ -51,9 +52,9 @@ Read about the options, figure out what to use.
</screen> </screen>
<para> <para>
Be sure to replace /usr/local with the prefixdir you want (e.g. /usr Be sure to replace <filename>/usr/local</filename> with the prefixdir you want
for RedHat) and curses,CFontz with comma-separated list (e.g. <filename>/usr</filename> for RedHat) and <code>curses,CFontz</code> with
of drivers you want. the comma-separated list of drivers you want to have compiled.
</para> </para>
<screen> <screen>
@@ -61,7 +62,7 @@ of drivers you want.
</screen> </screen>
<para> <para>
Congratulations: You have just compiled your version of LCDproc ;) Congratulations: You have just compiled your version of <package>LCDproc</package> ;)
</para> </para>
</sect1> </sect1>
@@ -82,7 +83,7 @@ can run:
<note> <note>
<para> <para>
make install is absolutely OPTIONAL <command>make install</command> is absolutely OPTIONAL
You can also run LCDproc directly from the source directory. See You can also run LCDproc directly from the source directory. See
<link linkend="lcdd-commandline">below</link> for details. <link linkend="lcdd-commandline">below</link> for details.
</para> </para>