1
<sect1 id="zapping-commands">
2
<title>Commands</title>
4
<sect2 id="zapping-commands-cli">
5
<title>Command Line</title>
7
<para>Commands can be given on the command line when Zapping starts. This was intended to change video device properties, the program terminates after executing the command.</para>
8
<para><userinput>zapping -c "command"</userinput></para>
9
<para>A separate, lightweight tool is planned for this purpose, and to send commands to a running Zapping process. Up to version 0.6.x these commands are available:</para>
13
<term>set_channel (name | number)</term>
14
<listitem><para>Switch to the channel. By default the command tries to find the channel by its name (second column in the channel editor). When no such channel exists or the parameter is a number it selects the nth channel from the list, counted from zero up.</para>
19
<para>Starting with version 0.7 these commands are superseded by the new Python command set, see below.</para>
22
<sect2 id="zapping-commands-kbd">
23
<title>Keyboard Customization</title>
25
<para>Commands can be assigned to keyboard keys in the preferences. Starting with version 0.7 we use the new Python command set, see below.</para>
26
<para>The old command set listed here is automatically converted for compatibility with older versions of Zapping. The commands are generally equivalent to their new Python counterparts. Parameters in [square brackets] are optional.</para>
29
<listitem><para>channel_up</para></listitem>
30
<listitem><para>channel_down</para></listitem>
31
<listitem><para>set_channel nth</para></listitem>
32
<listitem><para>lookup_channel name</para></listitem>
33
<listitem><para>mute [toggle]</para></listitem>
34
<listitem><para>volume_incr [n]</para></listitem>
35
<listitem><para>ttx_open_new [page [subpage]]</para></listitem>
36
<listitem><para>ttx_page_incr [n]</para></listitem>
37
<listitem><para>ttx_subpage_incr [n]</para></listitem>
38
<listitem><para>ttx_home</para></listitem>
39
<listitem><para>ttx_hold [toggle]</para></listitem>
40
<listitem><para>ttx_reveal [toggle]</para></listitem>
41
<listitem><para>screenshot [format]</para></listitem>
42
<listitem><para>quickshot [format]</para></listitem>
46
<sect2 id="zapping-commands-lirc">
47
<title>LIRC/ALIRC Plugin</title>
49
<para>These commands are mostly superseded by the new Python command set, see below. They are still supported for compatibility with older versions of Zapping.</para>
54
<listitem><para>Terminate the program.</para></listitem>
58
<listitem><para>Switch to the next channel in the list.</para></listitem>
62
<listitem><para>Switch to the previous channel in the list.</para></listitem>
65
<term>SETCHANNEL n</term>
66
<listitem><para>The function of this command is affected by
67
the <link linkend="zapping-settings-main">preferences setting</link> for entering channel numbers on the numeric keypad. By the default it switches to the nth channel in the list, the count starts at zero. Alternatively the number is interpreted as the RF channel number of the requested channel.</para>
68
<para>Single digits combine to numbers when the command is executed repeatedly within a short period. For example "SETCHANNEL 1", "SETCHANNEL 3" jumps to channel 13.</para>
73
<listitem><para>Switch between fullscreen and windowed mode.</para></listitem>
77
<listitem><para>When audio is on, mute it, when muted switch it back on.</para></listitem>
81
<listitem><para>Increase the audio volume.</para></listitem>
85
<listitem><para>Decrease the audio volume.</para></listitem>
90
<sect2 id="zapping-commands-python">
91
<title>Python commands</title>
93
<para>Parameters in [square brackets] are optional. Parameters in 'single quotes' are strings, otherwise they are numbers. A toggle parameter can be zero to switch the property off, non-zero to switch it on, or it can be omitted to invert the current setting.</para>
95
<sect3 id="zapping-commands-python-general">
96
<title>General</title>
100
<term>zapping.quit()</term>
101
<listitem><para>Terminate the program.</para></listitem>
104
<term>zapping.switch_mode('mode')</term>
105
<listitem><para>Switch the current display mode. You can switch display mode and capture mode at once, for example: zapping.switch_mode('fullscreen capture').</para>
108
<term>'window'</term>
109
<listitem><para>display video or Teletext in a window</para></listitem>
112
<term>'fullscreen'</term>
113
<listitem><para>display video or Teletext fullscreen</para></listitem>
116
<term>'background'</term>
117
<listitem><para>like fullscreen, but puts the display in the background (if supported by the window manager)</para></listitem>
120
<term>'capture'</term>
121
<listitem><para>display video in capture mode (starting with version 0.7.2 this will not switch to window mode)</para></listitem>
124
<term>'overlay'</term>
125
<listitem><para>display video in overlay mode</para></listitem>
128
<term>'preview'</term>
129
<listitem><para>display video in overlay mode (starting with version 0.7.2 this will not switch to window mode)</para></listitem>
132
<term>'teletext'</term>
133
<listitem><para>display Teletext (starting with version 0.7.2 this will not switch to window mode)</para></listitem>
139
<term>zapping.toggle_mode('mode')</term>
140
<listitem><para>Switch to this mode. When this is already the current mode, switch to the previous mode. You can switch display and capture mode at once, for example: zapping.switch_mode('fullscreen capture').</para></listitem>
143
<term>zapping.restore_mode('mode')</term>
144
<listitem><para>Synonym for zapping.toggle_mode(), deprecated.</para></listitem>
147
<term>zapping.channel_up()</term>
148
<listitem><para>Switch to the next channel in the list.</para></listitem>
151
<term>zapping.channel_down()</term>
152
<listitem><para>Switch to the previous channel in the list.</para></listitem>
155
<term>zapping.set_channel(nth)</term>
156
<listitem><para>Switch to the nth channel in the list, the count starts at zero.</para></listitem>
159
<term>zapping.lookup_channel('name')</term>
160
<listitem><para>Switch to the channel with this name (second column in the channel editor).</para></listitem>
163
<term>zapping.resize_screen(width, height)</term>
164
<listitem><para>Resize the video window.</para></listitem>
167
<term>zapping.picture_size_cycle([n])</term>
168
<listitem><para>Switch to the next entry in the list of favourite picture sizes (as displayed in the context menu), +1 forward, -1 back.</para></listitem>
171
<term>zapping.hide_controls(toggle)</term>
172
<listitem><para>Whether to hide the main menu and toolbar.</para></listitem>
175
<term>zapping.keep_on_top(toggle)</term>
176
<listitem><para>Whether to keep the main window on top of all other windows (if this is supported by the window manager).</para></listitem>
181
<sect3 id="zapping-commands-python-dialogs">
182
<title>Dialogs</title>
186
<term>zapping.control_box()</term>
187
<listitem><para>Start the picture controls dialog.</para></listitem>
190
<term>zapping.program_info()</term>
191
<listitem><para>Start the program info dialog.</para></listitem>
193
<!-- temporarily disabled
195
<term>zapping.network_info()</term>
196
<listitem><para>Start the network info dialog.</para></listitem>
200
<term>zapping.channel_editor()</term>
201
<listitem><para>Start the channel editing dialog.</para></listitem>
204
<term>zapping.properties(['group' [, 'item']])</term>
205
<listitem><para>Start the properties dialog, optionally the given group and item.</para></listitem>
208
<term>zapping.plugin_properties()</term>
209
<listitem><para>Start the plugin properties dialog.</para></listitem>
212
<term>zapping.about()</term>
213
<listitem><para>Start the about dialog.</para></listitem>
216
<term>zapping.help()</term>
217
<listitem><para>Open the Zapping documentation.</para></listitem>
222
<sect3 id="zapping-commands-python-teletext">
223
<title>Teletext</title>
227
<term>zapping.ttx_open_new([page [, subpage]])</term>
228
<listitem><para>Open a Teletext window. When a page number is given, go to this page.</para></listitem>
231
<term>zapping.ttx_page_incr([n])</term>
232
<listitem><para>Advance the Teletext page number by n. This can be a positive or negative value, by default 1.</para></listitem>
235
<term>zapping.ttx_subpage_incr([n])</term>
236
<listitem><para>Advance the Teletext subpage number by n. This can be a positive or negative value, by default 1.</para></listitem>
239
<term>zapping.ttx_home()</term>
240
<listitem><para>Go to the Teletext home page, usually page 100.</para></listitem>
243
<term>zapping.ttx_history_prev()</term>
244
<listitem><para>Go to the previously visited page in the browse history.</para></listitem>
247
<term>zapping.ttx_history_next()</term>
248
<listitem><para>Go to the next visited page in the browse history.</para></listitem>
251
<term>zapping.ttx_hold(toggle)</term>
252
<listitem><para>Toggle the hold state of the displayed page. When off, Zapzilla will rotate through all subpages of the page, if it has any.</para></listitem>
255
<term>zapping.ttx_reveal(toggle)</term>
256
<listitem><para>Whether to reveal concealed characters on the displayed Teletext page.</para></listitem>
261
<sect3 id="zapping-commands-python-caption">
262
<title>Caption / Subtitles</title>
266
<term>zapping.closed_caption(toggle)</term>
267
<listitem><para>Whether to display closed caption superimposed onto the picture.</para></listitem>
270
<term>zapping.osd_render_markup('Hello <i>World</i>!')</term>
271
<listitem><para>Display text superimposed onto the picture, with Pango markup.</para></listitem>
274
<term>zapping.osd_render('Hello World!')</term>
275
<listitem><para>Display text superimposed onto the picture.</para></listitem>
280
<sect3 id="zapping-commands-python-audio">
285
<term>zapping.mute(toggle)</term>
286
<listitem><para>Change the audio mute control.</para></listitem>
289
<term>zapping.volume_incr([n])</term>
290
<listitem><para>This provisional command changed the audio recording volume, it is <emphasis>no longer supported</emphasis>.</para>
291
<para>As a replacement use zapping.control_incr('volume'[, n]) to change the soundcard mixer or video device volume as configured in the preferences dialog. Note that changing the volume does not unmute.</para></listitem>
296
<sect3 id="zapping-commands-python-controls">
297
<title>Controls</title>
301
<term>zapping.control_incr('name'[, n])</term>
302
<listitem><para>Advance the control value by n units, usually +1 or -1, default is +1. The following names are presently recognized:</para>
305
<term>'brightness'</term>
306
<listitem><para>picture brightness</para></listitem>
309
<term>'contrast'</term>
310
<listitem><para>picture contrast</para></listitem>
313
<term>'saturation'</term>
314
<listitem><para>picture color saturation</para></listitem>
318
<listitem><para>picture color hue</para></listitem>
321
<term>'volume'</term>
322
<listitem><para>audio volume</para></listitem>
326
<listitem><para>audio bass</para></listitem>
329
<term>'treble'</term>
330
<listitem><para>audio treble</para></listitem>
338
<sect3 id="zapping-commands-python-plugins">
339
<title>Plugins</title>
343
<term>zapping.screenshot(['format'])</term>
344
<listitem><para>Start the screenshot dialog and if given switch to the format. Currently valid formats are: 'jpeg' and 'ppm'.</para></listitem>
347
<term>zapping.quickshot(['format'])</term>
348
<listitem><para>Take a screenshot without starting the dialog. The last select file name will be used, with an incrementing number appended. When no format is given the last selected format will be used.</para></listitem>
351
<term>zapping.record(['format'])</term>
352
<listitem><para>Start the record dialog and if given switch to the format. Note this is the name the user gives a particular configuration, not the name of the file format.</para></listitem>
355
<term>zapping.quickrec(['format'])</term>
356
<listitem><para>Start recording without confirmation. The last select file name will be used, with an incrementing number appended. When no format is given the last selected format will be used.</para></listitem>
359
<term>zapping.stoprec()</term>
360
<listitem><para>Stop recording.</para></listitem>
370
sgml-parent-document: "zapping.xml"
371
comment-auto-fill-only-comments: t
372
indent-tabs-mode: nil
added
removed
help/C/commands.xml
