teletxt/README

   1 This is a "plugin" for the Video Disk Recorder (VDR).
   2
   3 Written by:                  Marcel Wiesweg <marcel.wiesweg@gmx.de>
   4
   5 Project's homepage:          http://www.wiesweg-online.de/linux/vdr
   6
   7 Latest version available at: http://www.wiesweg-online.de/linux/vdr
   8
   9 See the file COPYING for license information.
  10
  11 Description:
  12
  13 Osd-Teletext displays the teletext directly on the OSD.
  14 Both sound and video are played in the background.
  15
  16
  17 Keys:
  18      1,...,9: insert page number
  19      Up:      page+
  20      Down:    page-
  21      Right:   sub page+
  22      Left:    sub page-
  23      Back:    close teletext plugin
  24
  25    All other user interaction ("Actions") is configurably assigned to the other
  26    available keys.
  27    You can e.g. configure that you jump to page 100 when you press Red.
  28    In this example, the Action "Jump to 100" is assigned to key "Red".
  29    Have a look at the plugin's setup page to learn the current assignment
  30    and adapt it to your needs.
  31
  32    Available Keys: Blue, Red, Yellow, Green, Play, Stop, FastFwd, FastRwd
  33    Actions: "Zoom", "Half page", "Switch channel", "Switch background",
  34             "Jump to..." a specific page.
  35
  36    Description of the actions:
  37      Zoom:          Zoom to upper half/lower half/back to full page
  38      Half Page:     Reduce OSD window to the lower half of the screen and display upper half/lower half/back to full size
  39      Switch channel:Show pages of a channel different from the one currently tuned to.
  40                     This does _not_ include any tuning or channel switching with vdr's core.
  41                     You must have tuned to the channel chosen some time before so that the pages have been stored on disk.
  42                     When you press the key associated with that action, you are asked for the channel number.
  43                     Press OK after you entered it with the number keys.
  44      Jump to...:    Jumps to the page you configure.
  45      Switch background: Changes the in the setup configurable background color immediately
  46                         to black and back to your degree of transparency.
  47
  48    How to configure the key bindings:
  49    In the plugins setup menu, you can assign one of actions to each key.
  50    You can choose freely which actions you need, you are not forced to assign
  51    an action to a key at all if you do not need it.
  52    If you select "Jump to...", specify the page number in the line immediately below.
  53
  54
  55 Other Setup options:
  56    Background transparency:
  57                number between 0 (transparent) and 255 (black). Default is 127 (also used by VDR)
  58    Show Clock: Toggles whether an additional clock is drawn approximately every second.
  59                The clock shows the current system time, not any time broadcast via teletext.
  60                Let VDR set the system time from a transponder to have the exact time.
  61    Auto-update pages:
  62                Continuously checks whether a page has changed and updates it if yes.
  63    OSD width, OSD height:
  64                Adjusts the width and height of the OSD independent from VDR's settings.
  65                The valid range is 40 to 56 for the width and 12 to 21 for the height.
  66    Minimum user inactivity:
  67                Sets a timeout (in minutes) for user inactivity. When this timespan has elapsed
  68                and the user did not press any keys, the plugin will be closed. Set to 0 to disable this.
  69                Note that disabling timeout will also effectively disable VDR's auto-shutdown feature
  70                as long as the plugin is active.
  71    Key bindings:      See above.
  72
  73 Command line options:
  74    A few settings are given on the command line rather than in the setup menu.
  75    Available options:
  76
  77      -d        --directory=DIR    The directory where the temporary
  78                                   files will be stored.
  79                                   (standard value: /vtx, recommended: /tmp/vtx
  80                                    or /var/cache/vdr/osdteletext.)
  81                                   Ensure that the directory exists and is writable.
  82      -n        --max-cache=NUM    Maximum size in megabytes of cache used
  83                                   to store the pages on the harddisk.
  84                                   (standard value: a calculated value below 50 MB)
  85      -s        --cache-system=SYS Set the cache system to be used.
  86                                   Choose "legacy" for the traditional
  87                                   one-file-per-page system.
  88                                   Default is "packed" for the
  89                                   one-file-for-a-few-pages system.
  90
  91 Colors:
  92   On all sorts of output devices which are not limited as to color depth
  93   the original teletext colors will be displayed. (Only difference: Cyan is used instead of
  94   white to make reading easier).
  95   On the classic full-featured DVB card and other limited devices, the colors will be reduced to four.
  96   The mapping is currently optimized for German ARD, ZDF and RTL. If you are for some reason
  97   really and definitely not satisfied with my choices, edit colormapping.h and recompile.
  98