wmtv/README

   1 =========================================================
   2                                 WMTV - WindowMaker TV
   3                         <wliang@tartarus.uwa.edu.au>
   4 =========================================================
   5
   6 Version                 : 0.6.5
   7 Release Date    : 25th April 1999
   8
   9
  10 Description
  11 ===========
  12 WMTV is a WindowMaker dock.app that controls TV Cards which are supported under the Linux Kernel 2.2.x series (mainly for cards based on BrookTree BT848/848a/849a/878/879 chipsets: There are lots of cards out there which uses these chipsets such as the Hauppauge WinTV, Aimslab VideoExtreme, miroVIDEO PCTV, AverMedia TVPhone, Spirit TV, MagicXPress TView, Teppro TEV,  etc).
  13
  14
  15 Installation
  16 ============
  17 root/setuid root required to run this program.
  18
  19 2) su
  20 2) make install
  21 3) copy wmtvrc.sample to ~/.wmtvrc
  22 4) configure wmtv by editing ~/.wmtvrc or /etc/wmtvrc ( the former takes precedence)
  23
  24 Note: Dock the application before switching the TV On.
  25
  26
  27 Features
  28 ========
  29 WMTV is "Just another gadget(tm)". A miniature sized television screen which sits on your WindowMaker dock. However, it'll become a full featured television application in future major releases.
  30
  31 Currently supported:
  32         - Channel Presets
  33         - TV Modes - PAL/Secam/NTSC
  34         - FineTuning (Television source) - writes to config file now
  35         - Scanning of TV Stations (Television source)
  36         - External TV application support
  37         - All video sources (Television/S-Video/CompositeX) depending on your card
  38         - 8/16/24/32 bit displays
  39         - Modification of config file after WMTV is executed
  40           (Turn Off and Turn On again to reinitialise config file)
  41         - Full Screen display!
  42         - Icon should be of size 64x64
  43
  44 Button map:
  45
  46                 [ < ] [ > ] [ 0 ]
  47
  48              <1>   <2>   <3>
  49
  50 Tips:
  51 There are 3 modes of operation on this applications.
  52 You can cycle through the 3 modes by clicking on the right most button <3> repeatedly.
  53 The 3 modes are described below:
  54
  55         On mode
  56         ---------
  57         Clicking on the rightmost button <3> for the first time (after the start of     WMTV) would turn TV on. During this mode, the left <1> and right <2> buttons    are used to change preset channels which has been defined in your config                file. Left button to move down 1 channel and Right button to move up one
  58         channel.
  59
  60         Tune mode
  61         ---------
  62         Clicking again on button <3> after On mode would bring WMTV into tune mode.     During this mode, the left <1> and right <2> buttons have two purposes
  63         individually. Left clicking on the left <1> or right <2> buttons would
  64         perform scans of channels. Scanning will stop when there is a strong signal     strength. Right clicking on the left <1> or right <2> button would fine
  65         tune the current frequency. After tuning, clicking on button <3> would  set the fine tuned offset into your config file and bring you back into "On mode".
  66
  67         Off mode
  68         --------
  69         Holding down button <3> for about 3 seconds from any of the two modes
  70         described above, would turn the TV off.
  71
  72 Right clicking once on the TV Screen would mute/unmute the audio.
  73
  74 Double clicking LEFT mouse button on the TV Screen would launch your favorite TV application when specified with --exe <filename> option in the command line.
  75 If the external application is not set, It'll automatically switch to the build in full screen mode.
  76 Double clicking the MIDDLE mouse button on the TV Screen would bring you into the built in full screen mode.
  77
  78 To launch an external application:
  79
  80 foo@bar > wmtv --exe /usr/X11R6/bin/xawtv               # example.
  81 or
  82 foo@bar > wmtv -e /usr/X11R6/bin/xawtv
  83
  84 If you do not specify any program to be launched during startup of WMTV,
  85 double clicking on the TV Screen would launch the inbuilt full screen feature.
  86 Make sure you have a 640x480 Modeline defined in your XF86Config file.
  87
  88 Full Screen Mode:
  89         Single click on any mouse button will return to initial screen.
  90
  91         Keyboard functions
  92         ------------------
  93                 Up              -  Switch preset channels up.
  94                 Down    -  Switch preset channels down.
  95                 Right   -  Volume up.
  96                 Left    -  Volume down.
  97                 Escape  -  Return to initial screen.
  98                 m               -  mute/unmute audio.
  99
 100 Configuration file
 101 ==================
 102 This section describes on how to configure WMTV's configuration file.
 103 Your configuration file is located in your home directory as ".wmtvrc".
 104
 105 Excerpt from a sample config file:
 106 /*-----------------------
 107
 108 source = Television
 109 freqnorm = pal-australia
 110 maxpreset = 7
 111 mode = pal
 112 fullscreen = 640x480
 113
 114 [channel]
 115 2
 116 7
 117 9
 118 10
 119 32 (50)
 120 SE11
 121 S21
 122
 123 -------------------------*/
 124
 125 Settings
 126 --------
 127 source = {Television|CompositeX|S-Video} (X is an integer)
 128
 129 freqnorm = {ntsc-bcast|ntsc-cable|ntsc-cable-hrc|ntsc-bcast-jp|ntsc-cable-jp|pal-europe|pal-europe-east|pal-italy|pal-newzealand|pal-australia|pal-ireland}
 130
 131 maxpreset = integer (maximum channel presets)
 132
 133 mode = {pal|ntsc|secam}
 134
 135 fullscreen = {widthxheight}
 136
 137 [channel]
 138 choose a total of <maxpreset> from the below channels.
 139 separate it with a new line as in the sample config file above.
 140 {
 141  E2|E3|E4|
 142  S01|S02|S03|
 143  R1|R2|R3|R4|R5|
 144  SE1|SE2|SE3|SE4|SE5|SE6|SE7|SE8|SE9|SE10|
 145  E5|E6|E7|E8|E9|E10|E11|E12|
 146  R6|R7|R8|R9|R10|R11|R12|
 147  SE11|SE12|SE13|SE14|SE15|SE16|SE17|SE18|SE19|SE20|
 148  S21|S22|S23|S24|S25|S26|S27|S28|S29|S30|S31|S32|S33|S34|S35|S36|S37|S38|S39|S40|S41
 149  T7|T8|T9|T10|T11|T12|T13|T14|
 150  1 - 125
 151 }
 152 finetune parameters could be added spaced after the channel name above in a bracket.
 153 for example:
 154         32 (50)                 # channel 32 plus 50
 155
 156         or
 157
 158         SE11 (-10)              # channel SE11 minus 10
 159
 160
 161 TODO
 162 ====
 163
 164 - Image Capture
 165 - On Screen Display (OSD)
 166 - Other controls
 167 - Advance image clippings
 168 - Video Capture
 169 - Other misc features
 170
 171
 172 BUGS
 173 ====
 174 Ask flik. Bug me if you've found any.
 175
 176
 177 NOTE
 178 ====
 179 Please refer to COPYING for licensing info.
 180 This program might not work on your system and there is no way I will be held
 181 responsible for anything.
 182 This does to your system including loss of data, loss of uptime, loss of hair and etc.
 183
 184 Please report any bugs/comments/feedbacks to <wliang@tartarus.uwa.edu.au>
 185 Please visit http://www.student.uwa.edu.au/~wliang for updates on WMTV.