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

Replace <term><command><arg> with <term><property><parameter> to describe

Browse Source 
options in the config file because:
 * <arg> can only be used within <cmdsynopsis>.
 * <cmdsynopsis> does not allow text outside <command> and <arg>.
 * <arg> does not allow decorating elements like <literal> or <emphasis>.
This fixes #2803057.

Add shortcut entities for commonly used parameters (yes/no, size).
Remove Debian patch which is obsoleted by above changes.
This commit is contained in:
mmdolze
2009-06-12 09:12:50 +00:00
parent 5108e4931e
commit f59af2e241
48 changed files with 794 additions and 1321 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/lcdproc-user/drivers/glcdlib.docbook
+30 -72
View File
@@ -39,9 +39,9 @@ before configuring the LCDproc build process --enable-drivers=glcdlib.
<variablelist>
<varlistentry>
<term>
<command>Driver</command> =
<arg choice="plain"><replaceable>GRAPHLCD-DRIVER</replaceable></arg>
<term>
<property>Driver</property> =
<parameter><replaceable>GRAPHLCD-DRIVER</replaceable></parameter>
</term>
<listitem><para>
Specify which graphical display supported by graphlcd-base to use.
@@ -58,13 +58,7 @@ before configuring the LCDproc build process --enable-drivers=glcdlib.
<varlistentry>
<term>
<command>UseFT2</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>yes</literal></arg>
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
</group>
</arg>
<property>UseFT2</property> = &parameters.yesdefno;
</term>
<listitem><para>
Tell whether to use FreeType2 or not.
@@ -79,12 +73,7 @@ before configuring the LCDproc build process --enable-drivers=glcdlib.
<varlistentry>
<term>
<command>TextResolution</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>TextResolution</property> = &parameters.size;
</term>
<listitem><para>
Give text resolution in fixed width characters. If it won't fit according
@@ -96,8 +85,8 @@ before configuring the LCDproc build process --enable-drivers=glcdlib.
<varlistentry>
<term>
<command>FontFile</command> =
<arg choice="plain"><replaceable>FILENAME</replaceable></arg>
<property>FontFile</property> =
<parameter><replaceable>FILENAME</replaceable></parameter>
</term>
<listitem><para>
Set path to font file to use, e.g. <filename>/usr/share/fonts/corefonts/courbd.ttf</filename>.
@@ -106,14 +95,14 @@ before configuring the LCDproc build process --enable-drivers=glcdlib.
</variablelist>
<para>
The following parameters only apply if <command>UseFT2</command> = <literal>yes</literal>:
The following parameters only apply if <property>UseFT2</property> = <literal>yes</literal>:
</para>
<variablelist>
<varlistentry>
<term>
<command>CharEncoding</command> =
<arg choice="plain"><replaceable>CHARSET</replaceable></arg>
<property>CharEncoding</property> =
<parameter><replaceable>CHARSET</replaceable></parameter>
</term>
<listitem><para>
Specify character encoding to use, e.g. <literal>iso8859-2</literal>.
@@ -123,12 +112,12 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<varlistentry>
<term>
<command>MinFontFaceSize</command> =
<arg choice="plain">
<property>MinFontFaceSize</property> =
<parameter>
<replaceable>COLUMNS</replaceable>
<literal>x</literal>
<replaceable>ROWS</replaceable>
</arg>
</parameter>
</term>
<listitem><para>
minimum size in pixels in which fonts should be rendered
@@ -142,8 +131,8 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<title>Optional settings</title>
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Brightness (in %) if applicable
@@ -154,8 +143,8 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<varlistentry>
<term>
<command>Contrast</command> =
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
<property>Contrast</property> =
<parameter><replaceable>CONTRAST</replaceable></parameter>
</term>
<listitem><para>
Set the contrast (in %) if applicable.
@@ -166,13 +155,7 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<varlistentry>
<term>
<command>Backlight</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>yes</literal></arg>
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
</group>
</arg>
<property>Backlight</property> = &parameters.yesnodef;
</term>
<listitem><para>
Backlight if applicable
@@ -181,13 +164,7 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<varlistentry>
<term>
<command>UpsideDown</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>yes</literal></arg>
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
</group>
</arg>
<property>UpsideDown</property> = &parameters.yesnodef;
</term>
<listitem><para>
flip image upside down
@@ -196,13 +173,7 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<varlistentry>
<term>
<command>Invert</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>yes</literal></arg>
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
</group>
</arg>
<property>Invert</property> = &parameters.yesnodef;
</term>
<listitem><para>
invert light/dark pixels
@@ -211,13 +182,7 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<varlistentry>
<term>
<command>ShowDebugFrame</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>yes</literal></arg>
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
</group>
</arg>
<property>ShowDebugFrame</property> = &parameters.yesnodef;
</term>
<listitem><para>
turns on/off 1 pixel thick debugging
@@ -229,13 +194,7 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<varlistentry>
<term>
<command>ShowBigBorder</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>yes</literal></arg>
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
</group>
</arg>
<property>ShowBigBorder</property> = &parameters.yesnodef;
</term>
<listitem><para>
border around the unused area
@@ -244,13 +203,7 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<varlistentry>
<term>
<command>ShowThinBorder</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>yes</literal></arg>
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
</group>
</arg>
<property>ShowThinBorder</property> = &parameters.yesnodef;
</term>
<listitem><para>
border around the unused area
@@ -259,12 +212,17 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<varlistentry>
<term>
<command>PixelShiftX=<replaceable>0</replaceable></command>
<property>PixelShiftX</property> =
<parameter><replaceable>SHIFTX</replaceable></parameter>
</term>
<term>
<command>PixelShiftY=<replaceable>2</replaceable></command>
<property>PixelShiftY</property> =
<parameter><replaceable>SHIFTY</replaceable></parameter>
</term>
<listitem><para>
Shifts the content of the display by <replaceable>SHIFTX</replaceable>
(default: <literal>0</literal>) and <replaceable>SHIFTY</replaceable>
(default: <literal>0</literal>) pixels.
</para></listitem>
</varlistentry>
</variablelist>