~ubuntu-branches/ubuntu/feisty/zapping/feisty

« back to all changes in this revision

Viewing changes to help/C/zapping.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2005-03-08 23:19:08 UTC
  • mfrom: (2.1.1 sarge)
  • Revision ID: james.westby@ubuntu.com-20050308231908-oip7rfv6lcmo8c0e
Tags: 0.9.2-2ubuntu1
Rebuilt for Python transition (2.3 -> 2.4)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 
4
  <!ENTITY appversion           "0.9">
 
5
  <!ENTITY manrevision          "0.3">
 
6
  <!ENTITY date                 "2005-02-18">
 
7
 
 
8
  <!ENTITY settings             SYSTEM "settings.xml">
 
9
  <!ENTITY channel-editor       SYSTEM "channel-editor.xml">
 
10
  <!ENTITY zapzilla             SYSTEM "zapzilla.xml">
 
11
  <!ENTITY commands             SYSTEM "commands.xml">
 
12
  <!ENTITY fdl-appendix         SYSTEM "fdl-appendix.xml">
 
13
 
 
14
  <!ENTITY eg                   "e.&nbsp;g.">
 
15
]>
 
16
 
 
17
<!-- =============Document Header ============================= -->
 
18
 
 
19
<article id="index" lang="en">
 
20
  <articleinfo> 
 
21
    <title>Zapping Manual &manrevision;</title>       
 
22
 
 
23
    <copyright> 
 
24
      <year>2004</year>
 
25
      <year>2005</year>
 
26
      <holder>Michael H. Schimek</holder> 
 
27
    </copyright>
 
28
 
 
29
    <copyright> 
 
30
      <year>2001</year>
 
31
      <holder>Emacs documentation team (Regexp introduction)</holder>
 
32
    </copyright>
 
33
 
 
34
    <authorgroup> 
 
35
      <author> 
 
36
        <firstname>Michael</firstname>
 
37
        <surname>Schimek</surname>
 
38
        <othername role="mi">H</othername>
 
39
        <affiliation>
 
40
          <address>
 
41
            <email>mschimek@users.sourceforge.net</email>
 
42
          </address>
 
43
        </affiliation>
 
44
      </author>
 
45
    </authorgroup>
 
46
 
 
47
    <releaseinfo>This manual describes version &appversion; of Zapping.</releaseinfo>
 
48
 
 
49
    <legalnotice>
 
50
      <title>Feedback</title> 
 
51
 
 
52
      <para>To report a bug or make a suggestion regarding this application or this manual, visit the <ulink url="http://sourceforge.net/tracker/?group_id=2599">Zapping bug tracker</ulink> or mail us at <ulink url="mailto:zapping-misc@lists.sourceforge.net"> zapping-misc@lists.sourceforge.net</ulink>.</para>
 
53
    </legalnotice>
 
54
 
 
55
  </articleinfo>
 
56
 
 
57
  <indexterm zone="index">
 
58
    <primary>Zapping</primary>
 
59
  </indexterm>
 
60
 
 
61
<!-- ============= Document Body ============================= -->
 
62
 
 
63
  <sect1 id="zapping-introduction"> 
 
64
    <title>Introduction</title>
 
65
 
 
66
    <para>With the Zapping application you can watch TV, take screenshots and record video and audio. Zapping has a deinterlacer and a Teletext viewer built in and supports Closed Caption and Teletext subtitles.</para>
 
67
 
 
68
    <para>This document describes version &appversion; of Zapping.</para>
 
69
  </sect1>
 
70
 
 
71
  <!-- Getting Started -->
 
72
 
 
73
  <sect1 id="zapping-getting-started"> 
 
74
    <title>Getting Started</title>
 
75
 
 
76
    <sect2 id="zapping-install">
 
77
      <title>Installation</title>
 
78
 
 
79
      <para>Which hardware is supported by Zapping?</para>
 
80
      <para>Zapping does not talk to hardware directly, it uses drivers already installed on your system. Hardware thus supported includes <emphasis>analog</emphasis> TV cards, graphic cards with video capture capability, both with and without tuner, and some USB cameras. Sorry I cannot usually answer if a particular brand and model will work.</para>
 
81
 
 
82
      <variablelist>
 
83
        <varlistentry>
 
84
          <term>Video4Linux or Video4Linux2 kernel drivers</term>
 
85
          <listitem>
 
86
            <para>Zapping can capture video, capture VBI (Teletext and Closed Caption) data and overlay video if this is supported by your driver. For installation and configuration of the driver please consult V4L or driver documentation.</para>
 
87
            <para>When the driver and your TV card supports video overlay the appearance can be improved by enabling the XFree86 V4L/XVideo interface driver. If it has not been done already, open the file <filename>/etc/X11/XF86Config</filename> and add <userinput>Load "v4l"</userinput> to the module section:</para>
 
88
            <programlisting>
 
89
Section "Module"
 
90
        &hellip;
 
91
        Load  "v4l"
 
92
EndSection
 
93
</programlisting>
 
94
          </listitem>
 
95
        </varlistentry>
 
96
        <varlistentry>
 
97
          <term>BKTR kernel driver (FreeBSD)</term>
 
98
          <listitem>
 
99
            <para>Zapping can capture video, capture VBI (Teletext and Closed Caption) data and overlay video with this driver. For installation and configuration of the driver please consult the FreeBSD handbook.</para>
 
100
          </listitem>
 
101
        </varlistentry>
 
102
        <varlistentry>
 
103
          <term>XVideo drivers</term>
 
104
          <listitem>
 
105
            <para>XVideo is an extension of the X Window system supporting video capture and output devices. With it, Zapping can display live video in a window. Video and VBI capturing is not possible with XVideo.</para>
 
106
          </listitem>
 
107
        </varlistentry>
 
108
      </variablelist>
 
109
    </sect2>
 
110
 
 
111
    <sect2 id="zapping-start">
 
112
      <title>To Start Zapping</title>
 
113
 
 
114
      <para>You can start Zapping in the following ways:</para>
 
115
      <variablelist>
 
116
        <varlistentry>
 
117
          <term><guimenu>Applications</guimenu> menu</term>
 
118
          <listitem>
 
119
            <para>Choose <menuchoice><guisubmenu>Sound and Video</guisubmenu>
 
120
                <guimenuitem>Zapping</guimenuitem></menuchoice>.</para>
 
121
          </listitem>
 
122
        </varlistentry>
 
123
        <varlistentry>
 
124
          <term>Command line</term>
 
125
          <listitem>
 
126
            <para>To start Zapping from a command line, type the following command, then press <keycap>Return</keycap>:</para>
 
127
            <para><command>zapping</command></para> 
 
128
          </listitem>
 
129
        </varlistentry>
 
130
      </variablelist>
 
131
    </sect2>
 
132
 
 
133
    <sect2 id="zapping-when-start">
 
134
      <title>When You Start Zapping</title>
 
135
 
 
136
      <para>When you start Zapping, the following window is displayed.</para>
 
137
 
 
138
      <figure id="zapping-figure"> 
 
139
        <title>Zapping</title> 
 
140
        <screenshot>
 
141
          <mediaobject> 
 
142
            <imageobject>
 
143
              <imagedata fileref="figures/zapping.png" format="PNG"/> 
 
144
            </imageobject>
 
145
          </mediaobject>
 
146
        </screenshot>
 
147
      </figure>
 
148
 
 
149
      <para>The Zapping window contains a menu, toolbar and a context menu which opens when you click on the video with the right mouse button.</para>
 
150
 
 
151
      <figure id="zapping-context-figure">
 
152
        <title>Zapping Context Menu</title>
 
153
        <screenshot>
 
154
          <mediaobject>
 
155
            <imageobject>
 
156
              <imagedata fileref="figures/zapping-context.png" format="PNG"/>
 
157
            </imageobject>
 
158
            <textobject>
 
159
              <phrase>Context menu.</phrase>
 
160
            </textobject>
 
161
          </mediaobject>
 
162
        </screenshot>
 
163
      </figure>
 
164
    </sect2>
 
165
  </sect1>
 
166
 
 
167
  <sect1 id="zapping-usage">
 
168
    <title>Usage</title>
 
169
 
 
170
    <sect2 id="zapping-video-modes">
 
171
      <title>Video Modes</title>
 
172
 
 
173
      <para>Zapping can work in windowed, fullscreen or background mode. In each mode it can show Teletext, captured images or it can overlay video. What is the difference?</para>
 
174
      <para>In capture mode Zapping programs your TV card to store images in main memory. This permits screenshots, deinterlacing and video recording. It is also quite CPU intensive because to display video Zapping must further pass the images to the X server which programs the graphics processor to convert the images from YUV to RGB format, scale them, and copy them into screen memory.</para>
 
175
      <para>In overlay mode the TV card stores the images directly in screen memory. This is a more efficient display method, but now Zapping cannot access the images. When you try to take a screenshot, activate deinterlacing or recording in this mode it will switch back to capture mode, if supported by your TV card.</para>
 
176
      <para>The available PCI bus bandwidth limits the image size in overlay mode. When the window or screen is larger than 768&times;576 pixels you will see a black border around the image. To avoid this Zapping can automatically <link linkend="zapping-settings-video-options">reduce the screen resolution</link> in fullscreen mode, or you can switch to capture mode. Capture mode is not limited if your graphics card supports image scaling.</para>
 
177
 
 
178
      <para>To switch between modes choose the mode from the <menuchoice>
 
179
          <guimenu>View</guimenu>
 
180
        </menuchoice> menu, or the context menu. To return from fullscreen or background mode to windowed press the <keycap>Esc</keycap> key.</para>
 
181
      <para>In windowed mode you can freely resize the video. You can either resize the window as usual by dragging its border, or choose a size from the context menu <menuchoice>
 
182
          <guimenu>Appearance</guimenu>
 
183
        </menuchoice> submenu. This menu is editable, see the <link linkend="zapping-settings-video-options">preferences</link> section for details.</para>
 
184
    </sect2>
 
185
 
 
186
    <sect2 id="zapping-channels">
 
187
      <title>To Change Channels</title>
 
188
 
 
189
      <para>To change between TV channels you can choose from the <menuchoice>
 
190
          <guimenu>Channels</guimenu>
 
191
        </menuchoice> main menu or the context menu. The menu also lists video inputs on the device and supported video standards. Note you can add composite video inputs to the channel list as well, see the <link linkend="zapping-channel-editor">Channel Editor</link> section for details.</para>
 
192
      <para>To change to the next or previous channel in the list click on the <guilabel>Ch. Up</guilabel> or <guilabel>Ch. Down</guilabel> button in the toolbar, or press the <keycap>Pg Up</keycap> or <keycap>Pg Dn</keycap> key.</para>
 
193
      <para>On the numeric keypad (if <keycap>NumLock</keycap> is activated) you can enter a channel number. Either the number of the RF channel, or a channel list number. This can be changed in the <link linkend="zapping-settings-main">preferences</link>.</para>
 
194
    </sect2>
 
195
 
 
196
    <sect2 id="zapping-controls">
 
197
      <title>Picture controls</title>
 
198
 
 
199
      <para>To change the picture brightness, contrast and other controls click on the <guilabel>Controls</guilabel> button in the toolbar. Control levels can be changed by keyboard too, as configured in <link linkend="zapping-settings-keyboard">preferences</link>.</para>
 
200
    </sect2>
 
201
 
 
202
    <sect2 id="zapping-volume">
 
203
      <title>Volume and Mute Functions</title>
 
204
      <para>You can change the audio volume or mute audio in the controls dialog, opened when you click on the <guilabel>Controls</guilabel> button in the toolbar.</para>
 
205
      <para>Further you can click on the <guilabel>Mute</guilabel> button in the toolbar or choose <menuchoice>
 
206
          <guimenu>View</guimenu>
 
207
          <guisubmenu>Mute</guisubmenu>
 
208
        </menuchoice>.</para>
 
209
      <para>You can also press <keycap>A</keycap> or the <keycap>Enter</keycap> key on the numeric keypad to mute or unmute, <keycap>+</keycap> or <keycap>-</keycap> to change the volume level.</para>
 
210
    </sect2>
 
211
 
 
212
    <sect2 id="zapping-caption">
 
213
      <title>Caption / Subtitles</title>
 
214
 
 
215
      <para>Zapping supports Closed Caption and Teletext subtitles. Strictly speaking caption is an aid for the hard of hearing while subtitles help viewers understand programs in foreign languages. Technically there is no difference, for simplicity we only refer to subtitles here.</para>
 
216
      <para>To enable subtitles choose the desired channel, page or language from the context menu <menuchoice>
 
217
          <guimenu>Subtitles</guimenu>
 
218
        </menuchoice> submenu. To disable subtitles choose <menuchoice>
 
219
          <guimenu>Subtitles</guimenu>
 
220
          <guisubmenu>Disable</guisubmenu>
 
221
        </menuchoice>. You can also click on the <guilabel>Subtitles</guilabel> button in the toolbar to enable or disable subtitles. When enabled, Zapping displays the Closed Caption channel or Teletext subtitle page last chosen on this channel.</para>
 
222
      <para>Closed Caption channels are always listed in the menu, if transmitted. Teletext subtitle pages might not be listed if the station fails to transmit a subtitle link. To choose a Teletext subtitle page manually start Teletext, go to the desired page and click on the <guilabel>Subtitles</guilabel> button in the toolbar.</para>
 
223
      <para>Presently it is not possible to record subtitles, this is planned for a later date.</para>
 
224
    </sect2>
 
225
 
 
226
    <sect2 id="zapping-screenshot">
 
227
      <title>Take a screenshot</title>
 
228
      <para>To take a screenshot click on the <guilabel>Screenshot</guilabel> button in the toolbar or press the <keycap>S</keycap> key. A dialog will open where you can choose a file name, image format and compression quality if applicable.</para>
 
229
      <para>The deinterlace option can remove interlace artefacts on the fly. It makes no sense to deinterlace scaled images, so the option is only available if the image height is 480 or 576 pixels.</para>
 
230
      <para>Screenshots are only possible if your TV card and its driver supports video capturing.</para>
 
231
    </sect2>
 
232
 
 
233
    <sect2 id="zapping-record">
 
234
      <title>Record video and audio</title>
 
235
      <para>To record video and/or audio click on the <guilabel>Record</guilabel> button in the toolbar or press the <keycap>R</keycap> key. A dialog will open where you can choose a file name and format. Click on the <guilabel>Record</guilabel> button in the dialog to start recording, on the <guilabel>Stop</guilabel> button to stop.</para>
 
236
      <para>File formats can be configured in <link linkend="zapping-settings-recording">preferences</link>. You can create different configurations and name them as desired.</para>
 
237
      <para>Video recording is only possible if your TV card and its driver supports video capturing in realtime. Video compression hardware is not yet supported.</para>
 
238
      <para>Currently recording is not supported on FreeBSD.</para>
 
239
    </sect2>
 
240
 
 
241
    <sect2 id="zapping-remote">
 
242
      <title>Using a Remote Control</title>
 
243
 
 
244
      <para>Zapping supports the LIRC (Linux Infrared Remote Control) infrastructure. Visit <ulink url="http://www.lirc.org">http://www.lirc.org</ulink> for more information about LIRC.</para>
 
245
      <para>To use LIRC you must create a <filename>.lircrc</filename> file in your home directory. For each remote control button add an entry like these:</para><programlisting>
 
246
        begin
 
247
                prog   = zapping_lirc
 
248
                button = VOL_UP
 
249
                config = zapping.volume_incr(+5)
 
250
        end
 
251
 
 
252
        begin
 
253
                prog   = zapping_lirc
 
254
                button = 0
 
255
                config = SETCHANNEL 0
 
256
        end
 
257
 
 
258
        begin
 
259
                prog   = zapping_lirc
 
260
                button = 1
 
261
                config = SETCHANNEL 1
 
262
        end
 
263
 
 
264
        begin
 
265
                prog   = zapping_lirc
 
266
                button = 9
 
267
                config = SETCHANNEL 9
 
268
        end
 
269
</programlisting>
 
270
      <variablelist>
 
271
        <varlistentry>
 
272
          <term>prog</term>
 
273
          <listitem><para>is the program interpreting the command and must be <userinput>zapping_lirc</userinput></para>
 
274
          </listitem>
 
275
        </varlistentry>
 
276
        <varlistentry>
 
277
          <term>button</term>
 
278
          <listitem><para>is the name of the remote control button. Presumably with LIRC you installed <filename>/etc/lircd.conf</filename>, this file lists all available buttons.</para>
 
279
          </listitem>
 
280
        </varlistentry>
 
281
        <varlistentry>
 
282
          <term>config</term>
 
283
          <listitem><para>is a Zapping command. Valid commands are listed in the <link linkend="zapping-commands-lirc">Commands</link> section.</para>
 
284
          </listitem>
 
285
        </varlistentry>
 
286
      </variablelist>
 
287
      <para>Suppose your remote control has a <guilabel>TV/RADIO</guilabel> button and you want to switch between two layers of commands, much like <keycap>Shift Lock</keycap> switches between lower and upper case characters.</para>
 
288
      <para>This can be accomplished by embracing the entries above within a zapping_lirc section, and programming the <guilabel>TV/RADIO</guilabel> button to enable this section, "switch to this mode" in LIRC speak.</para><programlisting>
 
289
begin zapping_lirc
 
290
        begin
 
291
                button = TV/RADIO
 
292
                mode   = radio
 
293
        end
 
294
 
 
295
        Zapping entries &hellip;
 
296
end zapping_lirc
 
297
 
 
298
begin radio
 
299
        begin
 
300
                button = TV/RADIO
 
301
                mode   = zapping_lirc
 
302
        end
 
303
 
 
304
        Other entries &hellip;
 
305
end radio
 
306
 
 
307
Mode-independend entries &hellip;
 
308
</programlisting>
 
309
      <para>Which mode will be initially selected? Well, none. But when you start Zapping it automatically switches to zapping_lirc mode, if such a section exists.</para>
 
310
      <para>For further instructions please see the LIRC documentation.</para>
 
311
    </sect2>
 
312
 
 
313
  </sect1>
 
314
 
 
315
  &settings;
 
316
  &channel-editor;
 
317
  &zapzilla;
 
318
  &commands;
 
319
 
 
320
  <sect1 id="zapping-about"> 
 
321
    <title>About Zapping</title> 
 
322
 
 
323
    <para>Zapping was written by Iñaki García Etxebarria, Michael H. Schimek and many contributors. Visit our web page at <ulink url="http://zapping.sourceforge.net" type="http"> http://zapping.sourceforge.net</ulink>.</para>
 
324
    <para>To report a bug or make a suggestion regarding this application or this manual, visit the <ulink url="http://sourceforge.net/tracker/?group_id=2599">Zapping bug tracker</ulink> or mail us at <ulink url="mailto:zapping-misc@lists.sourceforge.net"> zapping-misc@lists.sourceforge.net</ulink>.</para>
 
325
    <para>This program is distributed under the terms of the <ulink url="ghelp:gpl" type="help">GNU General Public License</ulink> as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. A copy of this license can be found in the file COPYING included with the source code of this program.</para>
 
326
  </sect1>
 
327
 
 
328
  &fdl-appendix;
 
329
 
 
330
</article>
 
331
 
 
332
<!--
 
333
Local Variables:
 
334
mode: sgml
 
335
coding: utf-8
 
336
comment-auto-fill-only-comments: t
 
337
indent-tabs-mode: nil
 
338
End:
 
339
-->