diff --git a/docs/lcdproc-user/bookinfo.docbook b/docs/lcdproc-user/bookinfo.docbook index 8cce3c7..f191068 100644 --- a/docs/lcdproc-user/bookinfo.docbook +++ b/docs/lcdproc-user/bookinfo.docbook @@ -31,8 +31,8 @@ -2006-10-06 -0.0.3 +2007-04-02 +0.0.4 @@ -42,6 +42,7 @@ This document is a guide to LCDproc written for users. It covers LCDproc 0.5.x 2006 +2007 Peter Marschall diff --git a/docs/lcdproc-user/configuration.docbook b/docs/lcdproc-user/configuration.docbook index f9da997..25148c8 100644 --- a/docs/lcdproc-user/configuration.docbook +++ b/docs/lcdproc-user/configuration.docbook @@ -6,57 +6,60 @@ As mentioned in the introduction -LCDd, the LCDproc server, now (with version 0.4.3 of LCDproc) has its -own configuration file, which is normally /etc/LCDd.conf. +LCDd, the LCDproc server, has its own configuration file, +which is usually /etc/LCDd.conf. -If you have not installed LCDproc from the sources the configuration -file might have a different location. You should find it when making -your system's package manager list all the files in the LCDproc package. +If you have not installed LCDproc from the sources the configuration +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. The format of the /etc/LCDd.conf is ini-file-like. + -It is divided into sections that start at -markers that look like [section]. Comments are all line-based comments, -and are lines that start with '#' or ';'. +It is divided into sections that start at markers that look like +[section]. +Comments are all line-based comments, +and are lines that start with '#' or ';'. -The server has a 'central' section named [Server]. Further each driver -has a section which defines how the driver acts. Those sections start with -[drivername]. - - -The drivers are activated by specifiying them in a driver= line in the -server section, like: +The server has a 'central' section named [Server]. +Further each driver has a section which defines how the driver acts. +Those sections start with [drivername]. - + +The drivers are activated by specifiying them in a Driver= +line in the server section, like: + + + <filename>LCDd.conf</filename>: Specify which driver to use - +[Server] Driver=curses - -This tells LCDd to use the curses driver. The first driver specified here -that is capable of output functionality will be used as 'the' output driver. -All extra drivers can only serve as input. -The default driver to use is curses. +This tells LCDd to use the curses driver. +The first driver specified here that is capable of output functionality +will be used as the output driver. +All other drivers can only serve as input drivers. +The default driver to use is curses. -If LCDd is started automatically by an init-script using the curses driver -will lock /dev/tty1! So, be careful about what you are +If LCDd is started automatically by an init-script using the curses driver, +it will lock /dev/tty1! So, be careful about what you are doing here. @@ -72,23 +75,35 @@ For this purpose they use the config sections that are named like the driver. -The -d option still works, but does not allow driverargs any more. - - -If -d is specified on the command line, the Driver= options in the -config file are ignored. +If is specified on the command line, the +Driver= options in the configuration file are ignored. -<filename>LCDd.conf</filename>: The [Server] Section +<filename>LCDd.conf</filename>: The <code>[Server]</code> Section -The [server] section of the LCDd.conf contains the +The [Server] section of the LCDd.conf contains the settings for the LCDproc server LCDd. + + + DriverPath= + DRIVERPATH + + + Tells the server where to look for the driver files. + See above for details. + If not specified DRIVERPATH + defaults to the empty string, resulting in drivers being + searched + in the directory LCDd is started in. + + + Driver= @@ -254,11 +269,13 @@ settings for the LCDproc server LCDd. + + -The "...Key=" lines define what the server does with keypresses that +The …Key= lines define what the server does with keypresses that don't go to any client. @@ -318,10 +335,10 @@ don't go to any client. -<filename>LCDd.conf</filename>: The [Menu] Section +<filename>LCDd.conf</filename>: The <code>[Menu]</code> Section -The [Menu] section enables you to set some general ("global") +The [Menu] section enables you to set some general ("global") options related to the way LCDd handles input "events". @@ -488,8 +505,12 @@ everything neccessary. The LCDproc Init Scripts -The LCDproc distribution contains init scripts for RedHat- and Debian-based -GNU/Linux distributions. You can find them in the scripts/ +The LCDproc distribution contains init scripts for +LSB 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 scripts/ directory of the LCDproc sources. @@ -519,10 +540,6 @@ LCDproc server LCDd. It does not require modification. The file scripts/init-lcdproc.* is the init script for the LCDproc "main" client lcdproc. - @@ -539,8 +556,8 @@ sources distribution). <filename>lcdproc.conf</filename>: Modify the option passed to lcdproc - + # /etc/lcdproc.conf # # Configuration file of the main LCDproc client "lcdproc" diff --git a/docs/lcdproc-user/how-to-obtain.docbook b/docs/lcdproc-user/how-to-obtain.docbook index 48270bf..24adfc5 100644 --- a/docs/lcdproc-user/how-to-obtain.docbook +++ b/docs/lcdproc-user/how-to-obtain.docbook @@ -109,7 +109,8 @@ you should (you don't have to) copy them to another place on your machine: apt-get -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 LCDproc, +which is in the unstable and testing distributions. diff --git a/docs/lcdproc-user/installation.docbook b/docs/lcdproc-user/installation.docbook index 20d341b..cde3872 100644 --- a/docs/lcdproc-user/installation.docbook +++ b/docs/lcdproc-user/installation.docbook @@ -5,20 +5,21 @@ Build LCDproc -Now that you have downloaded the LCDproc distribution you can +Now that you have downloaded the LCDproc distribution you can start building it. -If you have installed the debian package with apt-get (or another -debian tool), you can skip this this chapter. +If you have installed the Debian package with apt-get +(or another Debian package management tool), you can skip this this chapter. If you're building this version from CVS, you'll need -autoconf, automake, aclocal & autoheader installed. +autoconf, automake, +aclocal and autoheader installed. @@ -30,8 +31,8 @@ If you have autoconf and friends, run: -This produces the configure script and supporting files. It has already -been run if you are using the tarball distribution. +This produces the configure script and supporting files. +It has already been run if you are using the tarball distribution. @@ -51,9 +52,9 @@ Read about the options, figure out what to use. -Be sure to replace /usr/local with the prefixdir you want (e.g. /usr -for RedHat) and curses,CFontz with comma-separated list -of drivers you want. +Be sure to replace /usr/local with the prefixdir you want +(e.g. /usr for RedHat) and curses,CFontz with +the comma-separated list of drivers you want to have compiled. @@ -61,7 +62,7 @@ of drivers you want. -Congratulations: You have just compiled your version of LCDproc ;) +Congratulations: You have just compiled your version of LCDproc ;) @@ -82,7 +83,7 @@ can run: -make install is absolutely OPTIONAL +make install is absolutely OPTIONAL You can also run LCDproc directly from the source directory. See below for details.