wmtv/README

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