public inbox for gentoo-doc-cvs@lists.gentoo.org
 help / color / mirror / Atom feed
From: "Josh Saddler" <nightmorph@lark.gentoo.org>
To: gentoo-doc-cvs@lists.gentoo.org
Subject: [gentoo-doc-cvs] cvs commit: vdr-guide.xml
Date: Wed,  3 Jan 2007 00:58:38 +0000	[thread overview]
Message-ID: <20070103005839.0228064823@smtp.gentoo.org> (raw)

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain, Size: 18556 bytes --]

nightmorph    07/01/03 00:58:38

  Modified:             vdr-guide.xml
  Log:
  new additions to the VDR guide from bug 159142 have been given a thorough overhaul; lots of new stuff for VDR/DVB users

Revision  Changes    Path
1.5                  xml/htdocs/doc/en/vdr-guide.xml

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/vdr-guide.xml?rev=1.5&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/vdr-guide.xml?rev=1.5&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/vdr-guide.xml?r1=1.4&r2=1.5

Index: vdr-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/vdr-guide.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- vdr-guide.xml	16 Nov 2006 04:53:37 -0000	1.4
+++ vdr-guide.xml	3 Jan 2007 00:58:38 -0000	1.5
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/vdr-guide.xml,v 1.4 2006/11/16 04:53:37 nightmorph Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/vdr-guide.xml,v 1.5 2007/01/03 00:58:38 nightmorph Exp $ -->
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
 <guide link="/doc/en/vdr-guide.xml">
@@ -11,6 +11,9 @@
 <author title="Author">
   <mail link="diox@gentoo.org">Dimitry Bradt</mail>
 </author>
+<author title="Author">
+  <mail link="zzam@gentoo.org">Matthias Schwarzott</mail>
+</author>
 <author title="Editor">
   <mail link="nightmorph@gentoo.org">Joshua Saddler</mail>
 </author>
@@ -23,8 +26,8 @@
 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
 <license/>
 
-<version>1.3</version>
-<date>2006-11-15</date>
+<version>1.4</version>
+<date>2007-01-02</date>
 
 <chapter>
 <title>General information to DVB</title>
@@ -88,7 +91,7 @@
 <body>
 
 <p>
-First, we must ensure that your kernel supports DVB and your DVB device.  Since
+First, we must ensure that your kernel supports DVB and your DVB device. Since
 kernel version 2.6 the necessary drivers are included. Check your kernel
 configuration and make sure the following options are selected as a static
 driver or as modules.
@@ -150,11 +153,11 @@
 <body>
 
 <p>
-It's recommended to mark every driver as module, so you are able to add the
+It's recommended to mark every driver as module, so that you can to add the
 required module dynamically, especially if you don't know the module name. If
-you know the module name already, select the driver as built-in driver. Compile
-the kernel, install the modules and boot it. Check to see if your kernel has
-successfully detected your card by using <c>dmesg</c>.
+you know the module name already, select the driver as a built-in driver.
+Compile the kernel, install the modules and boot it. Check to see if your kernel
+has successfully detected your card by using <c>dmesg</c>.
 </p>
 
 <pre caption="Checking kernel output">
@@ -164,29 +167,83 @@
 input: TerraTec/qanu USB2.0 Highspeed DVB-T Receiver remote control as /class/input/input2
 </pre>
 
+</body>
+</section>
+</chapter>
+
+<chapter id="inst_vdr">
+<title>Installing VDR</title>
+<section>
+<body>
+
+<p>
+To install VDR, we just emerge it.
+</p>
+
+<pre caption="Installing VDR">
+# <i>emerge vdr</i>
+</pre>
+
 <p>
-Now continue with <uri link="#inst_lirc">installing LIRC</uri> if you want to
-use a remote control.
+Now continue with <uri link="#inst_ir_remote">Installing the Remote Control</uri>.
 </p>
 
 </body>
 </section>
 </chapter>
 
-<chapter id="inst_lirc">
-<title>Configuring the remote control - LIRC</title>
+<chapter id="inst_ir_remote">
+<title>Installing the Remote Control</title>
+<section>
+<body>
+
+<p>
+There are at least two ways to control VDR via an infrared remote control. If
+your TV card has an onboard IR receiver you can use <c>vdr-remote</c>.
+Otherwise, you most likely need to use LIRC.
+</p>
+
+</body>
+</section>
+<section>
+<title>Installing vdr-remote</title>
+<body>
+
+<p>
+We first install the plugin via emerge:
+</p>
+
+<pre caption="Installing vdr-remote">
+# <i>emerge vdr-remote</i>
+# <i>emerge --config vdr-remote</i>
+</pre>
+
+<p>
+When using the remote plugin for the IR port on your DVB card everything should
+be fine with the default config. It automatically uses the input device which
+has "dvb" in its name. For more advanced uses take a look at
+<path>/etc/conf.d/vdr.remote</path>.
+</p>
+
+<p>
+Now, continue with <uri link="#video-out">Video Output Methods</uri>.
+</p>
+
+</body>
+</section>
 <section>
-<title>Installing LIRC</title>
+<title>Alternative: installing LIRC</title>
 <body>
 
 <p>
-If your card can be remotely controlled, you may wish to configure LIRC. LIRC
-interprets the pressed keys and returns a name for each one. A program that
-supports LIRC waits for key events and runs the action configured in the config
-file, mostly stored in the config directory of the executing program (e.g.
-<c>mplayer</c> loads the file <path>~/.mplayer/lircrc</path>). Before we
-install LIRC, you have to add <c>lirc</c> to your USE flags and add an
-additional entry to <path>/etc/make.conf</path>: <c>LIRC_DEVICES</c>. Use <uri
+If your card can be remotely controlled (but you cannot or do not want to use
+<c>vdr-remote</c>), you may wish to configure LIRC. LIRC interprets the pressed
+keys and returns a name for each one. A program that supports LIRC waits for key
+events and runs the action configured in the config file, mostly stored in the
+config directory of the executing program (e.g.  <c>mplayer</c> loads the file
+<path>~/.mplayer/lircrc</path>). Before we install LIRC, you have to add
+<c>lirc</c> to your USE flags and add an additional entry to
+<path>/etc/make.conf</path>: <c>LIRC_DEVICES</c>. Use <uri
 link="http://www.lirc.org/html/table.html">this list</uri> to find the proper
 arguments for the option.
 </p>
@@ -244,6 +301,21 @@
 </pre>
 
 <p>
+Now it should be possible to watch <c>lircd</c> running and decoding key-presses.
+Just run the command <c>irw</c>. Stop it with pressing Ctrl+C when you have
+enough.
+</p>
+
+<pre caption="Testing LIRC">
+# <i>irw</i>
+0000000000001aa2 00 Exit Technisat_TTS35AI.conf
+0000000000001a8d 00 Mute Technisat_TTS35AI.conf
+0000000000000a97 00 OK Technisat_TTS35AI.conf
+0000000000000a97 01 OK Technisat_TTS35AI.conf
+0000000000000a92 00 Menu Technisat_TTS35AI.conf
+</pre>
+
+<p>
 Next, add it to the default runlevel so that it starts automatically at boot.
 </p>
 
@@ -251,74 +323,104 @@
 # <i>rc-update add lircd default</i>
 </pre>
 
+<p>
+To be able to use your remote control, you must enable LIRC support in VDR. Add
+the following line to <path>/etc/conf.d/vdr</path>:
+</p>
+
+<pre caption="Enabling support for LIRC">
+# <i>nano -w /etc/conf.d/vdr</i>
+IR_CTRL="lirc"
+</pre>
+
 </body>
 </section>
 </chapter>
 
-<chapter>
-<title>Setting up VDR</title>
+<chapter id="video-out">
+<title>Video Output Methods</title>
 <section>
-<title>Installing VDR</title>
 <body>
 
 <p>
-To install VDR, we just emerge it.
+You now need to decide on one (and only one!) of the following video output
+devices which show the picture and the overlayed On Screen Display (OSD).
 </p>
 
-<pre caption="Installing VDR">
-# <i>emerge vdr</i>
-</pre>
+</body>
+</section>
+<section id="vdr-dxr3">
+<title>Hardware decoding: full-featured DVB cards</title>
+<body>
 
 <p>
-If you want to be able to use your remote control, we have to enable LIRC
-support in VDR. Add the following line to the <path>/etc/conf.d/vdr</path>:
+Users of these expensive cards need not install anything else, so you may
+continue with <uri link="#channel_list">configuring your channel list</uri>.
 </p>
 
-<pre caption="Enabling support for LIRC">
-# <i>nano -w /etc/conf.d/vdr</i>
-IR_CTRL="lirc"
+</body>
+</section>
+<section id="vdr-dxr3">
+<title>Hardware decoding: DXR3/Hollywood+ cards</title>
+<body>
+
+<p>
+To use a DXR3 card for VDR output we need the <c>vdr-dxr3</c> plugin.
+</p>
+
+<pre caption="Installing the plugin">
+# <i>emerge vdr-dxr3</i>
+# <i>echo em8300 &gt;&gt; /etc/modules.autoload.d/kernel-2.6</i>
 </pre>
 
-<note>
-There's a remote configuration file available at Matthias Schwarzott's <uri
-link="http://dev.gentoo.org/~zzam/remote.conf">devspace</uri>. You will need to
-run <c>chown vdr:vdr</c> on the file to get it working.
-</note>
+<p>
+em8300-modules needs some configuration that depends on the exact used
+revision of the card.
+</p>
 
+<!--
 <p>
-You'll probably want to configure your channels at this point. The VDR project
-provides you with some examples which can be found at
-<path>/usr/share/doc/vdr-analogtv-$version/examples/</path>, as long as you've
-installed &gt;=<c>media-plugins/vdr-analogtv-1.0.00-r1</c>.
+Because we (the authors) don't own a card that uses the dxr3config, we decided
+to skip this part till we have one at our disposal.
 </p>
+-->
 
 <p>
-Next, start VDR and add it to the default runlevel:
+Continue with <uri link="#channel_list">configuring your channel list</uri>.
 </p>
 
-<pre caption="Adding vdr to the default runlevel">
-# <i>/etc/init.d/vdr start</i>
-# <i>rc-update add vdr default</i>
+</body>
+</section>
+<section id="vdr-pvr350">
+<title>Hardware decoding: PVR350 cards</title>
+<body>
+
+<p>
+As PVR350 cards have an onboard MPEG-Decoder chip we want to make use of that.
+We need to install the <c>vdr-pvr350</c> plugin.  If <c>ivtv-driver</c> is not
+yet installed emerge will automatically install it for you. To have the ivtv
+module loaded at boot we add it to
+<path>/etc/modules.autoload.d/kernel-2.6</path>:
+</p>
+
+<pre caption="Installing PVR350-Plugin">
+# <i>emerge vdr-pvr350</i>
+# <i>echo ivtv &gt;&gt; /etc/modules.autoload.d/kernel-2.6</i>
 </pre>
 
 <p>
-Now that the basic installation is over, you need to configure VDR. Switch to
-your output screen and follow the on-screen instructions. VDR asks you to press
-various keys on your remote control to learn the correct key codes. In case you
-don't own a remote control unit, you can use your keyboard. If you only have a
-budget card, you need to install a software output plugin, or <e>softdevice
-plugin</e>. This decodes the stream and offers a device to access.
+Continue with <uri link="#channel_list">configuring your channel list</uri>.
 </p>
 
 </body>
 </section>
-<section id="softdevice">
-<title>Optional: Installing a softdevice plugin</title>
+<section id="vdr-xineliboutput">
+<title>Software decoding: vdr-softdevice</title>
 <body>
 
 <p>
-To install a softdevice, we have to emerge <c>vdr-softdevice</c>. Don't forget
-to configure the plugin.
+To install it, we have to emerge <c>vdr-softdevice</c>. Don't forget
+to enable the plugin.
 </p>
 
 <pre caption="Installing the softdevice plugin">
@@ -331,10 +433,29 @@
 <path>/etc/conf.d/vdr.softdevice</path>.
 </p>
 
+<p>
+For now, we will only describe the shm ("shared memory") method. This is already
+enabled in the installed config file (Setting SOFTDEVICE_VIDEO_OUT). Later you
+need to start <c>ShmClient</c> to get a window showing the picture.
+</p>
+
+<note>
+If you do not want to think about a separate keyboard layout for controlling VDR
+with softdevice/shm there is a remote configuration file available at Matthias
+Schwarzott's <uri
+link="http://dev.gentoo.org/~zzam/remote.softdevice-shm.conf">devspace</uri>.
+You will need to copy it to <path>/etc/vdr/remote.conf</path> and run <c>chown
+vdr:vdr</c> on the file to get it working.
+</note>
+
+<p>
+Continue with <uri link="#channel_list">configuring your channel list</uri>.
+</p>
+
 </body>
 </section>
 <section id="vdr-xineliboutput">
-<title>Optional: Alternate installation of a softdevice plugin</title>
+<title>Software decoding: vdr-xineliboutput</title>
 <body>
 
 <p>
@@ -349,8 +470,8 @@
 </pre>
 
 <p>
-Adding command line options at this point is crucial for your softdevice to
-work. For more options, see <c>vdr --help</c>.
+Adding command line options at this point is crucial for xineliboutput to work.
+For more options, see <c>vdr --help</c>.
 </p>
 
 <pre caption="Adding command line options to /etc/conf.d/vdr.xineliboutput">
@@ -368,37 +489,212 @@
 127.0.0.1             <comment>(always accept localhost)</comment>
 192.168.1.0/24        <comment>(any host on the local net)</comment>
 #204.152.189.113      <comment>(a specific host)</comment>
-#0.0.0.0/0            <comment>(any host on any net (USE THIS WITH CARE!))</comment>
+#0.0.0.0/0            <comment>(any host on any net - USE THIS WITH CARE!)</comment>
 </pre>
 
 <p>
-You must restart VDR for the changes to take effect:
+If you only want to use <c>vdr-xineliboutput</c> to view the picture
+on the same PC running VDR you can now
+<uri link="#channel_list">continue with configuring your channel-list</uri>.
 </p>
 
-<pre caption="Restarting VDR">
-# <i>/etc/init.d/vdr restart</i>
-* Stopping vdr ...                                          [ ok ]
+<p>
+Otherwise, you now simply <c>emerge media-plugins/vdr-xineliboutput</c> on your
+client:
+</p>
+
+<pre caption="Client setup">
+# <i>emerge vdr-xineliboutput</i>
+</pre>
+
+<p>
+Later (after having started VDR) you will use the command <c>vdr-sxfe
+xvdr://hostname</c> to connect to VDR and view its picture and OSD.
+</p>
+
+<p>
+Continue with <uri link="#channel_list">configuring your channel list</uri>.
+</p>
+
+<note>
+There is also a plugin which just simulates the existance of a real
+output device (<c>vdr-dummydevice</c>) for some fancy uses like record-only
+servers, but that is more advanced than a normal VDR setup.
+</note>
+
+</body>
+</section>
+</chapter>
+
+<chapter id="channel_list">
+<title>Creating a Channel List</title>
+<section>
+<body>
+
+<p>
+To make VDR really useful you need to create an appropriate channel list.
+</p>
+
+<p>
+There is more than one way to get a working list of channels (besides
+downloading one). The channel list installed by default is for DVB-S reception
+on Astra on 19.2°E.
+</p>
+
+</body>
+</section>
+<section>
+<title>Using dvbscan from linuxtv-dvb-apps</title>
+<body>
+
+<pre caption="Installing linuxtv-dvb-apps">
+# <i>emerge linuxtv-dvb-apps</i>
+</pre>
+
+<p>
+Find the correct frequency list for your region and type of reception.  These
+files are stored under <path>/usr/share/dvb/scan</path>.  For reception with
+DVB-T in Germany, Region Nuernberg you need to use
+<path>/usr/share/dvb/scan/dvb-t/de-Nuernberg</path>.
+</p>
+
+<pre caption="Scanning with dvbscan">
+$ <i>dvbscan -o vdr /usr/share/dvb/scan/dvb-t/de-Nuernberg &gt; /etc/vdr/channels.conf</i>
+</pre>
+
+</body>
+</section>
+<section>
+<title>Using vdr-reelchannelscan</title>
+<body>
+
+<p>
+First, delete the contents of the existing channel list.
+</p>
+
+<pre caption="Cleaning old channel-list">
+# <i>rm /etc/vdr/channels.conf</i>
+</pre>
+
+<pre caption="Installing and activating vdr-reelchannelscan">
+# <i>emerge vdr-reelchannelscan</i>
+# <i>emerge --config vdr-reelchannelscan</i>
+</pre>
+
+</body>
+</section>
+<section>
+<title>Channels for systems using vdr-analogtv</title>
+<body>
+
+<p>
+You'll probably want to configure your channels at this point. The VDR project
+provides you with some examples which can be found at
+<path>/usr/share/doc/vdr-analogtv-$version/examples/</path>, as long as you've
+installed &gt;=<c>media-plugins/vdr-analogtv-1.0.00-r1</c>.
+</p>
+
+</body>
+</section>
+</chapter>
+
+<chapter>
+<title>Starting VDR</title>
+<section>
+<body>
+
+<p>
+After having all basic software parts ready on the system you need to
+configure VDR with its OSD.
+</p>
+
+<p>
+If you use a hardware decoder for picture output you should switch on the
+connected TV now. If you use software output the client for this must be started
+after VDR.
+</p>
+
+<p>
+First, you should learn your key definitions; that is, connecting keys on your
+remote control to VDR's internal commands.
+</p>
+
+<note>
+Just in case you need to edit the keyboard configuration, or (more likely) want
+to delete it to go back to learning the keys: VDR stores its key-definitions in
+<path>/etc/vdr/remote.conf</path>.
+</note>
+
+<p>
+We begin with starting VDR:
+</p>
+
+<pre caption="Starting VDR">
+# <i>/etc/init.d/vdr start</i>
 * Preparing start of vdr:
 *   config files ...                                        [ ok ]
 *   Waiting for prerequisites (devices nodes etc.) ...      [ ok ]
 * Starting vdr ...                                          [ ok ]
-*   Waiting for working vdr ...                             [ ok ]
+* First start of vdr: No check for running vdr possible
+* until control device (remote/keyboard) keys are learnt!
+</pre>
+
+<note>
+Users of software decoders should now start the client program that opens the
+window to show the TV picture and the OSD.
+</note>
+
+<pre caption="Activating the software decoder for the client">
+<comment>(For users of vdr-softdevice)</comment>
+# <i>ShmClient</i>
+<comment>(For users of vdr-xineliboutput)</comment>
+# <i>vdr-sxfe xvdr://hostname</i>
 </pre>
 
 <p>
-Now, simply <c>emerge media-plugins/vdr-xineliboutput</c> on your client, and
-start it.
+The most useful keys for VDR are:
 </p>
+<ul>
+  <li>Cursor keys (Left/Right/Up/Down)</li>
+  <li>Menu/Exit/Ok</li>
+  <li>Colors (Red/Green/Yellow/Blue)</li>
+  <li>Number keys (0-9)</li>
+</ul>
 
-<pre caption="Client setup">
-# <i>emerge vdr-xineliboutput</i>
-$ <i>vdr-sxfe xvdr://hostname</i>
-</pre>
+<impo>
+If you don't have many keys, make sure to assign these. (Some remotes have
+Play/Pause/etc. on the same keys as the colors, so use them for the colors).
+</impo>
 
 <p>
-Sit back and enjoy your new video streaming capabilities. :)
+Now that the basic installation is over, you need to configure VDR. Switch to
+your output screen and follow the on-screen instructions. VDR asks you to press
+various keys on your remote control to learn the correct key codes. If you don't
+own a remote control, you can use your keyboard.
 </p>
 
+<!--<p>
+TODO: Add a configuration howto for remote controls etc.
+</p>-->
+
+<p>
+Now you can add the VDR initscript to the default runlevel to get it started
+every time your computer boots up.
+</p>
+
+<pre caption="Adding vdr to the default runlevel">
+# <i>rc-update add vdr default</i>
+</pre>
+
+</body>
+</section>
+</chapter>
+
+<chapter>
+<title>Troubleshooting</title>
+<section>
+<body>
+
 <note>
 If you need any help, you can always ask someone in <uri
 link="irc://irc.freenode.org/gentoo-vdr">#gentoo-vdr</uri>, or look around on



-- 
gentoo-doc-cvs@gentoo.org mailing list



             reply	other threads:[~2007-01-03  0:58 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-01-03  0:58 Josh Saddler [this message]
  -- strict thread matches above, loose matches on Subject: below --
2008-06-12 21:21 [gentoo-doc-cvs] cvs commit: vdr-guide.xml Joshua Saddler
2008-03-20 17:31 Shyam Mani
2007-11-13 13:10 Xavier Neys
2007-01-16 19:23 Josh Saddler
2007-01-03 15:04 Josh Saddler
2006-11-16  4:53 Josh Saddler
2006-11-09  9:40 Xavier Neys
2006-09-29 10:40 Josh Saddler

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20070103005839.0228064823@smtp.gentoo.org \
    --to=nightmorph@lark.gentoo.org \
    --cc=docs-team@lists.gentoo.org \
    --cc=gentoo-doc-cvs@lists.gentoo.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox