Gentoo Archives: gentoo-doc-cvs

From: Josh Saddler <nightmorph@×××××××××××.org>
To: gentoo-doc-cvs@l.g.o
Subject: [gentoo-doc-cvs] cvs commit: vdr-guide.xml
Date: Wed, 03 Jan 2007 00:58:55
Message-Id: 20070103005839.0228064823@smtp.gentoo.org
1 nightmorph 07/01/03 00:58:38
2
3 Modified: vdr-guide.xml
4 Log:
5 new additions to the VDR guide from bug 159142 have been given a thorough overhaul; lots of new stuff for VDR/DVB users
6
7 Revision Changes Path
8 1.5 xml/htdocs/doc/en/vdr-guide.xml
9
10 file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/vdr-guide.xml?rev=1.5&view=markup
11 plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/vdr-guide.xml?rev=1.5&content-type=text/plain
12 diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/vdr-guide.xml?r1=1.4&r2=1.5
13
14 Index: vdr-guide.xml
15 ===================================================================
16 RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/vdr-guide.xml,v
17 retrieving revision 1.4
18 retrieving revision 1.5
19 diff -u -r1.4 -r1.5
20 --- vdr-guide.xml 16 Nov 2006 04:53:37 -0000 1.4
21 +++ vdr-guide.xml 3 Jan 2007 00:58:38 -0000 1.5
22 @@ -1,5 +1,5 @@
23 <?xml version="1.0" encoding="UTF-8"?>
24 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/vdr-guide.xml,v 1.4 2006/11/16 04:53:37 nightmorph Exp $ -->
25 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/vdr-guide.xml,v 1.5 2007/01/03 00:58:38 nightmorph Exp $ -->
26 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
27
28 <guide link="/doc/en/vdr-guide.xml">
29 @@ -11,6 +11,9 @@
30 <author title="Author">
31 <mail link="diox@g.o">Dimitry Bradt</mail>
32 </author>
33 +<author title="Author">
34 + <mail link="zzam@g.o">Matthias Schwarzott</mail>
35 +</author>
36 <author title="Editor">
37 <mail link="nightmorph@g.o">Joshua Saddler</mail>
38 </author>
39 @@ -23,8 +26,8 @@
40 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
41 <license/>
42
43 -<version>1.3</version>
44 -<date>2006-11-15</date>
45 +<version>1.4</version>
46 +<date>2007-01-02</date>
47
48 <chapter>
49 <title>General information to DVB</title>
50 @@ -88,7 +91,7 @@
51 <body>
52
53 <p>
54 -First, we must ensure that your kernel supports DVB and your DVB device. Since
55 +First, we must ensure that your kernel supports DVB and your DVB device. Since
56 kernel version 2.6 the necessary drivers are included. Check your kernel
57 configuration and make sure the following options are selected as a static
58 driver or as modules.
59 @@ -150,11 +153,11 @@
60 <body>
61
62 <p>
63 -It's recommended to mark every driver as module, so you are able to add the
64 +It's recommended to mark every driver as module, so that you can to add the
65 required module dynamically, especially if you don't know the module name. If
66 -you know the module name already, select the driver as built-in driver. Compile
67 -the kernel, install the modules and boot it. Check to see if your kernel has
68 -successfully detected your card by using <c>dmesg</c>.
69 +you know the module name already, select the driver as a built-in driver.
70 +Compile the kernel, install the modules and boot it. Check to see if your kernel
71 +has successfully detected your card by using <c>dmesg</c>.
72 </p>
73
74 <pre caption="Checking kernel output">
75 @@ -164,29 +167,83 @@
76 input: TerraTec/qanu USB2.0 Highspeed DVB-T Receiver remote control as /class/input/input2
77 </pre>
78
79 +</body>
80 +</section>
81 +</chapter>
82 +
83 +<chapter id="inst_vdr">
84 +<title>Installing VDR</title>
85 +<section>
86 +<body>
87 +
88 +<p>
89 +To install VDR, we just emerge it.
90 +</p>
91 +
92 +<pre caption="Installing VDR">
93 +# <i>emerge vdr</i>
94 +</pre>
95 +
96 <p>
97 -Now continue with <uri link="#inst_lirc">installing LIRC</uri> if you want to
98 -use a remote control.
99 +Now continue with <uri link="#inst_ir_remote">Installing the Remote Control</uri>.
100 </p>
101
102 </body>
103 </section>
104 </chapter>
105
106 -<chapter id="inst_lirc">
107 -<title>Configuring the remote control - LIRC</title>
108 +<chapter id="inst_ir_remote">
109 +<title>Installing the Remote Control</title>
110 +<section>
111 +<body>
112 +
113 +<p>
114 +There are at least two ways to control VDR via an infrared remote control. If
115 +your TV card has an onboard IR receiver you can use <c>vdr-remote</c>.
116 +Otherwise, you most likely need to use LIRC.
117 +</p>
118 +
119 +</body>
120 +</section>
121 +<section>
122 +<title>Installing vdr-remote</title>
123 +<body>
124 +
125 +<p>
126 +We first install the plugin via emerge:
127 +</p>
128 +
129 +<pre caption="Installing vdr-remote">
130 +# <i>emerge vdr-remote</i>
131 +# <i>emerge --config vdr-remote</i>
132 +</pre>
133 +
134 +<p>
135 +When using the remote plugin for the IR port on your DVB card everything should
136 +be fine with the default config. It automatically uses the input device which
137 +has "dvb" in its name. For more advanced uses take a look at
138 +<path>/etc/conf.d/vdr.remote</path>.
139 +</p>
140 +
141 +<p>
142 +Now, continue with <uri link="#video-out">Video Output Methods</uri>.
143 +</p>
144 +
145 +</body>
146 +</section>
147 <section>
148 -<title>Installing LIRC</title>
149 +<title>Alternative: installing LIRC</title>
150 <body>
151
152 <p>
153 -If your card can be remotely controlled, you may wish to configure LIRC. LIRC
154 -interprets the pressed keys and returns a name for each one. A program that
155 -supports LIRC waits for key events and runs the action configured in the config
156 -file, mostly stored in the config directory of the executing program (e.g.
157 -<c>mplayer</c> loads the file <path>~/.mplayer/lircrc</path>). Before we
158 -install LIRC, you have to add <c>lirc</c> to your USE flags and add an
159 -additional entry to <path>/etc/make.conf</path>: <c>LIRC_DEVICES</c>. Use <uri
160 +If your card can be remotely controlled (but you cannot or do not want to use
161 +<c>vdr-remote</c>), you may wish to configure LIRC. LIRC interprets the pressed
162 +keys and returns a name for each one. A program that supports LIRC waits for key
163 +events and runs the action configured in the config file, mostly stored in the
164 +config directory of the executing program (e.g. <c>mplayer</c> loads the file
165 +<path>~/.mplayer/lircrc</path>). Before we install LIRC, you have to add
166 +<c>lirc</c> to your USE flags and add an additional entry to
167 +<path>/etc/make.conf</path>: <c>LIRC_DEVICES</c>. Use <uri
168 link="http://www.lirc.org/html/table.html">this list</uri> to find the proper
169 arguments for the option.
170 </p>
171 @@ -244,6 +301,21 @@
172 </pre>
173
174 <p>
175 +Now it should be possible to watch <c>lircd</c> running and decoding key-presses.
176 +Just run the command <c>irw</c>. Stop it with pressing Ctrl+C when you have
177 +enough.
178 +</p>
179 +
180 +<pre caption="Testing LIRC">
181 +# <i>irw</i>
182 +0000000000001aa2 00 Exit Technisat_TTS35AI.conf
183 +0000000000001a8d 00 Mute Technisat_TTS35AI.conf
184 +0000000000000a97 00 OK Technisat_TTS35AI.conf
185 +0000000000000a97 01 OK Technisat_TTS35AI.conf
186 +0000000000000a92 00 Menu Technisat_TTS35AI.conf
187 +</pre>
188 +
189 +<p>
190 Next, add it to the default runlevel so that it starts automatically at boot.
191 </p>
192
193 @@ -251,74 +323,104 @@
194 # <i>rc-update add lircd default</i>
195 </pre>
196
197 +<p>
198 +To be able to use your remote control, you must enable LIRC support in VDR. Add
199 +the following line to <path>/etc/conf.d/vdr</path>:
200 +</p>
201 +
202 +<pre caption="Enabling support for LIRC">
203 +# <i>nano -w /etc/conf.d/vdr</i>
204 +IR_CTRL="lirc"
205 +</pre>
206 +
207 </body>
208 </section>
209 </chapter>
210
211 -<chapter>
212 -<title>Setting up VDR</title>
213 +<chapter id="video-out">
214 +<title>Video Output Methods</title>
215 <section>
216 -<title>Installing VDR</title>
217 <body>
218
219 <p>
220 -To install VDR, we just emerge it.
221 +You now need to decide on one (and only one!) of the following video output
222 +devices which show the picture and the overlayed On Screen Display (OSD).
223 </p>
224
225 -<pre caption="Installing VDR">
226 -# <i>emerge vdr</i>
227 -</pre>
228 +</body>
229 +</section>
230 +<section id="vdr-dxr3">
231 +<title>Hardware decoding: full-featured DVB cards</title>
232 +<body>
233
234 <p>
235 -If you want to be able to use your remote control, we have to enable LIRC
236 -support in VDR. Add the following line to the <path>/etc/conf.d/vdr</path>:
237 +Users of these expensive cards need not install anything else, so you may
238 +continue with <uri link="#channel_list">configuring your channel list</uri>.
239 </p>
240
241 -<pre caption="Enabling support for LIRC">
242 -# <i>nano -w /etc/conf.d/vdr</i>
243 -IR_CTRL="lirc"
244 +</body>
245 +</section>
246 +<section id="vdr-dxr3">
247 +<title>Hardware decoding: DXR3/Hollywood+ cards</title>
248 +<body>
249 +
250 +<p>
251 +To use a DXR3 card for VDR output we need the <c>vdr-dxr3</c> plugin.
252 +</p>
253 +
254 +<pre caption="Installing the plugin">
255 +# <i>emerge vdr-dxr3</i>
256 +# <i>echo em8300 &gt;&gt; /etc/modules.autoload.d/kernel-2.6</i>
257 </pre>
258
259 -<note>
260 -There's a remote configuration file available at Matthias Schwarzott's <uri
261 -link="http://dev.gentoo.org/~zzam/remote.conf">devspace</uri>. You will need to
262 -run <c>chown vdr:vdr</c> on the file to get it working.
263 -</note>
264 +<p>
265 +em8300-modules needs some configuration that depends on the exact used
266 +revision of the card.
267 +</p>
268
269 +<!--
270 <p>
271 -You'll probably want to configure your channels at this point. The VDR project
272 -provides you with some examples which can be found at
273 -<path>/usr/share/doc/vdr-analogtv-$version/examples/</path>, as long as you've
274 -installed &gt;=<c>media-plugins/vdr-analogtv-1.0.00-r1</c>.
275 +Because we (the authors) don't own a card that uses the dxr3config, we decided
276 +to skip this part till we have one at our disposal.
277 </p>
278 +-->
279
280 <p>
281 -Next, start VDR and add it to the default runlevel:
282 +Continue with <uri link="#channel_list">configuring your channel list</uri>.
283 </p>
284
285 -<pre caption="Adding vdr to the default runlevel">
286 -# <i>/etc/init.d/vdr start</i>
287 -# <i>rc-update add vdr default</i>
288 +</body>
289 +</section>
290 +<section id="vdr-pvr350">
291 +<title>Hardware decoding: PVR350 cards</title>
292 +<body>
293 +
294 +<p>
295 +As PVR350 cards have an onboard MPEG-Decoder chip we want to make use of that.
296 +We need to install the <c>vdr-pvr350</c> plugin. If <c>ivtv-driver</c> is not
297 +yet installed emerge will automatically install it for you. To have the ivtv
298 +module loaded at boot we add it to
299 +<path>/etc/modules.autoload.d/kernel-2.6</path>:
300 +</p>
301 +
302 +<pre caption="Installing PVR350-Plugin">
303 +# <i>emerge vdr-pvr350</i>
304 +# <i>echo ivtv &gt;&gt; /etc/modules.autoload.d/kernel-2.6</i>
305 </pre>
306
307 <p>
308 -Now that the basic installation is over, you need to configure VDR. Switch to
309 -your output screen and follow the on-screen instructions. VDR asks you to press
310 -various keys on your remote control to learn the correct key codes. In case you
311 -don't own a remote control unit, you can use your keyboard. If you only have a
312 -budget card, you need to install a software output plugin, or <e>softdevice
313 -plugin</e>. This decodes the stream and offers a device to access.
314 +Continue with <uri link="#channel_list">configuring your channel list</uri>.
315 </p>
316
317 </body>
318 </section>
319 -<section id="softdevice">
320 -<title>Optional: Installing a softdevice plugin</title>
321 +<section id="vdr-xineliboutput">
322 +<title>Software decoding: vdr-softdevice</title>
323 <body>
324
325 <p>
326 -To install a softdevice, we have to emerge <c>vdr-softdevice</c>. Don't forget
327 -to configure the plugin.
328 +To install it, we have to emerge <c>vdr-softdevice</c>. Don't forget
329 +to enable the plugin.
330 </p>
331
332 <pre caption="Installing the softdevice plugin">
333 @@ -331,10 +433,29 @@
334 <path>/etc/conf.d/vdr.softdevice</path>.
335 </p>
336
337 +<p>
338 +For now, we will only describe the shm ("shared memory") method. This is already
339 +enabled in the installed config file (Setting SOFTDEVICE_VIDEO_OUT). Later you
340 +need to start <c>ShmClient</c> to get a window showing the picture.
341 +</p>
342 +
343 +<note>
344 +If you do not want to think about a separate keyboard layout for controlling VDR
345 +with softdevice/shm there is a remote configuration file available at Matthias
346 +Schwarzott's <uri
347 +link="http://dev.gentoo.org/~zzam/remote.softdevice-shm.conf">devspace</uri>.
348 +You will need to copy it to <path>/etc/vdr/remote.conf</path> and run <c>chown
349 +vdr:vdr</c> on the file to get it working.
350 +</note>
351 +
352 +<p>
353 +Continue with <uri link="#channel_list">configuring your channel list</uri>.
354 +</p>
355 +
356 </body>
357 </section>
358 <section id="vdr-xineliboutput">
359 -<title>Optional: Alternate installation of a softdevice plugin</title>
360 +<title>Software decoding: vdr-xineliboutput</title>
361 <body>
362
363 <p>
364 @@ -349,8 +470,8 @@
365 </pre>
366
367 <p>
368 -Adding command line options at this point is crucial for your softdevice to
369 -work. For more options, see <c>vdr --help</c>.
370 +Adding command line options at this point is crucial for xineliboutput to work.
371 +For more options, see <c>vdr --help</c>.
372 </p>
373
374 <pre caption="Adding command line options to /etc/conf.d/vdr.xineliboutput">
375 @@ -368,37 +489,212 @@
376 127.0.0.1 <comment>(always accept localhost)</comment>
377 192.168.1.0/24 <comment>(any host on the local net)</comment>
378 #204.152.189.113 <comment>(a specific host)</comment>
379 -#0.0.0.0/0 <comment>(any host on any net (USE THIS WITH CARE!))</comment>
380 +#0.0.0.0/0 <comment>(any host on any net - USE THIS WITH CARE!)</comment>
381 </pre>
382
383 <p>
384 -You must restart VDR for the changes to take effect:
385 +If you only want to use <c>vdr-xineliboutput</c> to view the picture
386 +on the same PC running VDR you can now
387 +<uri link="#channel_list">continue with configuring your channel-list</uri>.
388 </p>
389
390 -<pre caption="Restarting VDR">
391 -# <i>/etc/init.d/vdr restart</i>
392 -* Stopping vdr ... [ ok ]
393 +<p>
394 +Otherwise, you now simply <c>emerge media-plugins/vdr-xineliboutput</c> on your
395 +client:
396 +</p>
397 +
398 +<pre caption="Client setup">
399 +# <i>emerge vdr-xineliboutput</i>
400 +</pre>
401 +
402 +<p>
403 +Later (after having started VDR) you will use the command <c>vdr-sxfe
404 +xvdr://hostname</c> to connect to VDR and view its picture and OSD.
405 +</p>
406 +
407 +<p>
408 +Continue with <uri link="#channel_list">configuring your channel list</uri>.
409 +</p>
410 +
411 +<note>
412 +There is also a plugin which just simulates the existance of a real
413 +output device (<c>vdr-dummydevice</c>) for some fancy uses like record-only
414 +servers, but that is more advanced than a normal VDR setup.
415 +</note>
416 +
417 +</body>
418 +</section>
419 +</chapter>
420 +
421 +<chapter id="channel_list">
422 +<title>Creating a Channel List</title>
423 +<section>
424 +<body>
425 +
426 +<p>
427 +To make VDR really useful you need to create an appropriate channel list.
428 +</p>
429 +
430 +<p>
431 +There is more than one way to get a working list of channels (besides
432 +downloading one). The channel list installed by default is for DVB-S reception
433 +on Astra on 19.2°E.
434 +</p>
435 +
436 +</body>
437 +</section>
438 +<section>
439 +<title>Using dvbscan from linuxtv-dvb-apps</title>
440 +<body>
441 +
442 +<pre caption="Installing linuxtv-dvb-apps">
443 +# <i>emerge linuxtv-dvb-apps</i>
444 +</pre>
445 +
446 +<p>
447 +Find the correct frequency list for your region and type of reception. These
448 +files are stored under <path>/usr/share/dvb/scan</path>. For reception with
449 +DVB-T in Germany, Region Nuernberg you need to use
450 +<path>/usr/share/dvb/scan/dvb-t/de-Nuernberg</path>.
451 +</p>
452 +
453 +<pre caption="Scanning with dvbscan">
454 +$ <i>dvbscan -o vdr /usr/share/dvb/scan/dvb-t/de-Nuernberg &gt; /etc/vdr/channels.conf</i>
455 +</pre>
456 +
457 +</body>
458 +</section>
459 +<section>
460 +<title>Using vdr-reelchannelscan</title>
461 +<body>
462 +
463 +<p>
464 +First, delete the contents of the existing channel list.
465 +</p>
466 +
467 +<pre caption="Cleaning old channel-list">
468 +# <i>rm /etc/vdr/channels.conf</i>
469 +</pre>
470 +
471 +<pre caption="Installing and activating vdr-reelchannelscan">
472 +# <i>emerge vdr-reelchannelscan</i>
473 +# <i>emerge --config vdr-reelchannelscan</i>
474 +</pre>
475 +
476 +</body>
477 +</section>
478 +<section>
479 +<title>Channels for systems using vdr-analogtv</title>
480 +<body>
481 +
482 +<p>
483 +You'll probably want to configure your channels at this point. The VDR project
484 +provides you with some examples which can be found at
485 +<path>/usr/share/doc/vdr-analogtv-$version/examples/</path>, as long as you've
486 +installed &gt;=<c>media-plugins/vdr-analogtv-1.0.00-r1</c>.
487 +</p>
488 +
489 +</body>
490 +</section>
491 +</chapter>
492 +
493 +<chapter>
494 +<title>Starting VDR</title>
495 +<section>
496 +<body>
497 +
498 +<p>
499 +After having all basic software parts ready on the system you need to
500 +configure VDR with its OSD.
501 +</p>
502 +
503 +<p>
504 +If you use a hardware decoder for picture output you should switch on the
505 +connected TV now. If you use software output the client for this must be started
506 +after VDR.
507 +</p>
508 +
509 +<p>
510 +First, you should learn your key definitions; that is, connecting keys on your
511 +remote control to VDR's internal commands.
512 +</p>
513 +
514 +<note>
515 +Just in case you need to edit the keyboard configuration, or (more likely) want
516 +to delete it to go back to learning the keys: VDR stores its key-definitions in
517 +<path>/etc/vdr/remote.conf</path>.
518 +</note>
519 +
520 +<p>
521 +We begin with starting VDR:
522 +</p>
523 +
524 +<pre caption="Starting VDR">
525 +# <i>/etc/init.d/vdr start</i>
526 * Preparing start of vdr:
527 * config files ... [ ok ]
528 * Waiting for prerequisites (devices nodes etc.) ... [ ok ]
529 * Starting vdr ... [ ok ]
530 -* Waiting for working vdr ... [ ok ]
531 +* First start of vdr: No check for running vdr possible
532 +* until control device (remote/keyboard) keys are learnt!
533 +</pre>
534 +
535 +<note>
536 +Users of software decoders should now start the client program that opens the
537 +window to show the TV picture and the OSD.
538 +</note>
539 +
540 +<pre caption="Activating the software decoder for the client">
541 +<comment>(For users of vdr-softdevice)</comment>
542 +# <i>ShmClient</i>
543 +<comment>(For users of vdr-xineliboutput)</comment>
544 +# <i>vdr-sxfe xvdr://hostname</i>
545 </pre>
546
547 <p>
548 -Now, simply <c>emerge media-plugins/vdr-xineliboutput</c> on your client, and
549 -start it.
550 +The most useful keys for VDR are:
551 </p>
552 +<ul>
553 + <li>Cursor keys (Left/Right/Up/Down)</li>
554 + <li>Menu/Exit/Ok</li>
555 + <li>Colors (Red/Green/Yellow/Blue)</li>
556 + <li>Number keys (0-9)</li>
557 +</ul>
558
559 -<pre caption="Client setup">
560 -# <i>emerge vdr-xineliboutput</i>
561 -$ <i>vdr-sxfe xvdr://hostname</i>
562 -</pre>
563 +<impo>
564 +If you don't have many keys, make sure to assign these. (Some remotes have
565 +Play/Pause/etc. on the same keys as the colors, so use them for the colors).
566 +</impo>
567
568 <p>
569 -Sit back and enjoy your new video streaming capabilities. :)
570 +Now that the basic installation is over, you need to configure VDR. Switch to
571 +your output screen and follow the on-screen instructions. VDR asks you to press
572 +various keys on your remote control to learn the correct key codes. If you don't
573 +own a remote control, you can use your keyboard.
574 </p>
575
576 +<!--<p>
577 +TODO: Add a configuration howto for remote controls etc.
578 +</p>-->
579 +
580 +<p>
581 +Now you can add the VDR initscript to the default runlevel to get it started
582 +every time your computer boots up.
583 +</p>
584 +
585 +<pre caption="Adding vdr to the default runlevel">
586 +# <i>rc-update add vdr default</i>
587 +</pre>
588 +
589 +</body>
590 +</section>
591 +</chapter>
592 +
593 +<chapter>
594 +<title>Troubleshooting</title>
595 +<section>
596 +<body>
597 +
598 <note>
599 If you need any help, you can always ask someone in <uri
600 link="irc://irc.freenode.org/gentoo-vdr">#gentoo-vdr</uri>, or look around on
601
602
603
604 --
605 gentoo-doc-cvs@g.o mailing list