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/mtxorb.docbook
+29 -86
View File
@@ -233,8 +233,8 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/lcd</filename>]
@@ -243,12 +243,7 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Set the display size [default: <literal>20x4</literal>]
@@ -257,15 +252,13 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<varlistentry>
<term>
<command>Type</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>lcd</emphasis></literal></arg>
<arg choice="plain"><literal>lkd</literal></arg>
<arg choice="plain"><literal>vfd</literal></arg>
<arg choice="plain"><literal>vkd</literal></arg>
</group>
</arg>
<property>Type</property> =
{
<emphasis><parameter><literal>lcd</literal></parameter></emphasis> |
<parameter><literal>lkd</literal></parameter> |
<parameter><literal>vfd</literal></parameter> |
<parameter><literal>vkd</literal></parameter>
}
</term>
<listitem><para>
Set the display type [default: <literal>lcd</literal>; legal: <literal>lcd</literal>,
@@ -277,8 +270,8 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<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 initial contrast.
@@ -294,13 +287,7 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<varlistentry>
<term>
<command>hasAdjustableBacklight</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>
<property>hasAdjustableBacklight</property> = &parameters.yesdefno;
</term>
<listitem><para>
Some old firmware versions of Matrix Orbital modules do not support an
@@ -313,8 +300,8 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial brightness [default: <literal>1000</literal>; legal: <literal>0</literal> - <literal>1000</literal>]
@@ -323,8 +310,8 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<varlistentry>
<term>
<command>OffBrightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>OffBrightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial off-brightness [default: <literal>0</literal>; legal: <literal>0</literal> - <literal>1000</literal>]
@@ -335,15 +322,13 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<varlistentry>
<term>
<command>Speed</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>1200</literal></arg>
<arg choice="plain"><literal>2400</literal></arg>
<arg choice="plain"><literal>9600</literal></arg>
<arg choice="plain"><literal><emphasis>19200</emphasis></literal></arg>
</group>
</arg>
<property>Speed</property> =
{
<parameter><literal>1200</literal></parameter> |
<parameter><literal>2400</literal></parameter> |
<parameter><literal>9600</literal></parameter> |
<emphasis><parameter><literal>19200</literal></parameter></emphasis>
}
</term>
<listitem><para>
Set the the baud rate to use when communicating with the LCD.
@@ -353,8 +338,8 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<varlistentry>
<term>
<command>KeyMap_<replaceable>LETTER</replaceable></command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>KeyMap_<replaceable>LETTER</replaceable></property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem>
<para>
@@ -365,7 +350,7 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<para>
These settings allow to map the letter <replaceable>LETTER</replaceable>,
that is generated by the display when a key is pressed, to be mapped to
a key name <replaceable>KEY</replaceable> that <command>LCDd</command>
a key name <replaceable>KEY</replaceable> that <property>LCDd</property>
can understand (see <link linkend="menu-section" endterm="menu-section.title"/>
for more information).
</para>
@@ -384,55 +369,13 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
KeyMap_E=Enter
KeyMap_F=Escape
</programlisting>
</example>
</example>
</listitem>
</varlistentry>
<!--
<varlistentry>
<term>
<command>LeftKey</command> =
<arg choice="plain"><replaceable>MTX-KEY</replaceable></arg>
</term>
<term>
<command>RightKey</command> =
<arg choice="plain"><replaceable>MTX-KEY</replaceable></arg>
</term>
<term>
<command>EnterKey</command> =
<arg choice="plain"><replaceable>MTX-KEY</replaceable></arg>
</term>
<term>
<command>UpKey</command> =
<arg choice="plain"><replaceable>MTX-KEY</replaceable></arg>
</term>
<term>
<command>DownKey</command> =
<arg choice="plain"><replaceable>MTX-KEY</replaceable></arg>
</term>
<term>
<command>EscapeKey</command> =
<arg choice="plain"><replaceable>MTX-KEY</replaceable></arg>
</term>
<listitem><para>
The following table translate from MtxOrb Key to Logical Key.
See [input] section for an explanation of the key mappings
This is a new implementation in 0.5
Legal values for <replaceable>MTX-KEY</replaceable> are the letters
<literal>A</literal> - <literal>F</literal>.
</para></listitem>
</varlistentry>
-->
<varlistentry>
<term>
<command>keypad_test_mode</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>keypad_test_mode</property> = &parameters.yesnodef;
</term>
<listitem><para>
You can find out which key of your display sends which