1xawtvrc(5)                    File Formats Manual                   xawtvrc(5)
2
3
4

NAME

6       xawtvrc -- TV apps config file
7

SYNOPSIS

9       /etc/X11/xawtvrc
10       $HOME/.xawtv
11

DESCRIPTION

13       xawtvrc  is  the  config file originally used by xawtv only (that's why
14       the name xawtvrc).  These days a number  of  other  TV  applications  /
15       utilities read it too to get configuration information from it.
16
17       Both  a  global (/etc/X11/xawtvrc)  and personal ($HOME/.xawtv)  config
18       file  are used by the applications.   Settings  in the personal  config
19       file will overwrite the global ones.
20
21   Applications
22       The following applications use these config files:
23
24       xawtv  The classic X11 TV application.
25
26       motv   A better, motif-based GUI for xawtv ...
27
28       fbtv   TV application for the linux framebuffer console.
29
30       ttv    aalib-based TV application for any terminal.
31
32       v4lctl command line tool to control video4linux devices.
33
34   Create a config file
35       xawtv  and  motv  both  provide some functions to edit the channels and
36       save the configuration.  The save function will not preserve  any  com‐
37       ments you might have put into the config file throught ...
38
39       You  can  also use your favorite text editor and modify the config file
40       directly.
41
42       You can use the command line utility scantv to create a initial  config
43       file.   scantv will automatically scan all channels for TV stations and
44       write the ones it has found to the config file.
45

SYNTAX

47       xawtvrc uses the same syntax  like  smb.conf:  sections  starting  with
48       [name], followed by lines with option = value pairs.
49
50       There  are  four  special  sections: [global], [launch], [eventmap] and
51       [defaults].  All other sections describe a TV station each.
52
53   TV station options.
54       The following options are allowed for TV stations  and  the  [defaults]
55       section.   The  options from the [defaults] sections are used -- as the
56       name suggests -- as defaults for  all  other  channels.   You  can  put
57       everything  which is common for all TV stations (like the TV norm which
58       is used in your country) into the [defaults] section, so you don't have
59       to specify it for every single channel.
60
61       With  a  reasonable [defaults] section you usually only need to specify
62       the channel for each TV station, like this:
63
64       [ORB]
65       channel = 27
66
67       The other options are:
68
69       fine = n
70              finetuning (what left+right keys do within xawtv), default: 0
71
72       norm = pal | ntsc | secam
73              which TV norm, default is pal
74
75       key = keysym
76              Hotkey for the channel. All X11 keysyms allowed  here.  You  can
77              prefix a keysym with Modifier+, "Ctrl+F" for example.
78
79       capture = off | overlay | grabdisplay
80              capture  mode:  off, overlay (default, TV card => video, 0% cpu)
81              or grabdisplay (TV card => main memory  =>  X-Server  =>  video,
82              frame  rate depends on load and picture size).  Default is over‐
83              lay.  If it is not possible  to  use  overlay  for  some  reason
84              (remote  display,  not  supported by the hardware, whatever) the
85              applications will automatically fallback to grabdisplay.
86
87       input = Television | Composite1 | Composite2 | SVHS
88              input source.  The valid choices depend on the hardware  driver,
89              the  values  above are just examples.  You can use "v4lctl list"
90              to get a list of valid choices.
91
92       color = n
93
94       bright = n
95
96       hue = n
97
98       contrast = n
99              Valid range is 0-65535, default is 32768.  Adding a percent sym‐
100              bol  changes  the range to 0-100, i.e. "50%" has the same effect
101              like "32768".
102
103       audio = mono | stereo | lang1 | lang2
104              Set the audio mode for the given channel.
105
106       freq = n
107              Specify the frequency for the given  station  (MHz,  video  car‐
108              rier).   You  shouldn't need this for normal operation, all your
109              channels should be listed in the frequency table for  your  area
110              (if  not, mail me a patch).  Maybe unless you live near the bor‐
111              der and the foreign country uses another channel scheme.
112
113       midi = note
114              Use midi noteon event for <note> as hotkey for the channel.
115
116       group = name
117              Put the channel into the group <name>.  motv uses that to create
118              submenus per channel group.
119
120   Global options
121       A number of not channel-related settings go to the "[global]" section:
122
123       fullscreen = width x height
124              specify  which video mode should be used for full-screen.  Works
125              with XFree only, and of course you need  a  valid  modeline  for
126              this  mode in your XF86Config file.  You also have to enable the
127              VidMode extension (option -vm, see above) to make this work.
128
129       wm-off-by = [+-]x[+-]y
130              Some WM's handle static gravity  incorrectly  (I  know  mwm  and
131              kwm).   This is somewhat boring with fullscreen mode.  With this
132              option you can correct this with a displacement for moving  win‐
133              dows.   For  example,  wm-off-by  = -4-24 does the trick for kwm
134              (the KDE1 window manager).
135
136       freqtab =
137              select a channel-to-freqency mapping.  Options window->Frequency
138              table  (in  xawtv)  brings up a menu with all valid entries (and
139              allows table-switching at runtime).
140
141       pixsize = width x height
142              size of the channel pixmaps (within Channels window).  0x0  dis‐
143              ables this feature.
144
145       pixcols = n
146              number of columns the channel window should use.  Defaults to 1.
147
148       mixer = ctl | device:ctl
149              This  allows  volume control using the sound card mixer.  ctl is
150              the mixer control, i.e. "vol" for the master volume. "line1"  is
151              a  good  candidate  for the TV card.  device is the mixer device
152              (defaults to /dev/mixer in unspecified).   Volume-control  works
153              with the keypad: + is up, - is down, Enter is mute.
154
155       jpeg-quality = n
156              set  the  quality for (M)JPEG images/frames.  As usual the valid
157              range for n is [0 .. 100] with 75 as default.
158
159       keypad-ntsc = on | off
160              Configure keypad mode.  Default is off.  When set to on, numbers
161              typed  on the keypad are interpreted as channel numbers (this is
162              like NTSC TV sets work).  Otherwise they are interpreted as pro‐
163              grammed  station, i.e. 1 is the first station from $HOME/.xawtv,
164              ...
165
166       keypad-partial = on | off
167              Another configuration of keypad mode.  Default is on.  When  set
168              to  off,  typing one digit on the keypad doesn't change the sta‐
169              tion number when there are two-digit  station  numbers  starting
170              with that digit.
171
172       osd = on | off
173              Enable/disable the onscreen display in fullscreen mode.  Default
174              is on.
175
176       osd-position = x , y
177              Position the onscreen display, in pixels.  Default is 30,20.
178
179       use-wm-fullscreen = on | off
180              Enter fullscreen mode by asking the  window  manager  to  handle
181              that  via  _NET_WM_STATE_FULLSCREEN  (if  supported  by the wm).
182              Default is on.
183
184       ratio = x:y
185              Set a fixed aspect ratio for the TV image.  Default is 4:3.  Use
186              0:0 if you don't want a fixed aspect ratio.
187
188       mov-driver = files | raw | avi | mov
189
190       mov-video  = ppm | pgm | jpeg | rgb | gray | 422 | 422p | rgb15 | rgb24
191       | mjpeg | jpeg | raw | mjpa | png
192
193       mov-fps = fps
194
195       mov-audio = mono8 | mono16 | stereo
196
197       mov-rate = rate
198              Set defaults for movie recording.  Not all possible combinations
199              are valid choices.  "streamer -h" will print a nice list.
200
201       midi = port
202              You  can  specify  a  ALSA  port where xawtv should receive midi
203              events from.  If configured this way, you can program your  midi
204              keyboard  keys as station hotkeys and use midi controller events
205              to  control  settings  like  volume,  bright  etc.   Check   the
206              [eventmap] description below for details.
207
208       filter = name
209              Enable the specified filter.
210
211   The [launch] section
212       You  can  start  other  programs from within xawtv.  This is configured
213       with entries in the "[launch]" section:
214
215       label = key, command line
216              The specified hotkey will run the configured  program.   Calling
217              the  Action "Launch(label)" works too.  If you want to play with
218              the Xt translation tables, feel free to do so.  But  don't  com‐
219              plain if you broke something while doing so...
220
221   The [eventmap] section
222       The  eventmap  simply has a number of "event = action" lines.  "action"
223       can be any command which xawtv understands (check the xawtv-remote  man
224       page  for a list).  "event" is some event generated by any input device
225       xawtv listens to.  An event might have  some  argument,  the  midi-ctrl
226       events  for  example  have one.  If present the argument is appended to
227       the action.
228
229       There are default mappings for lirc and joystick input events,  so  you
230       don't  have  to  create an eventmap to use them.  But if you don't like
231       the defaults you can change them easily.
232
233       Here is a list of valid events:
234
235       lirc-key-<name>
236              The key <name> was pressed on the IR remote control.
237
238       joy-button-<n>
239              Joystick button <n> was pressed.
240
241       joy-axis-<left|right|up|down>
242              Joystick was moved into the given direction.
243
244       midi-note-<n>
245              noteon event for  note  <n>  was  received  (i.e.  you  probably
246              pressed some key on the midi keyboard).
247
248       midi-ctrl-<n>
249              midi  controller  message  for  control  <n> was received.  This
250              event has an argument (the current value of the control).
251
252       kbd-key-<name>
253              Key <name> was pressed on the keyboard.
254
255   sample config file
256       # this is a comment
257       # empty lines are ignored too
258
259       [global]
260       freqtab = europe-west
261       #mixer   = line
262       jpeg-quality = 75
263       midi = 64:0
264       fullscreen = 768x576
265
266       # for /etc/XF86Config
267       # Modeline  "pal"  50.00  768 832 856 1000  576 590 595 630  -hsync -vsync
268
269       [launch]
270       mixer = M, gtkaumix
271       AleVT = Ctrl+A, alevt
272
273       [eventmap]
274       midi-ctrl-7 = volume
275       kbd-key-h = msg "hello world"
276
277       [defaults]
278       input = television
279       norm  = pal
280
281       [ZDF]
282       channel=33
283       key=F1
284
285       [ORB]
286       channel = 27
287       key = F2
288
289       # more stations follow here
290
291       [Camera]
292       input = Composite1
293       key = K
294
295

SEE ALSO

297       scantv(1), xawtv(1), motv(1), fbtv(1), ttv(1), v4lctl(1)
298
299
300
301                                                                    xawtvrc(5)
Impressum