summaryrefslogtreecommitdiff
path: root/v4l2-spec/controls.sgml
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@redhat.com>2009-08-31 21:28:58 -0300
committerMauro Carvalho Chehab <mchehab@redhat.com>2009-08-31 21:28:58 -0300
commitb13aae56fe48c89e3b1dbefaf165cbab0102216b (patch)
tree1fa560699f394247610a9a8ebc0cc4b9d5ce45df /v4l2-spec/controls.sgml
parent939633eb8afe2f03adab25337d2f57f0b8ed642d (diff)
downloadmediapointer-dvb-s2-b13aae56fe48c89e3b1dbefaf165cbab0102216b.tar.gz
mediapointer-dvb-s2-b13aae56fe48c89e3b1dbefaf165cbab0102216b.tar.bz2
v4l2-spec: convert it to use DocBook XML 4.1.2
From: Mauro Carvalho Chehab <mchehab@redhat.com> DocBook XML 4.1.2 is the docbook dialect spoken at Linux kernel. By using it, we can now consider adding V4L2 API docs at the kernel tree. As a bonus, added support for xmlto, with seems to be better supported nowadays. Another additional bounus is that two new Makefile targets were added: make man - Create V4L2 API man pages make man_install - Install V4L2 API man pages By allowing the addition of V4L2 manpages, it is now easier for developer to quickly check about a V4L2 API or libv4l2 call syntax and expected return values. Priority: normal Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'v4l2-spec/controls.sgml')
-rw-r--r--v4l2-spec/controls.sgml62
1 files changed, 31 insertions, 31 deletions
diff --git a/v4l2-spec/controls.sgml b/v4l2-spec/controls.sgml
index 869198601..f492accb6 100644
--- a/v4l2-spec/controls.sgml
+++ b/v4l2-spec/controls.sgml
@@ -15,7 +15,7 @@ several IDs for specific purposes. Drivers can also implement their
own custom controls using <constant>V4L2_CID_PRIVATE_BASE</constant>
and higher values. The pre-defined control IDs have the prefix
<constant>V4L2_CID_</constant>, and are listed in <xref
-linkend="control-id">. The ID is used when querying the attributes of
+linkend="control-id" />. The ID is used when querying the attributes of
a control, and when getting or setting the current value.</para>
<para>Generally applications should present controls to the user
@@ -215,7 +215,7 @@ linkend="camera-controls">Camera class controls</link>
<entry>integer</entry>
<entry>Vertical image centering. Centering is intended to
<emphasis>physically</emphasis> adjust cameras. For image cropping see
-<xref linkend="crop">, for clipping <xref linkend="overlay">. This
+<xref linkend="crop" />, for clipping <xref linkend="overlay" />. This
control is deprecated. New drivers and applications should use the
<link linkend="camera-controls">Camera class controls</link>
<constant>V4L2_CID_TILT_ABSOLUTE</constant>,
@@ -291,7 +291,7 @@ minimum value disables backlight compensation.</entry>
<entry></entry>
<entry>ID of the first custom (driver specific) control.
Applications depending on particular custom controls should check the
-driver name and version, see <xref linkend="querycap">.</entry>
+driver name and version, see <xref linkend="querycap" />.</entry>
</row>
</tbody>
</tgroup>
@@ -546,7 +546,7 @@ control class is found:</para>
<informalexample>
<programlisting>
qctrl.id = V4L2_CTRL_CLASS_MPEG | V4L2_CTRL_FLAG_NEXT_CTRL;
-while (0 == ioctl (fd, &VIDIOC-QUERYCTRL, &amp;qctrl)) {
+while (0 == ioctl (fd, &VIDIOC-QUERYCTRL;, &amp;qctrl)) {
if (V4L2_CTRL_ID2CLASS (qctrl.id) != V4L2_CTRL_CLASS_MPEG)
break;
/* ... */
@@ -605,12 +605,12 @@ certain hardware.</para>
<table pgwide="1" frame="none" id="mpeg-control-id">
<title>MPEG Control IDs</title>
<tgroup cols="4">
- <colspec colname="c1" colwidth="1*">
- <colspec colname="c2" colwidth="6*">
- <colspec colname="c3" colwidth="2*">
- <colspec colname="c4" colwidth="6*">
- <spanspec namest="c1" nameend="c2" spanname="id">
- <spanspec namest="c2" nameend="c4" spanname="descr">
+ <colspec colname="c1" colwidth="1*" />
+ <colspec colname="c2" colwidth="6*" />
+ <colspec colname="c3" colwidth="2*" />
+ <colspec colname="c4" colwidth="6*" />
+ <spanspec namest="c1" nameend="c2" spanname="id" />
+ <spanspec namest="c2" nameend="c4" spanname="descr" />
<thead>
<row>
<entry spanname="id" align="left">ID</entry>
@@ -1386,12 +1386,12 @@ CX23416 MPEG encoding chips.</para>
<table pgwide="1" frame="none" id="cx2341x-control-id">
<title>CX2341x Control IDs</title>
<tgroup cols="4">
- <colspec colname="c1" colwidth="1*">
- <colspec colname="c2" colwidth="6*">
- <colspec colname="c3" colwidth="2*">
- <colspec colname="c4" colwidth="6*">
- <spanspec namest="c1" nameend="c2" spanname="id">
- <spanspec namest="c2" nameend="c4" spanname="descr">
+ <colspec colname="c1" colwidth="1*" />
+ <colspec colname="c2" colwidth="6*" />
+ <colspec colname="c3" colwidth="2*" />
+ <colspec colname="c4" colwidth="6*" />
+ <spanspec namest="c1" nameend="c2" spanname="id" />
+ <spanspec namest="c2" nameend="c4" spanname="descr" />
<thead>
<row>
<entry spanname="id" align="left">ID</entry>
@@ -1605,12 +1605,12 @@ or sensors.</para>
<table pgwide="1" frame="none" id="camera-control-id">
<title>Camera Control IDs</title>
<tgroup cols="4">
- <colspec colname="c1" colwidth="1*">
- <colspec colname="c2" colwidth="6*">
- <colspec colname="c3" colwidth="2*">
- <colspec colname="c4" colwidth="6*">
- <spanspec namest="c1" nameend="c2" spanname="id">
- <spanspec namest="c2" nameend="c4" spanname="descr">
+ <colspec colname="c1" colwidth="1*" />
+ <colspec colname="c2" colwidth="6*" />
+ <colspec colname="c3" colwidth="2*" />
+ <colspec colname="c4" colwidth="6*" />
+ <spanspec namest="c1" nameend="c2" spanname="id" />
+ <spanspec namest="c2" nameend="c4" spanname="descr" />
<thead>
<row>
<entry spanname="id" align="left">ID</entry>
@@ -1842,12 +1842,12 @@ tuning power features.</para>
<title>FM_TX Control IDs</title>
<tgroup cols="4">
- <colspec colname="c1" colwidth="1*">
- <colspec colname="c2" colwidth="6*">
- <colspec colname="c3" colwidth="2*">
- <colspec colname="c4" colwidth="6*">
- <spanspec namest="c1" nameend="c2" spanname="id">
- <spanspec namest="c2" nameend="c4" spanname="descr">
+ <colspec colname="c1" colwidth="1*" />
+ <colspec colname="c2" colwidth="6*" />
+ <colspec colname="c3" colwidth="2*" />
+ <colspec colname="c4" colwidth="6*" />
+ <spanspec namest="c1" nameend="c2" spanname="id" />
+ <spanspec namest="c2" nameend="c4" spanname="descr" />
<thead>
<row>
<entry spanname="id" align="left">ID</entry>
@@ -1891,7 +1891,7 @@ This encodes up to 31 pre-defined programme types.</entry>
</row>
<row><entry spanname="descr">Sets the Programme Service name (PS_NAME) for transmission.
It is intended for static display on a receiver. It is the primary aid to listeners in programme service
-identification and selection. In Annex E of <xref linkend="en50067">, the RDS specification,
+identification and selection. In Annex E of <xref linkend="en50067" />, the RDS specification,
there is a full description of the correct character encoding for Programme Service name strings.
Also from RDS specification, PS is usually a single eight character text. However, it is also possible
to find receivers which can scroll strings sized as 8 x N characters. So, this control must be configured
@@ -1905,7 +1905,7 @@ with steps of 8 characters. The result is it must always contain a string with s
what is being broadcasted. RDS Radio Text can be applied when broadcaster wishes to transmit longer PS names,
programme-related information or any other text. In these cases, RadioText should be used in addition to
<constant>V4L2_CID_RDS_TX_PS_NAME</constant>. The encoding for Radio Text strings is also fully described
-in Annex E of <xref linkend="en50067">. The length of Radio Text strings depends on which RDS Block is being
+in Annex E of <xref linkend="en50067" />. The length of Radio Text strings depends on which RDS Block is being
used to transmit it, either 32 (2A block) or 64 (2B block). However, it is also possible
to find receivers which can scroll strings sized as 32 x N or 64 x N characters. So, this control must be configured
with steps of 32 or 64 characters. The result is it must always contain a string with size multiple of 32 or 64. </entry>
@@ -2036,7 +2036,7 @@ manually or automatically if set to zero. Unit, range and step are driver-specif
</table>
<para>For more details about RDS specification, refer to
-<xref linkend="en50067"> document, from CENELEC.</para>
+<xref linkend="en50067" /> document, from CENELEC.</para>
</section>
</section>