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/NoritakeVFD.docbook
+22 -37
View File
@@ -16,8 +16,8 @@ This section talks about using LCDproc with text mode VFD displays from
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Port where the VFD is. Usual values are <filename>/dev/ttyS0</filename> and <filename>/dev/ttyS1</filename>
@@ -27,12 +27,7 @@ This section talks about using LCDproc with text mode VFD displays from
<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>
Specifies the size of the LCD.
@@ -42,8 +37,8 @@ This section talks about using LCDproc with text mode VFD displays from
<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>]
@@ -52,8 +47,8 @@ This section talks about using LCDproc with text mode VFD displays from
<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>]
@@ -64,16 +59,14 @@ This section talks about using LCDproc with text mode VFD displays from
<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><emphasis>9600</emphasis></literal></arg>
<arg choice="plain"><literal>19200</literal></arg>
<arg choice="plain"><literal>115200</literal></arg>
</group>
</arg>
<property>Speed</property> =
{
<parameter><literal>1200</literal></parameter> |
<parameter><literal>2400</literal></parameter> |
<emphasis><parameter><literal>9600</literal></parameter></emphasis> |
<parameter><literal>19200</literal></parameter> |
<parameter><literal>115200</literal></parameter>
}
</term>
<listitem><para>
Set the the baud rate to use when communicating with the VFD.
@@ -83,14 +76,12 @@ This section talks about using LCDproc with text mode VFD displays from
<varlistentry>
<term>
<command>Parity</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>0</emphasis></literal></arg>
<arg choice="plain"><literal>1</literal></arg>
<arg choice="plain"><literal>2</literal></arg>
</group>
</arg>
<property>Parity</property> =
{
<emphasis><parameter><literal>0</literal></parameter></emphasis> |
<parameter><literal>1</literal></parameter> |
<parameter><literal>2</literal></parameter>
}
</term>
<listitem><para>
Set the parity for communication with the device to even parity (<literal>2</literal>),
@@ -101,13 +92,7 @@ This section talks about using LCDproc with text mode VFD displays from
<varlistentry>
<term>
<command>Reboot</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>Reboot</property> = &parameters.yesnodef;
</term>
<listitem><para>
Reinitialize the VFD [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]