1
<?xml version="1.0" encoding="UTF-8"?>
2
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY legal SYSTEM "legal.xml">
5
<!ENTITY appversion "2.26">
6
<!ENTITY manrevision "3.0">
7
<!ENTITY date "February 2009">
8
<!ENTITY app "Totem Movie Player">
9
<!-- Information about the entities
10
The legal.xml file contains legal information, there is no need to edit the file.
11
Use the appversion entity to specify the version of the application.
12
Use the manrevision entity to specify the revision number of this manual.
13
Use the date entity to specify the release date of this manual.
14
Use the app entity to specify the name of the application. -->
18
(Do not remove this comment block.)
19
Maintained by the GNOME Documentation Project
20
http://developer.gnome.org/projects/gdp
21
Template version: 2.0 beta
22
Template last modified Apr 11, 2002
25
<!-- =============Document Header ============================= -->
26
<article id="index" lang="en">
27
<!-- please do not change the id; for translations, change lang to -->
28
<!-- appropriate code -->
30
<title><application>&app;</application> Manual</title>
33
<holder>Chee Bin HOH</holder>
37
<holder>Philip Withnall</holder>
39
<releaseinfo revision="2.26" role="final">
40
<ulink type="peerreview" url="http://bugzilla.gnome.org/show_bug.cgi?id=574524"/>
43
<abstract role="description">
44
<para><application>&app;</application> is a media player for GNOME that runs on GStreamer by default, but can
45
also be run on xine. It has support for most audio and video codecs including
46
DVDs among many others. Features include TV-out, fullscreen,
47
subtitles, and more.</para>
51
<publishername> GNOME Documentation Project </publishername>
55
<!-- This file contains link to license for the documentation (GNU FDL), and
56
other legal stuff such as "NO WARRANTY" statement. Please do not change
60
<author role="maintainer">
61
<firstname>Chee Bin</firstname>
62
<surname>HOH</surname>
64
<orgname>GNOME Documentation Project</orgname>
66
<email>cbhoh@gnome.org</email>
69
<firstname>Baptiste</firstname>
70
<surname>Mille-Mathias</surname>
72
<orgname>GNOME Documentation project</orgname>
74
<contrib>Update documentation</contrib>
75
<email>baptiste.millemathias@gmail.org</email>
78
<firstname>Philip</firstname>
79
<surname>Withnall</surname>
80
<contrib>Update documentation</contrib>
81
<email>philip@tecnocode.co.uk</email>
84
<!-- This is appropriate place for other contributors: translators,
85
maintainers, etc. Commented out by default.
86
<othercredit role="translator">
87
<firstname>Latin</firstname>
88
<surname>Translator 1</surname>
90
<orgname>Latin Translation Team</orgname>
91
<address> <email>translator@gnome.org</email> </address>
93
<contrib>Latin translation</contrib>
97
<!-- According to GNU FDL, revision history is mandatory if you are -->
98
<!-- modifying/reusing someone else's document. If not, you can omit it. -->
99
<!-- Remember to remove the &manrevision; entity from the revision entries other -->
100
<!-- than the current revision. -->
101
<!-- The revision numbering system for GNOME manuals is as follows: -->
102
<!-- * the revision number consists of two components -->
103
<!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
104
<!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
105
<!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
106
<!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. -->
107
<!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
108
<!-- to V3.0, and so on. -->
111
<revnumber>&app; Manual V2.0</revnumber>
112
<date>August 2006</date>
114
<para role="author">Chee Bin HOH
115
<email>cbhoh@gnome.org</email>
117
<para role="publisher">GNOME Documentation Project</para>
121
<revnumber>&app; Manual V&manrevision;</revnumber>
124
<para role="author">Philip Withnall
125
<email>philip@tecnocode.co.uk</email>
127
<para role="publisher">GNOME Documentation Project</para>
132
<releaseinfo>This manual describes version &appversion; of &app;.
135
<title>Feedback</title>
136
<para>To report a bug or make a suggestion regarding the <application>&app;</application> application or
137
this manual, follow the directions in the
138
<ulink url="help:user-guide#feedback" type="help">GNOME Feedback Page</ulink>.
143
<indexterm zone="index">
144
<primary>&app;</primary>
146
<indexterm zone="index">
147
<primary>totem</primary>
151
<!-- ============= Document Body ============================= -->
152
<!-- ============= Introduction ============================== -->
153
<!-- Use the Introduction section to give a brief overview of what
154
the application is and what it does. -->
155
<sect1 id="totem-introduction">
156
<title>Introduction</title>
157
<para>The <application>&app;</application> application is a movie player for the GNOME desktop based on
158
the GStreamer framework and xine library, and enables you to play movies or songs.
160
<para><application>&app;</application> provides the following features:</para>
163
<para>Support for a variety of video and audio files.</para>
166
<para>A variety of zoom levels and aspect ratios, and a fullscreen view.</para>
169
<para>Seek and volume controls.</para>
172
<para>A playlist.</para>
175
<para>Subtitle support.</para>
178
<para>Complete keyboard navigation.</para>
181
<para>Comprehensive set of plugins, including a subtitle downloader, YouTube browser, and disc burner.</para>
185
<para><application>&app;</application> also comes with additional functionality such as:
189
<para>Video thumbnailer for GNOME.</para>
192
<para>Audio preview application for GNOME.</para>
195
<para>Nautilus properties tab.</para>
200
<!-- =========== End of Introduction ========================= -->
202
<!-- =========== Getting Started ============================= -->
203
<!-- Use the Getting Started section to describe the steps required
204
to start the application and to describe the user interface components
205
of the application. If there is other information that it is important
206
for readers to know before they start using the application, you should
207
also include this information here.
208
If the information about how to get started is very short, you can
209
include it in the Introduction and omit this section. -->
211
<sect1 id="totem-getting-started">
212
<title>Getting Started</title>
214
<sect2 id="totem-start">
215
<title>To Start <application>&app;</application></title>
216
<para>You can start <application>&app;</application> in the following ways:
220
<term><guimenu>Applications</guimenu> menu</term>
224
<guisubmenu>Sound & Video</guisubmenu>
225
<guimenuitem>Movie Player</guimenuitem>
231
<term>Command line</term>
233
<para>To start <application>&app;</application> from a command line, type the following command,
234
then press <keycap>Return</keycap>:</para>
236
<command>totem</command>
239
<para>To view other command line options that are available,
240
type <command>totem --help</command>, then press <keycap>Return</keycap>.
248
<sect2 id="totem-when-start">
249
<title>When You Start <application>&app;</application></title>
250
<para>When you start <application>&app;</application>, the following window is displayed.</para>
252
<!-- ==== Figure ==== -->
253
<figure id="totem-start-fig">
254
<title><application>&app;</application> Start Up Window</title>
258
<imagedata fileref="figures/totem_start_window.png" format="PNG"/>
261
<phrase>Shows <application>&app;</application> main window with
262
sidebar opened on playlist. Contains
263
menubar, display area, sidebar, elapsed time slider, seek control
264
buttons, volume slider and statusbar.
270
<!-- ==== End of Figure ==== -->
272
<!-- Include any descriptions of the GUI immediately after the screenshot of the main UI, -->
273
<!-- for example, the items on the menubar and on the toolbar. This section is optional. -->
274
<para>The <application>&app;</application> window contains the following elements:
278
<term>Menubar.</term>
280
<para>The menus on the menubar contain all of the commands you need to use in
281
<application>&app;</application>.</para>
285
<term>Display area.</term>
287
<para>The display area displays the movie or a visualization of the current song.
292
<term>Sidebar.</term>
294
<para>The sidebar displays properties of the file played and acts as
295
playlist. It can also be used by various plugins, such as the MythTV, YouTube and Video
296
Search plugins. They can be selected by clicking on the drop-down list at the top of the sidebar.
301
<term>Elapsed time slider.</term>
303
<para>The elapsed time slider displays the elapsed time of the movie or song that is playing.
304
It also enables you to skip forward or backward in a movie or song by dragging the slider's handle along the bar,
305
or by clicking on a point on the bar.
310
<term>Seek control buttons.</term>
312
<para>The seek control buttons enable you to move to the next or previous track, and to pause or play
318
<term>Volume button.</term>
320
<para>The volume button enables you to adjust the volume.</para>
324
<term>Statusbar.</term>
326
<para>The statusbar displays status information about the movie or song that is playing.</para>
332
<!-- =========== End of Getting Started ====================== -->
334
<!-- =========== Usage ======================================= -->
335
<!-- Use this section to describe how to use the application to perform the tasks for
336
which the application is designed. -->
337
<sect1 id="totem-usage">
340
<!-- ================ Usage Subsection ================================ -->
341
<sect2 id="totem-open-file">
342
<title>To Open a File</title>
343
<para>To open a video or an audio file, choose
345
<shortcut><keycombo><keycap>Ctrl</keycap><keycap>O</keycap></keycombo></shortcut>
346
<guimenu>Movie</guimenu>
347
<guisubmenu>Open</guisubmenu>
349
The <application>Select Movies or Playlists</application> dialog is displayed.
350
Select the file or files you want to open, then click
351
<guibutton>OK</guibutton>.
353
<para>You can drag a file from another application such as a file manager to the
354
<application>&app;</application> window. If you drag the file to the display area, the file will replace the current
355
playlist and will start playing immediately. If you drag the file to the playlist in the sidebar, the file will be
356
appended to the current playlist. The <application>&app;</application> application
357
will open the file and play the movie or song. <application>&app;</application>
358
displays the title of the movie or song in the titlebar of
359
the window and in the playlist in the sidebar.
361
<para>If you try to open a file format that <application>&app;</application> does
362
not recognize, the application displays an error message. This error is most often encountered
363
if you do not have the correct codecs installed. Information on getting codecs working can be found on
364
the <ulink url="http://projects.gnome.org/totem/#codecs" type="http"><application>&app;</application> website</ulink>.
367
<para>You can double-click on a video or an audio file in the <application>Nautilus</application>
368
file manager to open it in the <application>&app;</application> window.
373
<sect2 id="totem-usage-open-location">
374
<title>To Open a Location</title>
375
<para>To open a file by URI (location), choose
377
<shortcut><keycombo><keycap>Ctrl</keycap><keycap>L</keycap></keycombo></shortcut>
378
<guimenu>Movie</guimenu>
379
<guimenuitem>Open Location</guimenuitem>
380
</menuchoice>. The <application>Open Location</application> dialog is displayed. Use the drop-down
381
combination box to specify the URI you would like to open (it lists URIs which have
382
previously been opened) – or type one in directly – then click on the <guibutton>Open</guibutton> button.
384
<para>If you have a URI in the clipboard already, it will automatically be pasted into the combination box.</para>
387
<sect2 id="totem-usage-play">
388
<title>To Play a Movie (DVD or VCD)</title>
389
<para>Insert the disc in the optical device of your computer, then choose
390
<menuchoice><guimenu>Movie</guimenu><guimenuitem>Play Disc</guimenuitem>
391
</menuchoice>.</para>
392
<para>To eject a DVD or VCD, choose
394
<shortcut><keycombo><keycap>Ctrl</keycap><keycap>E</keycap></keycombo></shortcut>
395
<guimenu>Movie</guimenu>
396
<guimenuitem>Eject</guimenuitem>
401
<sect2 id="totem-usage-pause">
402
<title>To Pause a Movie or Song</title>
403
<para>To pause a movie or song that is playing, click on the
405
<imageobject><imagedata fileref="figures/totem_pause_button.png" format="PNG"/></imageobject>
406
<textobject><phrase>Shows pause button.</phrase></textobject>
407
</inlinemediaobject> button, or choose
409
<shortcut><keycombo><keycap>Ctrl</keycap><keycap>Space</keycap></keycombo></shortcut>
410
<guimenu>Movie</guimenu>
411
<guimenuitem>Play / Pause</guimenuitem>
412
</menuchoice>. You may also use the <keycap>P</keycap> key to pause or play a movie.
414
<para>To resume playing a movie or song, click on the
416
<imageobject><imagedata fileref="figures/totem_play_button.png" format="PNG"/></imageobject>
417
<textobject><phrase>Shows play button.</phrase></textobject>
418
</inlinemediaobject> button again, or choose
420
<shortcut><keycombo><keycap>Ctrl</keycap><keycap>Space</keycap></keycombo></shortcut>
421
<guimenu>Movie</guimenu>
422
<guimenuitem>Play / Pause</guimenuitem>
427
<sect2 id="totem-usage-view-properties">
428
<title>To View Properties of a Movie or Song</title>
429
<para>To view the properties of a movie or song, choose
431
<guimenu>View</guimenu>
432
<guimenuitem>Sidebar</guimenuitem></menuchoice> to make the sidebar
433
appear, and choose <guimenu>Properties</guimenu> in the drop-down list at the top of the sidebar.</para>
436
<sect2 id="totem-usage-seek">
437
<title>To Seek Through Movies or Songs</title>
438
<para>To seek through movies or songs, you can use the following methods:
442
<term>To skip forward</term>
444
<para>To skip forward through a movie or song, choose
446
<shortcut><keycap>Right</keycap></shortcut>
447
<guimenu>Go</guimenu>
448
<guimenuitem>Skip Forward</guimenuitem>
454
<term>To skip backward</term>
456
<para>To skip backwards through a movie or song, choose
458
<shortcut><keycap>Left</keycap></shortcut>
459
<guimenu>Go</guimenu>
460
<guimenuitem>Skip Backwards</guimenuitem>
466
<term>To skip to a time</term>
468
<para>To skip to a specific elapsed time in the movie or song, choose
470
<shortcut><keycombo><keycap>Ctrl</keycap><keycap>K</keycap></keycombo></shortcut>
471
<guimenu>Go</guimenu>
472
<guimenuitem>Skip to</guimenuitem>
473
</menuchoice>. The <application>Skip to</application> dialog is displayed. Use the
474
spin box to specify the elapsed time (in seconds) to skip to, then
475
click <guibutton>OK</guibutton>.
477
<para>The spin box also allows more natural language to be used. You can enter a time in the
478
formats "hh:mm:ss", "mm:ss" or "ss"; where "hh" is the hour, "mm" is the minute and "ss" is the
484
<term>To move to the next movie or song</term>
486
<para>To move to the next movie or song, choose
488
<shortcut><keycombo><keycap>Alt</keycap><keycap>Right</keycap></keycombo></shortcut>
489
<guimenu>Go</guimenu>
490
<guimenuitem>Next Chapter/Movie</guimenuitem>
491
</menuchoice> or click on the
493
<imageobject><imagedata fileref="figures/totem_next_button.png" format="PNG"/></imageobject>
494
<textobject><phrase>Shows a seek next button</phrase></textobject>
495
</inlinemediaobject> button.
500
<term>To move to the previous movie or song</term>
502
<para>To move to the previous movie or song, choose
504
<shortcut><keycombo><keycap>Alt</keycap><keycap>Left</keycap></keycombo></shortcut>
505
<guimenu>Go</guimenu>
506
<guimenuitem>Previous Chapter/Movie</guimenuitem>
507
</menuchoice> or click on the
509
<imageobject><imagedata fileref="figures/totem_previous_button.png" format="PNG"/></imageobject>
510
<textobject><phrase>Shows a seek previous button</phrase></textobject>
511
</inlinemediaobject> button.
518
<sect2 id="totem-usage-change-zoom">
519
<title>To Change the Zoom Factor</title>
520
<sect3 id="totem-usage-change-size">
521
<title>To Change the Video Size</title>
522
<para>To change the zoom factor of the display area, you can use the
527
<para>To zoom to fullscreen mode, choose
528
<menuchoice><shortcut><keycap>F11</keycap></shortcut>
529
<guimenu>View</guimenu><guimenuitem>Fullscreen</guimenuitem></menuchoice>. You can also
530
use the <keycap>F</keycap> key to toggle fullscreen mode.
531
To exit fullscreen mode, click on the
532
<guibutton>Leave Fullscreen</guibutton> button or press
533
<keycap>Esc</keycap>, <keycap>F11</keycap> or <keycap>F</keycap>.
537
<para>To change the size of the original movie or visualization,
540
<shortcut><keycombo><keycap>Ctrl</keycap><keycap>0</keycap></keycombo></shortcut>
541
<guimenu>View</guimenu><guimenuitem>Fit Window to Movie</guimenuitem>
542
</menuchoice> and choose a scale ratio.
547
<sect3 id="totem-usage-change-ratio">
548
<title>To Change the Video Aspect Ratio</title>
549
<para>To switch between different aspect ratios, choose
551
<shortcut><keycap>A</keycap></shortcut>
552
<guimenu>View</guimenu>
553
<guisubmenu>Aspect Ratio</guisubmenu>
554
</menuchoice>.</para>
558
<sect2 id="totem-usage-adjust-volume">
559
<title>To Adjust the Volume</title>
560
<para>To increase the volume, choose
562
<shortcut><keycap>Up</keycap></shortcut>
563
<guimenu>Sound</guimenu>
564
<guimenuitem>Volume Up</guimenuitem>
566
To decrease the volume, choose
568
<shortcut><keycap>Down</keycap></shortcut>
569
<guimenu>Sound</guimenu>
570
<guimenuitem>Volume Down</guimenuitem>
573
<para>You can also use the volume button: click on the volume button and choose the volume level with the slider.</para>
576
<sect2 id="totem-usage-on-top">
577
<title>To Make the Window Always on Top</title>
578
<para>To make the <application>&app;</application> window always on top of other application windows,
581
<guimenu>Edit</guimenu>
582
<guimenuitem>Plugins</guimenuitem>
583
</menuchoice>. Select the <guilabel>Always on Top</guilabel> plugin to enable it. The <application>&app;</application> window will now stay on
584
top of all other windows while a movie is playing, but not while audio or visualizations are playing.
586
<para>To stop the window from always being on top, disable the <guilabel>Always on Top</guilabel> plugin again.
587
See <xref linkend="totem-plugins-always-on-top"/> for more information.</para>
590
<sect2 id="totem-usage-show-control">
591
<title>To Show or Hide Controls</title>
592
<para>To show or hide the <application>&app;</application> window controls, choose
594
<shortcut><keycombo><keycap>Ctrl</keycap><keycap>H</keycap></keycombo></shortcut>
595
<guimenu>View</guimenu>
596
<guimenuitem>Show Controls</guimenuitem>
597
</menuchoice>, or press the <keycap>H</keycap> key.
598
You can also right-click on the <application>&app;</application> window, then choose
600
<shortcut><keycombo><keycap>Ctrl</keycap><keycap>H</keycap></keycombo></shortcut>
601
<guimenuitem>Show Controls</guimenuitem>
602
</menuchoice> from the popup menu.
604
<para>If the <guilabel>Show Controls</guilabel> option is selected,
605
<application>&app;</application> will show the menubar, elapsed time slider,
606
seek control buttons, volume slider and statusbar on the window. If
607
the <guilabel>Show Controls</guilabel> option is unselected, the application
608
will hide these controls and show only the display area.
612
<sect2 id="totem-usage-playlist">
613
<title>To Manage the Playlist</title>
615
<sect3 id="totem-usage-playlist-show-hide">
616
<title>To Show or Hide the Playlist</title>
617
<para>To show or hide the playlist, choose
619
<guimenu>View</guimenu><guimenuitem>Sidebar</guimenuitem>
620
</menuchoice> or click on the <guibutton>Sidebar</guibutton> button, and
621
choose <guimenu>Playlist</guimenu> on the top of
625
<sect3 id="totem-usage-playlist-manage">
626
<title>Manage a Playlist</title>
627
<para>You can use the <application>Playlist</application> dialog to do the following:
630
<term>To add a track or movie</term>
632
<para>To add a track or movie to the playlist, click on the <guibutton>Add</guibutton>
633
button. The <application>Select Movies or Playlists</application> dialog is displayed. Select the file that you
634
want to add to the playlist, then click <guibutton>Add</guibutton>.
639
<term>To remove a track or movie</term>
641
<para>To remove a track or movie from the playlist, select the item or items to remove from the
642
playlist, then click on the <guibutton>Remove</guibutton> button.
647
<term>To save the playlist to a file</term>
649
<para>To save the playlist to a file, click on the <guibutton>Save Playlist</guibutton>
650
button. The <application>Save Playlist</application> dialog is displayed; specify
651
the filename as which you want to save the playlist, and click <guibutton>Save</guibutton>.
656
<term>To move a track or movie up the playlist</term>
658
<para>To move a track or movie up the playlist, select the item from the
659
playlist, then click on the <guibutton>Move Up</guibutton> button.
664
<term>To move a track or movie down the playlist</term>
666
<para>To move a track or movie down the playlist, select the item from the
667
playlist, then click on the <guibutton>Move Down</guibutton> button.
674
<sect3 id="totem-usage-playlist-repeat">
675
<title>To Select or Unselect Repeat Mode</title>
676
<para>To enable or disable repeat mode, choose
677
<menuchoice><guimenu>Edit</guimenu><guimenuitem>Repeat Mode</guimenuitem></menuchoice>.
680
<sect3 id="totem-usage-playlist-shuffle">
681
<title>To Select or Unselect Shuffle Mode</title>
682
<para>To enable or disable shuffle mode, choose
683
<menuchoice><guimenu>Edit</guimenu><guimenuitem>Shuffle
684
Mode</guimenuitem></menuchoice>.
689
<sect2 id="totem-usage-subtitle">
690
<title>To Choose Subtitles</title>
692
the language of the subtitles, select
693
<menuchoice><guimenu>View</guimenu><guisubmenu>Subtitles</guisubmenu></menuchoice>
694
and choose the subtitle language you want to display.</para>
695
<para>To disable the display of subtitles, select
696
<menuchoice><guimenu>View</guimenu><guisubmenu>Subtitles</guisubmenu><guimenuitem>None</guimenuitem></menuchoice>.</para>
697
<note><para>By default, <application>&app;</application> will choose the same language for the
698
subtitles as the one you normally use on your computer.</para></note>
699
<para><application>&app;</application> will automatically load and display subtitles for a video if it finds a subtitle file with the
700
same name as the video being played, and the extension <filename class="extension">asc</filename>, <filename class="extension">txt</filename>,
701
<filename class="extension">sub</filename>, <filename class="extension">srt</filename>, <filename class="extension">smi</filename>,
702
<filename class="extension">ssa</filename> or <filename class="extension">ass</filename>.
704
<para>If the file containing the subtitles has a different name from the video being played, you can
705
right-click on the video in the playlist and choose <menuchoice><guimenuitem>Select Text Subtitles</guimenuitem></menuchoice>
706
from the popup menu to load the correct subtitle file. You may also choose subtitles by choosing
707
<menuchoice><guimenu>View</guimenu><guimenuitem>Select Text Subtitles</guimenuitem></menuchoice>.</para>
708
<para>Using the <guilabel>Subtitle Downloader</guilabel> plugin, you can also download subtitles from the OpenSubtitles service. See
709
<xref linkend="totem-plugins-opensubtitles"/> for more information.</para>
712
<sect2 id="totem-usage-take-screenshot">
713
<title>To Take a Screenshot</title>
714
<para>To take a screenshot of the movie or visualization that is playing, choose
716
<guimenu>Edit</guimenu>
717
<guimenuitem>Take Screenshot</guimenuitem>
718
</menuchoice>. The <application>Save Screenshot</application> dialog is displayed. Choose a location and
719
insert the filename as which you want to save the screenshot, then click on the <guibutton>Save</guibutton> button
720
to save the screenshot.
722
<tip><para><application>&app;</application> will display a preview of the screenshot which is to be saved on the left-hand side of the <application>Save Screenshot</application> dialog.</para></tip>
725
<sect2 id="totem-usage-create-screenshot-gallery">
726
<title>To Create a Screenshot Gallery</title>
727
<para>To create a gallery of screenshots of the movie or visualization that is playing, choose
729
<guimenu>Edit</guimenu>
730
<guimenuitem>Create Screenshot Gallery</guimenuitem>
731
</menuchoice>. The <application>Save Gallery</application> dialog is displayed. Choose a location and
732
insert the filename as which you want to save the gallery image, then click on the <guibutton>Save</guibutton> button
733
to save the screenshot.
735
<tip><para>You may specify the width of the individual screenshots in the gallery using the <guilabel>Screenshot width</guilabel> entry.
736
The default width is 128 pixels.</para>
737
<para>You may also specify the number of screenshots to be put in the gallery. By default, this is calculated based on the length of the movie;
738
however, this may be overridden by deselecting the <guilabel>Calculate the number of screenshots</guilabel> checkbox and entering the new
739
number in the <guilabel>Number of screenshots</guilabel> spin box.</para></tip>
743
<!-- =========== Plugins ======================================= -->
744
<sect1 id="totem-plugins">
745
<title>Plugins</title>
746
<para><application>&app;</application> has many features which are present in the form of plugins — pieces of the software which are only loaded
748
<sect2 id="totem-plugins-load">
749
<title>To Enable a Plugin</title>
750
<para>To view the list of installed plugins, choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Plugins</guimenuitem></menuchoice>. The
751
<application>Configure Plugins</application> dialog is displayed. On the left is a list of all the plugins you have installed, while on the right is
752
a description of the currently selected plugin. Plugins which have options which can be changed will have a sensitive <guibutton>Configure</guibutton>
753
button on the right.</para>
754
<para>To enable a plugin, simply select the checkbox to the left of its name in the plugin list, and the plugin will be loaded immediately. If
755
there is any error loading the plugin, an error dialog will also be displayed immediately.</para>
756
<para>To disable a plugin again, deselect its checkbox. Plugins will remain enabled or disabled as set even when <application>&app;</application> is
759
<sect2 id="totem-plugins-always-on-top">
760
<title>Always on Top</title>
761
<para>When enabled, the <guilabel>Always on Top</guilabel> plugin will force the main <application>&app;</application> window to be on top of
762
all other windows while a movie is playing, but not while audio or visualizations are playing. To stop the window being on top, disable
763
the plugin again.</para>
765
<sect2 id="totem-plugins-coherence">
766
<title>Coherence DLNA/UPnP Client</title>
767
<para>The <guilabel>Coherence DLNA/UPnP Client</guilabel> plugin allows <application>&app;</application> to play multimedia content from
768
UPnP media servers (such as Coherence servers) on the local network.</para>
769
<para>With the <guilabel>Coherence DLNA/UPnP Client</guilabel> plugin enabled, choose
770
<menuchoice><shortcut><keycap>F9</keycap></shortcut><guimenu>View</guimenu><guimenuitem>Sidebar</guimenuitem></menuchoice> or click on the
771
<guibutton>Sidebar</guibutton> button to show the sidebar. Select <guilabel>Coherence DLNA/UPnP Client</guilabel> from the drop-down list at the
772
top of the sidebar to display the <guilabel>Coherence DLNA/UPnP Client</guilabel> sidebar.</para>
773
<para>The tree view in the sidebar will list the available media servers. Clicking on one will expand it to show the types of media it can serve,
774
and clicking on a media folder will expand it to list the media files available. Double-clicking on a media file will add it to
775
<application>&app;</application>'s playlist and play it. You may alternatively right-click on a file and choose
776
<menuchoice><guimenuitem>Play</guimenuitem></menuchoice> or <menuchoice><guimenuitem>Enqueue</guimenuitem></menuchoice> to play the file
777
immediately or add it to the playlist, respectively.</para>
778
<para>If the media server allows it, choosing <menuchoice><guimenuitem>Delete</guimenuitem></menuchoice> from a file's context menu allows you to
779
delete that file from the media server.</para>
781
<sect2 id="totem-plugins-gromit">
782
<title>Gromit Annotations</title>
783
<para>The <guilabel>Gromit Annotations</guilabel> plugin allows you to draw on top of movies as they are played using
784
<ulink type="http" url="http://www.home.unix-ag.org/simon/gromit/"><application>Gromit</application></ulink>. You must have
785
<application>Gromit</application> installed before you can enable the plugin — consult your operating system documentation for
786
information on how to do this.</para>
787
<para>With the plugin enabled, press <keycombo><keycap>Ctrl</keycap><keycap>D</keycap></keycombo> to toggle <application>Gromit</application>
788
on or off. When <application>Gromit</application> is enabled, your pointer will change to a crosshair. To draw on the screen, hold down your
789
mouse button and drag your pointer around, before releasing your mouse button. Press <keycombo><keycap>Ctrl</keycap><keycap>D</keycap></keycombo>
790
again to toggle <application>Gromit</application> off.</para>
791
<para>To clear the screen of annotations, press <keycombo><keycap>Ctrl</keycap><keycap>E</keycap></keycombo>, or close
792
<application>&app;</application>.</para>
794
<sect2 id="totem-plugins-jamendo">
795
<title>Jamendo</title>
796
<para>The <guilabel>Jamendo</guilabel> plugin allows you to listen to the collection of Creative Commons-licensed music on the
797
<ulink type="http" url="http://www.jamendo.com/en/">Jamendo</ulink> service.</para>
798
<sect3 id="totem-plugins-jamendo-configuration">
799
<title>To Configure the Plugin</title>
800
<para>The <guilabel>Jamendo</guilabel> plugin can be configured. Click on the <guibutton>Configure</guibutton> button when enabling the plugin,
801
and the <application>Jamendo Plugin Configuration</application> dialog will be displayed. Here, you can choose whether to download songs in Ogg or
802
MP3 format (Ogg is preferred due to its open-source nature); and the number of albums to retrieve when doing a search (choose more albums if
803
you have a faster Internet connection).</para>
804
<para>Once you're done, click <guibutton>OK</guibutton>.</para>
806
<sect3 id="totem-plugins-jamendo-setup">
807
<title>To Display the Jamendo Sidebar</title>
808
<para>With the <guilabel>Jamendo</guilabel> plugin enabled, choose
809
<menuchoice><shortcut><keycap>F9</keycap></shortcut><guimenu>View</guimenu><guimenuitem>Sidebar</guimenuitem></menuchoice> or click on the
810
<guibutton>Sidebar</guibutton> button to show the sidebar. Select <guilabel>Jamendo</guilabel> from the drop-down list at the top of the sidebar
811
to display the <guilabel>Jamendo</guilabel> sidebar.</para>
813
<sect3 id="totem-plugins-jamendo-search">
814
<title>To Search for Music</title>
815
<para>Enter your search terms in the search entry at the top of the <guilabel>Jamendo</guilabel> sidebar. You can search by either artist or
816
by tags. Click on the search button to start your search.</para>
817
<para>Search results will be displayed in the tree view in the <guilabel>Search Results</guilabel> page of the sidebar, and can be browsed
818
through using the arrow buttons at the bottom of the sidebar. Albums are listed, and if you click on an album, its tracks will be listed
819
below it. Click again to hide the album's tracks.</para>
820
<para>With an artist selected, you can click on the <guibutton>Jamendo Album Page</guibutton> button to open that album's page on the
821
Jamendo website. Double-clicking an album, or choosing <menuchoice><guimenuitem>Add to Playlist</guimenuitem></menuchoice> from the album's
822
context menu, will replace your playlist with all the tracks on that album and begin streaming the first track from Jamendo's website.
823
Double-clicking an individual track will replace your playlist with just that track.</para>
825
<sect3 id="totem-plugins-jamendo-popular">
826
<title>Popular Albums and Latest Releases</title>
827
<para>Viewing the <guilabel>Popular</guilabel> page in the <guilabel>Jamendo</guilabel> sidebar will load a list of the most popular albums
828
on Jamendo at the moment, which can be played as with search results. Viewing the <guilabel>Latest Releases</guilabel> page will likewise
829
load a list of the latest albums released on Jamendo.</para>
832
<sect2 id="totem-plugins-tracker">
833
<title>Local Search</title>
834
<para>The <guilabel>Local Search</guilabel> plugin allows you to search for playable movies and audio files on your computer from within
835
<application>&app;</application>. With the plugin enabled, choose
836
<menuchoice><shortcut><keycap>F9</keycap></shortcut><guimenu>View</guimenu><guimenuitem>Sidebar</guimenuitem></menuchoice> or click on the
837
<guibutton>Sidebar</guibutton> button to show the sidebar. Select <guilabel>Local Search</guilabel> from the drop-down list at the top of the
838
sidebar to display the <guilabel>Local Search</guilabel> sidebar.</para>
839
<para>To perform a search, enter your search terms in the search entry at the top of the sidebar and click <guibutton>Find</guibutton>. Your
840
search terms may include wildcards such as <literal>*</literal>, which will match any character. For example, the search
841
<userinput>*.mpg</userinput> will find all movies with the <filename class="extension">.mpg</filename> file extension.</para>
842
<para>Search results may be browsed using the <guibutton>Back</guibutton> and <guibutton>Forward</guibutton> buttons at the bottom of the
843
sidebar, and you may jump to a specific results page by entering its number in the spin box.</para>
845
<sect2 id="totem-plugins-publish">
846
<title>Publish Playlist</title>
847
<para>The <guilabel>Publish Playlist</guilabel> plugin allows you to publish playlists on your local network to allow other computers to access
848
and play them.</para>
849
<sect3 id="totem-plugins-publish-configuration">
850
<title>To Configure the Plugin</title>
851
<para>The <guilabel>Publish Playlist</guilabel> plugin can be configured. Click on the <guibutton>Configure</guibutton> button when enabling the
852
plugin, and the configuration dialog will be displayed. Here, you can change the name which will appear for your playlist share. The following
853
strings will be replaced when playlists are published:
856
<term><literal>%a</literal></term>
857
<listitem><para>Replaced with the program's name: <application>&app;</application>.</para></listitem>
860
<term><literal>%h</literal></term>
861
<listitem><para>Replaced with your computer's host name.</para></listitem>
864
<term><literal>%u</literal></term>
865
<listitem><para>Replaced with your username.</para></listitem>
868
<term><literal>%U</literal></term>
869
<listitem><para>Replaced with your real name.</para></listitem>
872
<term><literal>%%</literal></term>
873
<listitem><para>Replaced with a literal percent sign.</para></listitem>
877
<para>You can also select the <guilabel>Use encrypted transport protocol</guilabel> checkbox if you wish to encrypt the shared playlists when
878
they're transmitted over the network.</para>
879
<para>Once you're done, click <guibutton>Close</guibutton>.</para>
881
<sect3 id="totem-plugins-publish-publishing">
882
<title>To Publish Playlists</title>
883
<para>With the plugin enabled, you do not need to explicitly publish playlists; they are automatically made available on the network as
884
a Zeroconf website.</para>
886
<sect3 id="totem-plugins-publish-neighborhood">
887
<title>To Browse your Neighborhood</title>
888
<para>To view the shared playlists of others on your network, select <guilabel>Neighborhood</guilabel> from the drop-down list at the top of the
889
sidebar. If any playlists have been published on the network, they will be listed here. Double-click on a playlist to load and play it on
890
your computer.</para>
893
<sect2 id="totem-plugins-opensubtitles">
894
<title>Subtitle Downloader</title>
895
<para>The <guilabel>Subtitle Downloader</guilabel> plugin allows you to find and download subtitle files from the
896
<ulink type="http" url="http://www.opensubtitles.org/en">OpenSubtitles</ulink> service.</para>
897
<para>Subtitles can only be downloaded for local movies; not audio files, DVDs, DVB streams, VCDs or HTTP streams. To search for subtitles for
898
the currently playing movie, choose <menuchoice><guimenu>View</guimenu><guimenuitem>Download Movie Subtitles</guimenuitem></menuchoice>, which
899
will display the <application>Download Movie Subtitles</application> dialog.</para>
900
<para>Select the language in which you wish to have your subtitles from the drop-down list at the top of the dialog, then click on the
901
<guibutton>Find</guibutton> button to search for subtitles for the current movie. Subtitles are found on the basis of the movie's content,
902
rather than its filename or tags.</para>
903
<para>Search results are listed in the tree view in the middle of the dialog. Currently, subtitles can only be used with a movie by
904
<emphasis>reloading</emphasis> the movie with the subtitles, so after selecting the subtitle file you wish to download, click on the
905
<guibutton>Play with Subtitle</guibutton> button to download the subtitles and reload the movie.</para>
906
<note><para>Downloaded subtitle files are cached (in <filename>~/.cache/totem/subtitles</filename>, by default) so that they do not need to be downloaded
907
again when playing the movie again. When downloading new subtitles for a movie, any previously downloaded subtitles for that movie are deleted.</para></note>
909
<sect2 id="totem-plugins-thumbnail">
910
<title>Thumbnail</title>
911
<para>The <guilabel>Thumbnail</guilabel> plugin sets <application>&app;</application>'s main window icon to a thumbnail of the current movie,
912
and updates the icon when new movies are loaded.</para>
913
<note><para>If a thumbnail doesn't exist for the current movie (or if you're playing an audio file), the main window icon will be reset to the
914
<application>&app;</application> logo.</para></note>
916
<sect2 id="totem-plugins-brasero">
917
<title>Video Disc Recorder</title>
918
<para>The <guilabel>Video Disc Recorder</guilabel> plugin allows you to burn the current playlist to a DVD or VCD using <application>Brasero</application>.</para>
919
<para>To burn the current playlist, choose <menuchoice><guimenu>Movie</guimenu><guimenuitem>Create Video Disc</guimenuitem></menuchoice>.
920
A <application>Brasero</application> dialog will be displayed, giving options for converting the movies to the appropriate format and burning them to disc. For more
921
information, see the <ulink type="help" url="help:brasero/brasero-new-project-video">Brasero documentation</ulink>.</para>
923
<sect2 id="totem-plugins-youtube">
924
<title>YouTube Browser</title>
925
<para>The <guilabel>YouTube Browser</guilabel> plugin allows you to search and browse
926
<ulink type="http" url="http://www.youtube.com/">YouTube</ulink>, and play YouTube videos directly in
927
<application>&app;</application>. With the plugin enabled, choose
928
<menuchoice><shortcut><keycap>F9</keycap></shortcut><guimenu>View</guimenu><guimenuitem>Sidebar</guimenuitem></menuchoice> or click on the
929
<guibutton>Sidebar</guibutton> button to show the sidebar. Select <guilabel>YouTube</guilabel> from the drop-down list at the top of the
930
sidebar to display the <guilabel>YouTube</guilabel> sidebar.</para>
931
<para>To search for a YouTube video, enter your search terms in the entry at the top of the sidebar, then click <guibutton>Find</guibutton>.
932
The search results will be listed in the tree view below. More results will be loaded automatically as you scroll down the list.</para>
933
<para>To play a video, double-click it in the results list, or choose <menuchoice><guimenuitem>Add to Playlist</guimenuitem></menuchoice> from
934
its context menu. When a video is played, a list of related videos will automatically be loaded in the <guilabel>Related Videos</guilabel>
935
page of the <guilabel>YouTube</guilabel> sidebar.</para>
936
<para>YouTube videos can be opened in a web browser by choosing <menuchoice><guimenuitem>Open in Web Browser</guimenuitem></menuchoice> from
937
their context menu. This will open the video in its original location on the YouTube website.</para>
939
<sect2 id="totem-plugins-dbus-service">
940
<title>D-Bus Service</title>
941
<para>The <guilabel>D-Bus Service</guilabel> plugin broadcasts notifications of which track is playing in <application>&app;</application>
942
on the D-Bus session bus. Applications such as <application>Gajim</application> can listen for such notifications and respond accordingly by,
943
for example, updating your instant messaging status message to display the video currently being played in
944
<application>&app;</application>.</para>
948
<!-- =========== Usage ======================================= -->
949
<!-- Use this section to describe how to customize the
951
<sect1 id="totem-prefs">
952
<title>Preferences</title>
953
<para>To modify the preferences of <application>&app;</application>, choose
955
<guimenu>Edit</guimenu>
956
<guimenuitem>Preferences</guimenuitem>
957
</menuchoice>.</para>
959
<sect2 id="totem-prefs-general">
960
<title>General</title>
963
<term>Networking</term>
965
<para>Select network connection speed from the <guilabel>Connection speed</guilabel>
971
<term>Text Subtitles</term>
975
<para><guilabel>Automatically load subtitle files</guilabel>: select this option to automatically load any subtitle
976
files with the same filename as a movie when the movie is loaded.</para>
979
<para><guilabel>Font</guilabel>: select this option to change
980
the font used to display subtitles.</para>
983
<para><guilabel>Encoding</guilabel>: select this option to change the
984
encoding used to display subtitles.</para>
991
<sect2 id="totem-prefs-display">
992
<title>Display</title>
999
<para>Select the resize option if you want <application>&app;</application>
1000
to automatically resize the window to the size of the video when a new video is loaded.
1004
<para>Select the screensaver option if you want to allow the screensaver to activate when
1005
playing audio files. Some monitors with integrated speakers may stop playing music when the screensaver is activated.</para>
1011
<term>Visual Effects</term>
1015
<para><guilabel>Visual</guilabel>: select this option to show visual effects
1016
while an audio file is playing.
1020
<para><guilabel>Type of visualization</guilabel>: select type of visualization from the
1025
<para><guilabel>Visualization size</guilabel>: select visualization size from the
1033
<term>Color balance</term>
1037
<para><guilabel>Brightness</guilabel>: use the slider to specify the level of brightness.</para>
1040
<para><guilabel>Contrast</guilabel>: use the slider to specify the level of contrast.</para>
1043
<para><guilabel>Saturation</guilabel>: use the slider to specify the
1044
level of saturation.</para>
1047
<para><guilabel>Hue</guilabel>: use the slider to specify the level
1051
<tip><para>You may use the <guilabel>Reset to Defaults</guilabel> button to reset the color balance controls to their
1052
default positions.</para></tip>
1057
<sect2 id="totem-prefs-audio">
1058
<title>Audio</title>
1061
<term>Audio Output</term>
1063
<para>Select audio output type from the <guilabel>Audio output type</guilabel>
1072
<!-- ============= Bugs ================================== -->
1073
<!-- This section is optional and is commented out by default.
1074
You can use it to describe known bugs and limitations of the
1075
program if there are any - please be frank and list all
1076
problems you know of.
1078
<sect1 id="mayapp-bugs">
1079
<title>Known Bugs and Limitations</title>
1084
<!-- ============= About ================================== -->
1085
<!-- This section contains info about the program (not docs), such as
1086
author's name(s), web page, license, feedback address. This
1087
section is optional: primary place for this info is "About.." box of
1088
the program. However, if you do wish to include this info in the
1089
manual, this is the place to put it. Alternatively, you can put this information in the title page.-->
1090
<sect1 id="totem-about">
1091
<title>About <application>&app;</application></title>
1092
<para><application>&app;</application> is written by
1093
Bastien Nocera (<email>hadess@hadess.net</email>),
1094
Julien Moutte (<email>julien@moutte.net</email>) for the GStreamer backend,
1095
and Guenter Bartsch (<email>guenter@users.sourceforge.net</email>).
1096
To find more information about <application>&app;</application>, please visit the
1097
<ulink url="http://projects.gnome.org/totem/" type="http"><application>&app;</application>
1101
To report a bug or make a suggestion regarding the <application>&app;</application> application or
1102
this manual, follow the directions in the
1103
<ulink url="help:user-guide#feedback" type="help">GNOME Feedback Page</ulink>.
1105
<para> This program is distributed under the terms of the GNU
1106
General Public license as published by the Free Software
1107
Foundation; either version 2 of the License, or (at your option)
1108
any later version. A copy of this license can be found at this
1109
<ulink url="help:gpl" type="help">link</ulink>, or in the file
1110
COPYING included with the source code of this program. </para>
added
removed
help/C/index.docbook
