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

Replace <term><args> with <term><synopsis> or <term><option> as the first one

Browse Source 
is not allowed.
Strip trailing whitespace.
Reformat long lines.
This commit is contained in:
mmdolze
2009-06-12 11:15:20 +00:00
parent b31bb501e0
commit 44d90170ed
6 changed files with 113 additions and 172 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/lcdproc-dev/add-your-driver.docbook
+1 -1
View File
@@ -258,7 +258,7 @@ SED1330/SED1335 (aka S1D13300/S1D13305) based graphical displays
<title>Step 1</title> <title>Step 1</title>
<para> <para>
Please add a file <filename><emphasis>myDriver</emphasis>.docbook</filename>, Please add a file <filename>myDriver.docbook</filename>,
that describes the configuration of your driver and the hard/software needed, that describes the configuration of your driver and the hard/software needed,
to the directory <filename>docs/lcdproc-user/drivers/</filename>. to the directory <filename>docs/lcdproc-user/drivers/</filename>.
</para> </para>
docs/lcdproc-dev/language.docbook
+48 -123
View File
@@ -89,7 +89,7 @@
<variablelist><!--<title>hello response parameters</title>--> <variablelist><!--<title>hello response parameters</title>-->
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">LCDproc <replaceable>version</replaceable></arg> <synopsis>LCDproc <replaceable>version</replaceable></synopsis>
</term> </term>
<listitem><para> <listitem><para>
Indicates the version number of LCDd. Indicates the version number of LCDd.
@@ -97,7 +97,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">protocol <replaceable>version</replaceable></arg> <synopsis>protocol <replaceable>version</replaceable></synopsis>
</term> </term>
<listitem><para> <listitem><para>
Indicates the widget language version number. This number is Indicates the widget language version number. This number is
@@ -107,7 +107,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">wid <replaceable>int</replaceable></arg> <synopsis>wid <replaceable>int</replaceable></synopsis>
</term> </term>
<listitem><para> <listitem><para>
Tells the client the width of the attached display device in characters. Tells the client the width of the attached display device in characters.
@@ -115,7 +115,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">hgt <replaceable>int</replaceable></arg> <synopsis>hgt <replaceable>int</replaceable></synopsis>
</term> </term>
<listitem><para> <listitem><para>
Tells the client the height of the attached display device in characters. Tells the client the height of the attached display device in characters.
@@ -123,7 +123,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">cellwid <replaceable>int</replaceable></arg> <synopsis>cellwid <replaceable>int</replaceable></synopsis>
</term> </term>
<listitem><para> <listitem><para>
How many pixels is a character wide (space between character How many pixels is a character wide (space between character
@@ -132,7 +132,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">cellhgt <replaceable>int</replaceable></arg> <synopsis>cellhgt <replaceable>int</replaceable></synopsis>
</term> </term>
<listitem><para> <listitem><para>
How many pixels is a character high (space between character How many pixels is a character high (space between character
@@ -141,7 +141,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">lcd</arg> <synopsis>lcd</synopsis>
</term> </term>
<listitem><para> <listitem><para>
This word is NOT followed by a value ! This word is NOT followed by a value !
@@ -273,7 +273,7 @@
<variablelist><!--<title>screen_set attributes</title>--> <variablelist><!--<title>screen_set attributes</title>-->
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-name <replaceable>name</replaceable></arg> <option>-name <replaceable>name</replaceable></option>
</term> </term>
<listitem><para> <listitem><para>
Sets the screen's name as visible to a user. Sets the screen's name as visible to a user.
@@ -281,10 +281,8 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-wid <replaceable>int</replaceable></arg> <option>-wid <replaceable>int</replaceable></option>
</term> <option>-hgt <replaceable>int</replaceable></option>
<term>
<arg choice="plain">-hgt <replaceable>int</replaceable></arg>
</term> </term>
<listitem><para> <listitem><para>
Sets the size of the screen in characters. If unset, the full display size is assumed. Sets the size of the screen in characters. If unset, the full display size is assumed.
@@ -292,7 +290,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-priority <replaceable>pri_class</replaceable></arg> <option>-priority <replaceable>pri_class</replaceable></option>
</term> </term>
<listitem><para> <listitem><para>
Sets the screen's priority. Sets the screen's priority.
@@ -357,7 +355,7 @@
<entry>info</entry> <entry>info</entry>
</row> </row>
<row> <row>
<entry>193 - &#8734;</entry> <entry>193 - &#x221E;</entry>
<entry>background</entry> <entry>background</entry>
</row> </row>
</tbody> </tbody>
@@ -378,13 +376,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-heartbeat <option>-heartbeat { on | off | open }</option>
<group choice="req">
<arg choice="plain">on</arg>
<arg choice="plain">off</arg>
<arg choice="plain">open</arg>
</group>
</arg>
</term> </term>
<listitem><para> <listitem><para>
Changes the heartbeat setting for this screen. Changes the heartbeat setting for this screen.
@@ -394,16 +386,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-backlight <option>-backlight { on | off | toggle | open | blink | flash }</option>
<group choice="req">
<arg choice="plain">on</arg>
<arg choice="plain">off</arg>
<arg choice="plain">toggle</arg>
<arg choice="plain">open</arg>
<arg choice="plain">blink</arg>
<arg choice="plain">flash</arg>
</group>
</arg>
</term> </term>
<listitem><para> <listitem><para>
Changes the screen's backlight setting. Changes the screen's backlight setting.
@@ -415,7 +398,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-duration <replaceable>value</replaceable></arg> <option>-duration <replaceable>value</replaceable></option>
</term> </term>
<listitem><para> <listitem><para>
A screen will be visible for this amount of time every rotation. A screen will be visible for this amount of time every rotation.
@@ -424,7 +407,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-timeout <replaceable>value</replaceable></arg> <option>-timeout <replaceable>value</replaceable></option>
</term> </term>
<listitem><para> <listitem><para>
After the screen has been visible for a total of this amount of time, After the screen has been visible for a total of this amount of time,
@@ -434,14 +417,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-cursor <option>-cursor { on | off | under | block}</option>
<group choice="req">
<arg choice="plain">on</arg>
<arg choice="plain">off</arg>
<arg choice="plain">under</arg>
<arg choice="plain">block</arg>
</group>
</arg>
</term> </term>
<listitem><para> <listitem><para>
Determines the visibility of a cursor. Determines the visibility of a cursor.
@@ -454,10 +430,8 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-cursor_x <replaceable>int</replaceable></arg> <option>-cursor_x <replaceable>int</replaceable></option>
</term> <option>-cursor_y <replaceable>int</replaceable></option>
<term>
<arg choice="plain">-cursor_y <replaceable>int</replaceable></arg>
</term> </term>
<listitem><para> <listitem><para>
Set the cursor's x and y coordinates respectively. Set the cursor's x and y coordinates respectively.
@@ -982,7 +956,7 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-text <replaceable>string</replaceable></arg> <option>-text <replaceable>string</replaceable></option>
</term> </term>
<listitem><para> <listitem><para>
The visible text of the item. The visible text of the item.
@@ -990,13 +964,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-is_hidden <option>-is_hidden { true | false}</option> (false)
<group choice="req">
<arg choice="plain">false</arg>
<arg choice="plain">true</arg>
</group>
</arg>
(false)
</term> </term>
<listitem><para> <listitem><para>
If the item currently should not appear in a menu. If the item currently should not appear in a menu.
@@ -1004,7 +972,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-next <replaceable>successor_id</replaceable></arg> <option>-next <replaceable>successor_id</replaceable></option>
</term> </term>
<listitem> <listitem>
<para> <para>
@@ -1050,7 +1018,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-prev <replaceable>predecessor_id</replaceable></arg> <option>-prev <replaceable>predecessor_id</replaceable></option>
</term> </term>
<listitem> <listitem>
<para> <para>
@@ -1090,14 +1058,7 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-menu_result <option>-menu_result { none | close | quit}</option> (none)
<group choice="req">
<arg choice="plain">none</arg>
<arg choice="plain">close</arg>
<arg choice="plain">quit</arg>
</group>
</arg>
(none)
</term> </term>
<listitem><para> <listitem><para>
Sets what to do with the menu when this action is selected: Sets what to do with the menu when this action is selected:
@@ -1117,13 +1078,7 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-value <option>-value { off | on | gray }</option>
<group choice="req">
<arg choice="plain">off</arg>
<arg choice="plain">on</arg>
<arg choice="plain">gray</arg>
</group>
</arg>
</term> </term>
<listitem><para> <listitem><para>
Set the value of the item. Set the value of the item.
@@ -1131,13 +1086,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-allow_gray <option>-allow_gray { false | true}</option> (false)
<group choice="req">
<arg choice="plain">false</arg>
<arg choice="plain">true</arg>
</group>
</arg>
(false)
</term> </term>
<listitem><para> <listitem><para>
Sets if a grayed checkbox is allowed. Sets if a grayed checkbox is allowed.
@@ -1154,7 +1103,7 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-value <replaceable>int</replaceable></arg> (0) <option>-value <replaceable>int</replaceable></option> (0)
</term> </term>
<listitem><para> <listitem><para>
Sets the index in the stringlist that is currently selected. Sets the index in the stringlist that is currently selected.
@@ -1162,7 +1111,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-strings <replaceable>string</replaceable></arg> (empty) <option>-strings <replaceable>string</replaceable></option> (empty)
</term> </term>
<listitem><para> <listitem><para>
This single string should contain the strings that can be selected. They should be tab-separated (\t). This single string should contain the strings that can be selected. They should be tab-separated (\t).
@@ -1179,7 +1128,7 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-value <replaceable>int</replaceable></arg> (0) <option>-value <replaceable>int</replaceable></option> (0)
</term> </term>
<listitem><para> <listitem><para>
Sets its current value. Sets its current value.
@@ -1187,10 +1136,10 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-mintext <replaceable>string</replaceable></arg> ("") <option>-mintext <replaceable>string</replaceable></option> ("")
</term> </term>
<term> <term>
<arg choice="plain">-maxtext <replaceable>string</replaceable></arg> ("") <option>-maxtext <replaceable>string</replaceable></option> ("")
</term> </term>
<listitem><para> <listitem><para>
The texts at the left and right side of the slider. The texts at the left and right side of the slider.
@@ -1198,10 +1147,10 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-minvalue <replaceable>int</replaceable></arg> (0) <option>-minvalue <replaceable>int</replaceable></option> (0)
</term> </term>
<term> <term>
<arg choice="plain">-maxvalue <replaceable>int</replaceable></arg> (100) <option>-maxvalue <replaceable>int</replaceable></option> (100)
</term> </term>
<listitem><para> <listitem><para>
The minimum and maximum values of the slider. The minimum and maximum values of the slider.
@@ -1209,7 +1158,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-stepsize <replaceable>int</replaceable></arg> (1) <option>-stepsize <replaceable>int</replaceable></option> (1)
</term> </term>
<listitem><para> <listitem><para>
The stepsize of the slider. If you use 0, you can control the movement completely from your client. The stepsize of the slider. If you use 0, you can control the movement completely from your client.
@@ -1226,7 +1175,7 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-value <replaceable>int</replaceable></arg> (0) <option>-value <replaceable>int</replaceable></option> (0)
</term> </term>
<listitem><para> <listitem><para>
Sets its current value. Sets its current value.
@@ -1234,10 +1183,10 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-minvalue <replaceable>int</replaceable></arg> (0) <option>-minvalue <replaceable>int</replaceable></option> (0)
</term> </term>
<term> <term>
<arg choice="plain">-maxvalue <replaceable>int</replaceable></arg> (100) <option>-maxvalue <replaceable>int</replaceable></option> (100)
</term> </term>
<listitem><para> <listitem><para>
The minimum and maximum values that are allowed. If one The minimum and maximum values that are allowed. If one
@@ -1259,7 +1208,7 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-value <replaceable>string</replaceable></arg> ("") <option>-value <replaceable>string</replaceable></option> ("")
</term> </term>
<listitem><para> <listitem><para>
Sets its current value. Sets its current value.
@@ -1267,7 +1216,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-password_char <replaceable>string</replaceable></arg> ("") <option>-password_char <replaceable>string</replaceable></option> ("")
</term> </term>
<listitem><para> <listitem><para>
If used, instead of the typed characters, this If used, instead of the typed characters, this
@@ -1276,10 +1225,10 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-minlength <replaceable>int</replaceable></arg> (0) <option>-minlength <replaceable>int</replaceable></option> (0)
</term> </term>
<term> <term>
<arg choice="plain">-maxlength <replaceable>int</replaceable></arg> (10) <option>-maxlength <replaceable>int</replaceable></option> (10)
</term> </term>
<listitem><para> <listitem><para>
Sets the minimum and maximum allowed lengths. Sets the minimum and maximum allowed lengths.
@@ -1287,31 +1236,13 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-allow_caps <option>-allow_caps { false | true }</option> (true)
<group choice="req">
<arg choice="plain">false</arg>
<arg choice="plain">true</arg>
</group>
</arg>
(true)
</term> </term>
<term> <term>
<arg choice="plain">-allow_noncaps <option>-allow_noncaps { false | true }</option> (false)
<group choice="req">
<arg choice="plain">false</arg>
<arg choice="plain">true</arg>
</group>
</arg>
(false)
</term> </term>
<term> <term>
<arg choice="plain">-allow_numbers <option>-allow_numbers { false | true }</option> (false)
<group choice="req">
<arg choice="plain">false</arg>
<arg choice="plain">true</arg>
</group>
</arg>
(false)
</term> </term>
<listitem><para> <listitem><para>
(Dis)allow these groups of characters. (Dis)allow these groups of characters.
@@ -1319,7 +1250,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-allowed_extra <replaceable>string</replaceable></arg> ("") <option>-allowed_extra <replaceable>string</replaceable></option> ("")
</term> </term>
<listitem><para> <listitem><para>
The chars in this string are also allowed. The chars in this string are also allowed.
@@ -1336,7 +1267,7 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-value <replaceable>string</replaceable></arg> ("192.168.1.245") <option>-value <replaceable>string</replaceable></option> ("192.168.1.245")
</term> </term>
<listitem><para> <listitem><para>
Set the value of the item, Set the value of the item,
@@ -1346,13 +1277,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-v6 <option>-v6 { false | true }</option> (false)
<group choice="req">
<arg choice="plain">false</arg>
<arg choice="plain">true</arg>
</group>
</arg>
(false)
</term> </term>
<listitem><para> <listitem><para>
Changes IP version from default v4. Changes IP version from default v4.
@@ -1372,7 +1297,7 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
<arg choice="plain">-parent <replaceable>parentid</replaceable></arg> <option>-parent <replaceable>parentid</replaceable></option>
</term> </term>
<listitem><para> (Re)sets the parent of this <listitem><para> (Re)sets the parent of this
menu. Parentid has to be of type menu. This menu. Parentid has to be of type menu. This
docs/lcdproc-dev/make-driver.docbook
+23 -7
View File
@@ -5,11 +5,14 @@
<title>Introduction</title> <title>Introduction</title>
<para> <para>
LCDproc is meant to be modular, it is relatively easy to add new input and output drivers to LCDproc. Actually, there are a few things that you can do to make your life easier, they are listed here. LCDproc is meant to be modular, it is relatively easy to add new input and
output drivers to LCDproc. Actually, there are a few things that you can do
to make your life easier, they are listed here.
</para> </para>
<para> <para>
This chapter will explain you the major steps and few gotchas of adding your own driver to LCDproc. Enjoy! This chapter will explain you the major steps and few gotchas of adding your
own driver to LCDproc. Enjoy!
</para> </para>
</sect1> </sect1>
@@ -18,21 +21,34 @@ This chapter will explain you the major steps and few gotchas of adding your own
<title>Shared files specific for drivers</title> <title>Shared files specific for drivers</title>
<para> <para>
Driving an LCD display is not easy; you need to address ports, to send bytes in a certain order, to respect timing, and unfortunaly no two operating system let you do this in the same way. But don't dispair! There's hope! Someone in a galaxy far far away, has allready done the dirty job for you! This dirty job has been put in shared files. These shared files are full cross platform and are automagically configured by the configure script. You only need to include them and use their functions to benefit from them. Driving an LCD display is not easy; you need to address ports, to send bytes
in a certain order, to respect timing, and unfortunaly no two operating system
let you do this in the same way. But don't dispair! There's hope! Someone in
a galaxy far far away, has allready done the dirty job for you! This dirty job
has been put in shared files. These shared files are full cross platform and
are automagically configured by the configure script. You only need to include
them and use their functions to benefit from them.
</para> </para>
<para> <para>
These files are provided only for drivers, others are provided for all of LCDproc. These files are located in the shared directory, they have a dedicated chapter in this book. These files are provided only for drivers, others are provided for all of
LCDproc. These files are located in the shared directory, they have a
dedicated chapter in this book.
</para> </para>
<sect2 id="port.h"> <sect2 id="port.h">
<title>port.h : Parallel port I/O</title> <title>port.h : Parallel port I/O</title>
<para>The file port.h, located in the server/drivers/ directory provide Input/Output and port permissions for the PC compatible parallel port, also known as the LPT port.</para> <para>
The file port.h, located in the server/drivers/ directory provide Input/Output
and port permissions for the PC compatible parallel port, also known as the
LPT port.
</para>
<para> <para>
Of course, these functions will only work if the computer where LCDproc runs has parallel port!r Of course, these functions will only work if the computer where LCDproc runs
In these situations, the configure script will see this and disable drivers that need a parallel port. has parallel port! In these situations, the configure script will see this and
disable drivers that need a parallel port.
</para> </para>
<para>port.h file defines 6 static inline functions for port I/O:</para> <para>port.h file defines 6 static inline functions for port I/O:</para>