1
<?xml version="1.0" encoding="UTF-8"?>
2
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" >
5
<title>Me TV User Manual</title>
9
<holder>Michael Lamothe</holder>
12
<publishername>Michael Lamothe</publishername>
15
<title>Legal Notice</title>
16
<para>This file is part of <application>Me TV</application>. </para>
17
<para><application>Me TV</application> is free software: you can redistribute it and/or
18
modify it under the terms of the GNU General Public License as published by the Free
19
Software Foundation, either version 3 of the License, or (at your option) any later
21
<para><application>Me TV</application> is distributed in the hope that it will be
22
useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
23
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
24
License for more details. </para>
25
<para>You should have received a copy of the GNU General Public License along with
26
<application>Me TV</application>. If not, see <ulink
27
url="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</ulink>.</para>
30
<firstname>Michael</firstname>
31
<surname>Lamothe</surname>
35
<title>Introduction</title>
36
<para><application>Me TV</application> is a digital television (DVB) viewer for GNOME.
37
<application>Me TV</application> was developed for the modern digital lounge room
38
with a PC for a media centre that is capable of normal PC tasks (web surfing, word
39
processing and watching TV). It is not designed to be a full-blown media centre, such as
40
<application>MythTV</application>, but will integrate well with an existing GNOME
44
<title>Why <application>Me TV</application>?</title>
45
<para>The name <application>Me TV</application> comes from Australian slang for "My TV".
46
Hence, "it's TV for me computer" is Australian slang for "it's TV for my computer". The
47
pattern can be followed for all instances of "My", such as "Me dog", "Me ute" and of
48
course "Me beer".</para>
51
<title>Features</title>
52
<para> The following list contains the significant features of <application>Me
53
TV</application>: <itemizedlist>
55
<para>GTK/GNOME interface</para>
58
<para>Completely mouse driven</para>
61
<para>Runs in system tray (see <link linkend="notification_icon">Notification
65
<para>Current and future program information (see <link linkend="epg_window">EPG
69
<para>Instant Record</para>
72
<para>Once off, daily or weekly scheduled recordings (see <link
73
linkend="scheduled_recording">Scheduled Recordings</link>)</para>
77
<link linkend="program_search">Program search</link>
81
<para>Auto channel scan (see <link linkend="channel_scan_window">Channel Scan
85
<para>Auto PID selection</para>
89
<link linkend="audio_select">Audio select</link>
94
<link linkend="network_broadcast">Network broadcast</link>
98
<para>Subtitles</para>
102
<link linkend="dual_language">Dual language</link>
106
<para>DVB-T, DVB-C, DVB-S and ATSC support</para>
109
<para>Double-click fullscreen</para>
113
<link linkend="auto_surf">Auto surf</link>
118
<link linkend="keyboard_shortcuts">Keyboard shortcuts</link>
122
<para>Very simple installation and set up</para>
127
<sect1 id="channel_scan_window">
128
<title>Channel Scan Window</title>
129
<para>To use <application>Me TV</application> you need to have a channels file that lists
130
the channels that you want Me TV to use. <application>Me TV</application> has a built-in
131
scanner that allows you to automatically tune the stations available to you.</para>
132
<para>When <application>Me TV</application> starts it will detect if you have a channels
133
file (<filename>~/.me-tv/channels.conf</filename>). If a channel file does not exist
134
then <application>Me TV</application> will ask if you would like to have one created. If
135
you choose to create a channels file then <application>Me TV</application> will open the
136
Channel Scan window asking you to select a region. If there is no region in the list
137
that matches your region then you might have some luck with a region that is close to
138
you. Double click a region (or select the region and click the
139
<guibutton>Next</guibutton> button) to tell <application>Me TV</application> to begin
140
the scan. During the scan, <application>Me TV</application> will show its progress in
141
the text window, this process can take several minutes. When the scan completes the
142
Channel Scan window will close automatically and <application>Me TV</application> will
144
<para>Digital television (DVB) allows television networks to supply many channels with the
145
same (or similar) content so it's unlikely that you want Me TV to display all of them.
146
To remove channels from <application>Me TV</application>, edit the
147
<filename>~/.me-tv/channels.conf</filename> file and remove the channels that you
148
don't want. If you would like <application>Me TV</application> to rescan channels then
149
simply delete the <filename>~/.me-tv/channels.conf</filename> file and restart
150
<application>Me TV</application>.</para>
152
<sect1 id="main_window">
153
<title>Main Window</title>
154
<para><application>Me TV</application>'s main window contains the main menu, the controls to
155
drive <application>Me TV</application> (toolbar), video window, the EPG window, the
156
program search bar and the status bar.</para>
157
<sect2 id="main_menu">
158
<title>Main Menu</title>
159
<para>Many of the features of <application>Me TV</application> can be accessed through
160
the main menu.</para>
166
<para><guimenuitem>Quit</guimenuitem> exits <application>Me
167
TV</application>. If you are recording or you have a scheduled
168
recording then <application>Me TV</application> will confirm that
169
you want to exit. If you exit <application>Me TV</application> then
170
it will not be able to record a scheduled program. </para>
180
<para><guimenuitem>Fullscreen</guimenuitem> toggles fullscreen
184
<para><guimenuitem>Preferences</guimenuitem> shows the <link
185
linkend="preferences_window">Preferences window</link>. </para>
188
<para><guimenuitem>Electronic Program Guide</guimenuitem> toggles the
189
display of the <link linkend="epg_window">EPG window</link>.</para>
192
<para><guimenuitem>Program Search</guimenuitem> enables the <link
193
linkend="program_search_bar">Program search bar</link> below the
194
<link linkend="epg_window">EPG window</link> allowing the user
195
to search for programs in the EPG.</para>
198
<para><guimenuitem>Subtitles</guimenuitem> displays a list of detected
199
subtitle streams for the channel.</para>
209
<para><guimenuitem>Streams</guimenuitem> displays a list of detected
210
audio streams for the channel.</para>
213
<para><guimenuitem>Mute</guimenuitem> toggles the audio. This will not
214
affect the audio in a recording or broadcast stream. </para>
217
<para><guimenuitem>Dual Language</guimenuitem> the sub menu of this item
218
allows the user to select only the left or right audio channel to
219
come out both speakers. This is useful for people whose television
220
networks send the streams in two languages, one down the left and
221
the other down the right. (see <link linkend="dual_language">Dual
222
language</link>)</para>
231
<para><guimenuitem>Contents</guimenuitem> displays this user guide. </para>
234
<para><guimenuitem>About</guimenuitem> shows the <link
235
linkend="about_window">About window</link>.</para>
241
<title>Toolbar</title>
244
<para><guibutton>Record</guibutton> toggles recording.</para>
247
<para><guibutton>Mute</guibutton> toggles audio output. This will not affect the
248
audio in a recording or broadcast stream.</para>
251
<para><guibutton>Broadcast</guibutton> toggles <link linkend="network_broadcast"
252
>Network broadcast</link>.</para>
255
<para><guibutton>Auto Surf</guibutton> toggles <link linkend="auto_surf">Auto
259
<para><guibutton>Schedule</guibutton> opens the <link
260
linkend="scheduled_recordings_window">Scheduled recordings
261
window</link>.</para>
264
<para><guibutton>Hide Controls</guibutton> hides all controls on the <link
265
linkend="main_window"/> giving the <link linkend="video_window">Video
266
window</link> the maximum amount screen real estate available in the
267
Main window. Simply right click the Video Window to leave this mode.</para>
271
<sect2 id="video_window">
272
<title>Video Window</title>
273
<para>You can double click on video window to toggle fullscreen mode. Upon entering
274
fullscreen mode, all controls will be hidden. Right click on the video window to
275
toggle the display of the controls in <application>Me TV</application>.</para>
277
<sect2 id="epg_window">
278
<title>EPG Window</title>
279
<para>The EPG (Electronic Program Guide) displays current and future program information
280
sent from the television network. The EPG window is also used to change channels. It
281
can be quickly accessed by right clicking on the video window.</para>
282
<para>Click on a program to see the <link linkend="program_details_window">Program
283
details window</link> for that program or to schedule a recording for that
286
<sect2 id="program_search_bar">
287
<title>Program Search Bar</title>
288
<para>The search bar is used to search for programs in the EPG. By default, the bar is
289
not visible, use <keycombo>
290
<keysym>Ctrl+F</keysym>
291
</keycombo> to activate the program search bar.</para>
292
<para>For more information see the <link linkend="program_search">Program search</link>
295
<sect2 id="status_bar">
296
<title>Status Bar</title>
297
<para>The status bar is used to let you know the status of Me TV. When viewing a channel
298
it will display the channel name and current program title, if known. When
299
recording, the status bar will display the filename of the file being recorded
303
<sect1 id="notification_icon">
304
<title>The Notification Icon</title>
305
<para>The <application>Me TV</application> notification icon is displayed in any
306
notification area applet in the GNOME panel while <application>Me TV</application> is
307
running. Left clicking on the icon will cause <application>Me TV</application> to mute
308
and hide but it remains running. Recordings and scheduled recordings will continue to
309
record when <application>Me TV</application> is in this state.</para>
311
<sect1 id="program_details_window">
312
<title>Program Details Window</title>
313
<para>This window is displayed when a user clicks on a program in the <link
314
linkend="epg_window">EPG window</link>. It displays a few details about the program
315
and gives the user the option of scheduling the program for recording via the
316
<guibutton>Record</guibutton> button. Clicking the <guibutton>Record</guibutton>
317
button will open the <link linkend="scheduled_recording_window">Scheduled recording
318
window</link>.</para>
320
<sect1 id="scheduled_recordings_window">
321
<title>Scheduled Recordings Window</title>
322
<para>The scheduled recordings window can be used to add and remove scheduled recordings
323
from <application>Me TV</application>. Click the <guibutton>Add</guibutton> button to
324
add an scheduled recording or select a scheduled recording from the list and click the
325
<guibutton>Remove</guibutton> button.</para>
326
<para>When a program is scheduled, <application>Me TV</application> will run in the system
327
tray and wait for the program to start.</para>
329
<sect1 id="scheduled_recording_window">
330
<title>Scheduled Recording Window</title>
331
<para>Not to be confused with the Scheduled Recording<emphasis>s</emphasis> window, this
332
window allows you to set the values for a scheduled recording.<itemizedlist>
334
<para><guilabel>Title</guilabel> is the title of the program, if available.
338
<para><guilabel>Description</guilabel> is the description of the program, if
342
<para><guilabel>Start Time</guilabel> is the time that the program is scheduled
346
<para><guilabel>Duration</guilabel> is the duration of the program. </para>
348
</itemizedlist></para>
349
<para>Clicking the <guibutton>OK</guibutton> button will open the <link
350
linkend="scheduled_recordings_window">Scheduled recordings window</link> with the
351
newly scheduled recording in the list of scheduled recordings.</para>
352
<para>When a program is scheduled, <application>Me TV</application> will run in the system
353
tray and wait for the program to start.</para>
355
<sect1 id="preferences_window">
356
<title>Preferences Window</title>
357
<para>The Preferences window can be used to configure <application>Me TV</application>.<itemizedlist>
359
<para><guilabel>Recording directory</guilabel> is the directory where
360
<application>Me TV</application> will save its recorded files.</para>
363
<para><guilabel>Record extra before</guilabel> is the default number of minutes
364
that will be added to the start of the recording.</para>
367
<para><guilabel>Record extra after</guilabel> is the default number of minutes
368
that will be added to the end of the recording.</para>
371
<para><guilabel>Recording type</guilabel> is used to specify the video format of
372
<application>Me TV</application>'s recorded files. The MPEG TS format is
373
best for storing multiple audio streams and subtitles. When using MPEG PS
374
<application>Me TV</application> will not be able to record subtitles
375
however you might find that this format is supported by more players.</para>
378
<para><guilabel>EPG span hours</guilabel> is the number of hours that the <link
379
linkend="epg_window">EPG window</link> will span on one page.</para>
382
<para><guilabel>Broadcast port</guilabel> is the network port used when
383
broadcasting over the network.</para>
386
<para><guilabel>EPG encoding</guilabel> is used to specify how to process text
387
elements from the DVB stream. The DVB stream will, in most cases, tell
388
<application>Me TV</application> which encoding it is using however some
389
countries, like the Czech Republic, use a different encoding for the EPG
390
information. If you are having difficulties displaying non-English
391
characters then changing this setting may help.</para>
394
<para><guilabel>Video driver</guilabel> specifies the xine video output driver
395
to use. Sometimes the xine engine is unable to display video output properly
396
because of the users video setup. Changing this setting may help with this
400
<para><guilabel>Deinterlace type</guilabel> is used to specify type of
401
deinterlacing. You may find that changing this setting improves the video
402
depending on your setup.</para>
405
<para><guilabel>Start minimised in tray</guilabel> tells <application>Me
406
TV</application> to startup in the notification area when it starts. This
407
setting can be useful if you get <application>Me TV</application> to start
408
automatically when you log in.</para>
411
<para><guilabel>Always on top</guilabel> tells <application>Me TV</application>
412
to stay on top of other windows on the desktop.</para>
415
<para><guilabel>Fullscreen workaround</guilabel> addresses an issue on some
416
<application>Compiz</application> setups that won't let you show a popup
417
window on top of another window that is in fullscreen mode. This setting
418
will temporarily take you out of fullscreen while viewing a popup window and
419
then return you to fullscreen mode after closing the popup window.</para>
422
<para><guilabel>PID workaround</guilabel> has been implemented because there has
423
been a report of the PID auto-detection not selecting the right PID. This is
424
a temporary workaround in-case the issue arises again on someone's computer
425
after release. This feature may be removed in the next release of
426
<application>Me TV</application> (currently 0.5.10).</para>
428
</itemizedlist></para>
430
<sect1 id="about_window">
431
<title>About Window</title>
432
<para>The About window shows legal information, contributors and further information about
433
<application>Me TV</application>.</para>
435
<sect1 id="features">
436
<title>Features Explained</title>
437
<para>This is a brief explanation of some of the features of <application>Me
438
TV</application>.</para>
439
<sect2 id="keyboard_shortcuts">
440
<title>Keyboard Shortcuts</title>
441
<para>Many of the features of <application>Me TV</application> can be accessed using the
442
keyboard. The following list of keys (uppercase or lowercase) can be used on the
443
<link linkend="main_window">Main window</link>.<itemizedlist>
445
<para><keysym>A</keysym> toggles <link linkend="auto_surf">Auto
449
<para><keysym>B</keysym> toggles <link linkend="network_broadcast">Network
450
broadcast</link></para>
453
<para><keysym>E</keysym> toggles the visibility of the <link
454
linkend="epg_window">EPG window</link></para>
457
<para><keysym>F</keysym> toggles fullscreen</para>
460
<para><keysym>Ctrl+F</keysym> shows the <link linkend="program_search_bar"
461
>Program search bar</link> under the <link linkend="epg_window">EPG
465
<para><keysym>H</keysym> hides all the controls</para>
468
<para><keysym>M</keysym> toggles mute</para>
471
<para><keysym>R</keysym> toggles recording</para>
473
</itemizedlist></para>
475
<sect2 id="scheduled_recording">
476
<title>Scheduled Recording</title>
477
<para><application>Me TV</application> is able to schedule future programs to be
478
recorded. When a program is due to be recorded, <application>Me TV</application>
479
will change to the channel and start recording. If a future program is scheduled
480
then when you close the Main Window, <application>Me TV</application> will continue
481
to run in the notification area of the GNOME panel.</para>
482
<para> There are several types of scheduled recordings:<itemizedlist>
484
<para>Once Off</para>
487
<para>Every Day (not including weekends)</para>
490
<para>Every Day (including weekends)</para>
493
<para>Every Week</para>
495
</itemizedlist></para>
496
<para>If a "Once Off" recording is scheduled then once the recording is complete,
497
<application>Me TV</application> will delete the scheduled recording program.
500
<sect2 id="program_search">
501
<title>Program Search</title>
502
<para><application>Me TV</application> allows you to search the EPG for programs. You
503
can do this using the <link linkend="program_search_bar">Program search bar</link>.</para>
504
<para>The Program search bar is displayed below the <link linkend="epg_window">EPG
505
window</link> but, by default it is hidden. You can activate the Program search
507
<keysym>Ctrl+F</keysym>
509
<para>You only need to enter part of the program title to search. For example, if you
510
enter "Thomas", Me TV will search the entire EPG for any program with "Thomas" in
511
the title. If a program is found it will be displayed in the EPG highlighted in
514
<sect2 id="audio_select">
515
<title>Audio Select</title>
516
<para>Some stations transmit television in multiple audio languages. <application>Me
517
TV</application> allows you to select different audio languages from the
518
<guimenuitem>Audio/Streams</guimenuitem> menu item. <application>Me
519
TV</application> will remember (until you log out) which audio stream you selected
520
the next time you select the channel.</para>
522
<sect2 id="auto_surf">
523
<title>Auto Surf</title>
524
<para>Auto surf tells <application>Me TV</application> to traverse through every channel
525
in the <link linkend="epg_window">EPG window</link>. This gives <application>Me
526
TV</application> the chance to update EPG information for all channels. This feature
527
can be useful because some stations only supply EPG programs a few shows in advance
528
so if you haven't used that channel in a few hours then there will be no EPG
529
information for that channel.</para>
531
<sect2 id="dual_language">
532
<title>Dual Language</title>
533
<para>Some television networks transmit television programs in multiple languages by
534
sending different languages down the left and right channels of the audio stream.
535
Dual language allows you to play either the left or right audio channel through both
536
speakers. Dual language is available through the <guimenuitem>Audio/Dual
537
Language</guimenuitem> menu item.</para>
539
<sect2 id="network_broadcast">
540
<title>Network Broadcast</title>
541
<para>The network broadcast feature allows users to broadcast their television stream
542
over a network making it possible for other computers to receive television. Digital
543
television uses a lot of data so this feature is not recommended for networks that
544
are slower than 100 Mbit/s. There are many players that can be used for a client including:<itemizedlist>
547
<application>xine</application>
548
<command>xine udp://224.0.1.2:2005</command>
553
<application>mplayer</application>
554
<command>mplayer udp://224.0.1.2:2005</command>
559
<application>VLC</application>
560
<command>vlc udp://@224.0.1.2:2005</command>
567
<sect1 id="feedback">
568
<title>Feedback</title>
569
<para>If you have comments about this manual or Me TV then please email me at
570
<email>michael.lamothe@gmail.com</email>. Bugs and new features are welcome at the
571
<ulink url="https://launchpad.net/me-tv">project website</ulink>.</para>