wmtv/wmtv.1

   1 .TH WMTV 1 "August 2005"
   2
   3 .SH "NAME"
   4 wmtv \- dockable video4linux TV player for WindowMaker.
   5
   6 .SH "SYNOPSIS"
   7 .B wmtv
   8 .I "[--exe program]"
   9
  10 .SH "DESCRIPTION"
  11 .BR wmtv
  12 is a dockable video4linux TV player. It supports channel presets,
  13 PAL/Secam/NTSC, fine tuning, full screen display, ...
  14
  15 .SH "OPTIONS"
  16 .TP
  17 .B \-c, \-\-device
  18 Specifies the video4linux device to use.
  19
  20 .TP
  21 .B \-d, \-\-display
  22 Specifies the X server to contact.
  23
  24 .TP
  25 .B \-e, \-\-exe
  26 Launch an external TV player when the screen is double clicked. It is
  27 possible to pass some parameters to this external application with %
  28 codes.
  29
  30 .SH "USAGE"
  31 This sections describes how to use the application in docked
  32 state. See below for fullscreen mode usage.
  33
  34 Button map:
  35 .br
  36     [ < ] [ > ] [ 0 ]
  37 .br
  38      <1>   <2>   <3>
  39
  40 There are 3 modes of operation on this applications. You can cycle
  41 through the 3 modes by clicking on the right most button <3>.
  42
  43 The 3 modes are described below:
  44
  45 .in +5
  46 .B "On mode"
  47 .br
  48 Clicking on the rightmost button <3> for the first time (after the
  49 start of WMTV) will turn the TV on. While in this mode, the left <1>
  50 and right <2> buttons change to preset channels which has been defined
  51 in your config file. Use the left button to move down one channel and
  52 the right button to move up one channel.
  53
  54 .B "Tune mode"
  55 .br
  56 Clicking again on button <3> after On mode will change WMTV into tune
  57 mode. Left-clicking on the left <1> or right <2> button performs a
  58 channel scan. Scanning stops when there is a strong signal
  59 strength. Right-clicking on the left <1> or right <2> button fine
  60 tunes the current channel. After tuning, clicking on button <3> saves
  61 the fine tuning to your config file and brings you back into "On
  62 mode".
  63
  64 .B "Off mode"
  65 .br
  66 Holding down button <3> for about 3 seconds from any of the two
  67 modes described above turns the TV off.
  68 .in -5
  69
  70 Right-clicking the TV screen mutes/unmutes the audio.
  71
  72 Double left-clicking the TV screen launches the application specified
  73 with --exe. If --exe was not specified, then the built-in full-screen
  74 mode is used instead. Double middle-clicking will always invoke the
  75 built-in full screen mode.
  76
  77
  78 .SH "FULL SCREEN MODE"
  79 To exit full screen mode, click.
  80
  81 .B Keyboard functions
  82 .br
  83 .in +2
  84 Up     - Change to next preset channel.
  85 .br
  86 Down   - Change to previous preset channel.
  87 .br
  88 Right  - Increase volume. (If supported by the v4l device.)
  89 .br
  90 Left   - Decrease volume. (If supported.)
  91 .br
  92 Escape - Leave full screen mode.
  93 .br
  94 m      - mute/unmute.
  95 .br
  96 .in -2
  97
  98 .SH "EXTERNAL APPLICATION"
  99 It is possible to pass some parameters to the external application
 100 through % codes:
 101 .br
 102 .in +2
 103 .B %%
 104 is replaced by a single %.
 105 .br
 106 .B %n
 107 is replaced by the name of the current channel.
 108 .br
 109 .B %#
 110 is replaced by the number of the current channel.
 111 .br
 112 .B %f
 113 is replaced by the current frequency in MHz.
 114 .br
 115 .in -2
 116 The behavior of other % codes is undefined and subject to change.
 117
 118 Example: wmtv -e 'xawtv "%n"'
 119
 120 .SH "CONFIGURATION FILE"
 121 This section describes the format of WMTV's configuration file. It is
 122 located in your home directory under ".wmtvrc".
 123
 124 Excerpt from a sample config file:
 125 .in +5
 126 .br
 127 /*-----------------------
 128 .sp
 129 source = Television
 130 .br
 131 freqnorm = pal-australia
 132 .br
 133 maxpreset = 7
 134 .br
 135 mode = pal
 136 .br
 137 fullscreen = 640x480
 138 .br
 139
 140 .sp
 141 [channel]
 142 .br
 143 2       NAME
 144 .br
 145 7       FOO
 146 .br
 147 9       BAR
 148 .br
 149 10      FOOBAR
 150 .br
 151 32 (50)
 152 .br
 153 SE11
 154 .br
 155 S21     LAST CHANNEL
 156 .br
 157 -------------------------*/
 158 .br
 159 .in -5
 160
 161 .B Settings
 162 .br
 163 source = { Television | CompositeX | S-Video } (X is an integer)
 164 .br
 165 .sp
 166 freqnorm = { ntsc-bcast | ntsc-cable | ntsc-cable-hrc | ntsc-bcast-jp
 167 | ntsc-cable-jp | pal-europe | pal-europe-east | pal-italy |
 168 pal-newzealand | pal-australia | pal-ireland | secam-france }
 169
 170 maxpreset = integer (maximum channel presets)
 171
 172 mode = { pal | ntsc | secam }
 173
 174 fullscreen = widthxheight
 175
 176 [channel]
 177 .br
 178 Choose a total of <maxpreset> from the below channels.
 179 .br
 180 Separate the channels with a new line as in the sample config file above.
 181 .br
 182 {
 183 .in +2
 184 .br
 185 E2 | E3 | E4 |
 186 .br
 187 S01 | S02 | S03 |
 188 .br
 189 R1 | R2 | R3 | R4 | R5 |
 190 .br
 191 SE1 | SE2 | SE3 | SE4 | SE5 | SE6 | SE7 | SE8 | SE9 | SE10 |
 192 .br
 193 E5 | E6 | E7 | E8 | E9 | E10 | E11 | E12 |
 194 .br
 195 R6 | R7 | R8 | R9 | R10 | R11 | R12 |
 196 .br
 197 SE11 | SE12 | SE13 | SE14 | SE15 | SE16 | SE17 | SE18 | SE19 | SE20 |
 198 .br
 199 S21 | S22 | S23 | S24 | S25 | S26 | S27 | S28 | S29 | S30 | S31 | S32
 200 | S33 | S34 | S35 | S36 | S37 | S38 | S39 | S40 | S41 |
 201 .br
 202 T7 | T8 | T9 | T10 | T11 | T12 | T13 | T14 |
 203 .br
 204 K01 | K02 | K03 | K04 | K05 | K06 | K07 | K08 | K09 | K10 |
 205 .br
 206 KB | KC | KD | KE | KF | KG | KH | KI | KJ | KK | KL | KM | KN | KO |
 207 KP | KQ |
 208 .br
 209 H01 | H02 | H03 | H04 | H05 | H06 | H07 | H08 | H09 | H10 | H11 | H12
 210 | H13 | H14 | H15 | H16 | H17 | H18 | H19 |
 211 .br
 212 1 - 125
 213 .br
 214 .in -2
 215 }
 216 .br
 217 Finetune parameters could be added in brackets, spaced after the
 218 channel.
 219 .br
 220 A name for the channel can also be specified, tabbed after the
 221 finetune.
 222 .br
 223 .sp
 224 for example:
 225   32 (50)                 # channel 32 plus 50
 226   or
 227   SE11    LAST CHANNEL    # channel SE11 called "LAST CHANNEL"
 228
 229 .SH "FILES"
 230 .TP
 231 .I /etc/wmtvrc
 232 System wide config file.
 233 .TP
 234 .I ~/.wmtvrc
 235 Users config file.
 236
 237 .SH AUTHOR
 238 This manual page was first written by Remi Lefebvre <remi@debian.org>,
 239 and then modified by Nicolas Boullis <nboullis@debian.org>,
 240 for the Debian GNU/Linux system (but may be used by others).
 241
 242 This manual page was written for the Debian GNU/Linux distribution
 243 because the original program does not have a manual page. It is widely
 244 based on the README provided with the program.