Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 3d7f9c9b authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] DocBook: reformat FE_SET_FRONTEND_TUNE_MODE ioctl 



Use the proper format for FE_SET_FRONTEND_TUNE_MODE documentation.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent 0f16290e

Documentation/DocBook/media/dvb/fe-set-frontend-tune-mode.xml

0 → 100644
+64 −0
Original line number Diff line number Diff line 
<refentry id="FE_SET_FRONTEND_TUNE_MODE">

  <refmeta>

    <refentrytitle>ioctl FE_SET_FRONTEND_TUNE_MODE</refentrytitle>

    &manvol;

  </refmeta>



  <refnamediv>

    <refname>FE_SET_FRONTEND_TUNE_MODE</refname>

    <refpurpose>Allow setting tuner mode flags to the frontend.</refpurpose>

  </refnamediv>



  <refsynopsisdiv>

    <funcsynopsis>

      <funcprototype>

	<funcdef>int <function>ioctl</function></funcdef>

	<paramdef>int <parameter>fd</parameter></paramdef>

	<paramdef>int <parameter>request</parameter></paramdef>

	<paramdef>unsigned int <parameter>flags</parameter></paramdef>

      </funcprototype>

    </funcsynopsis>

  </refsynopsisdiv>



  <refsect1>

    <title>Arguments</title>

        <variablelist>

      <varlistentry>

	<term><parameter>fd</parameter></term>

	<listitem>

	  <para>&fe_fd;</para>

	</listitem>

      </varlistentry>

      <varlistentry>

	<term><parameter>request</parameter></term>

	<listitem>

	  <para>FE_SET_FRONTEND_TUNE_MODE</para>

	</listitem>

      </varlistentry>

      <varlistentry>

	<term><parameter>flags</parameter></term>

	<listitem>

	    <para>Valid flags:</para>

	    <itemizedlist>

		<listitem>0 - normal tune mode</listitem>

		<listitem>FE_TUNE_MODE_ONESHOT - When set, this flag will

		    disable any zigzagging or other "normal" tuning behaviour.

		    Additionally, there will be no automatic monitoring of the

		    lock status, and hence no frontend events will be

		    generated. If a frontend device is closed, this flag will

		    be automatically turned off when the device is reopened

		    read-write.</listitem>

	    </itemizedlist>

	</listitem>

      </varlistentry>

    </variablelist>

  </refsect1>



  <refsect1>

    <title>Description</title>



    <para>Allow setting tuner mode flags to the frontend, between 0 (normal)

	or FE_TUNE_MODE_ONESHOT mode</para>

&return-value-dvb;

</refsect1>

</refentry>

Documentation/DocBook/media/dvb/frontend.xml

+1 −31
Original line number Diff line number Diff line
@@ -738,37 +738,7 @@ typedef enum fe_hierarchy { 
&return-value-dvb;

</section>



<section id="FE_SET_FRONTEND_TUNE_MODE">

<title>FE_SET_FRONTEND_TUNE_MODE</title>

<para>DESCRIPTION</para>

<informaltable><tgroup cols="1"><tbody><row>

<entry align="char">

<para>Allow setting tuner mode flags to the frontend.</para>

</entry>

</row></tbody></tgroup></informaltable>



<para>SYNOPSIS</para>

<informaltable><tgroup cols="1"><tbody><row>

<entry align="char">

<para>int ioctl(int fd, int request =

<link linkend="FE_SET_FRONTEND_TUNE_MODE">FE_SET_FRONTEND_TUNE_MODE</link>, unsigned int flags);</para>

</entry>

</row></tbody></tgroup></informaltable>



<para>PARAMETERS</para>

<informaltable><tgroup cols="2"><tbody><row>

<entry align="char">

	<para>unsigned int flags</para>

</entry>

<entry align="char">

<para>

FE_TUNE_MODE_ONESHOT When set, this flag will disable any zigzagging or other "normal" tuning behaviour. Additionally, there will be no automatic monitoring of the lock status, and hence no frontend events will be generated. If a frontend device is closed, this flag will be automatically turned off when the device is reopened read-write.

</para>

</entry>

 </row></tbody></tgroup></informaltable>



&return-value-dvb;

</section>

&sub-fe-set-frontend-tune-mode;



</section>