Teletext documentation

git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@24604 b3059339-0415-0410-9bf9-f77b7e298cf2

1 files changed, 91 insertions, 0 deletions

diff --git a/DOCS/xml/en/tvinput.xml b/DOCS/xml/en/tvinput.xml
index 549c24cda3..6bd902a68e 100644
--- a/DOCS/xml/en/tvinput.xml
+++ b/DOCS/xml/en/tvinput.xml
@@ -185,4 +185,95 @@ to a hardware limitation.
 </sect2>
 </sect1>
 
+
+<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+
+
+<sect1 id="tv-teletext">
+<title>Teletext</title>
+
+<para>
+Teletext is currently available only in MPlayer for v4l and v4l2 drivers.
+</para>
+
+<sect2 id="tv-teletext-implementation-notes">
+<title>Implementation notes</title>
+
+<para>
+<application>MPlayer</application> supports regular text, graphics and navigation links.
+Unfortunately, colored pages are not fully supported yet - all pages are shown as grayscaled.
+Subtitle pages (also known as Closed Captions) are supported, too.
+</para>
+
+<para>
+<application>MPlayer</application> starts caching all teletext pages upon
+starting to receive TV input, so you do not need to wait until the requested page is loaded.
+</para>
+
+<para>
+Note: Using teletext with <option>-vo xv</option> causes strange colors.
+</para>
+</sect2>
+
+<sect2 id="tv-teletext-usage">
+<title>Using teletext</title>
+
+<para>
+To enable teletext decoding you must specify the VBI device to get teletext data
+from (usually <filename>/dev/vbi0</filename> for Linux). This can be done by specifying
+<option>tdevice</option> in your configuration file, like shown below:
+<screen>tv=tdevice=/dev/vbi0</screen>
+</para>
+
+<para>
+You might need to specify the teletext language code for your country.
+To list all available country codes use
+<screen>tv=tdevice=/dev/vbi0:tlang=<replaceable>-1</replaceable></screen>
+Here is an example for Russian:
+<screen>tv=tdevice=/dev/vbi0:tlang=<replaceable>33</replaceable></screen>
+</para>
+
+<para>
+</para>
+</sect2>
+
+<sect2 id="tv-teletext-hotkeys">
+<title>Teletext hot keys</title>
+
+<informaltable frame="all">
+<tgroup cols="2">
+<thead>
+<row>
+  <entry>Key</entry>
+  <entry>Description</entry>
+</row>
+</thead>
+<tbody>
+<row>
+  <entry>X</entry>
+  <entry>Switch teletext display on/off</entry>
+</row>
+<row>
+  <entry>C</entry>
+  <entry>Cycle through teletext rendering modes (opaque, transparent, inverted opaque, 
+  inverted transparent</entry>
+</row>
+<row>
+  <entry>Left/Right</entry>
+  <entry>Go to previous/next teletext page</entry>
+</row>
+<row>
+  <entry>PageUp/PageDown</entry>
+  <entry>Go to next/previous teletext subpage</entry>
+</row>
+<row>
+  <entry>digits</entry>
+  <entry>Enter teletext page number to jump to</entry>
+</row>
+</tbody>
+</tgroup>
+</informaltable>
+</sect2>
+</sect1>
+
 </chapter>