source: gnome/add/totem.xml@ 2d37d32

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY totem-download-http "&gnome-download-http;/totem/3.4/totem-&totem-version;.tar.xz">
  <!ENTITY totem-download-ftp  "&gnome-download-ftp;/totem/3.4/totem-&totem-version;.tar.xz">
  <!ENTITY totem-md5sum        "2d91a16448db39e5e094395a2e143329">
  <!ENTITY totem-size          "3.1 MB">
  <!ENTITY totem-buildsize     "70 MB">
  <!ENTITY totem-time          "2.0 SBU">
]>

<sect1 id="totem" xreflabel="Totem-&totem-version;">
  <?dbhtml filename="totem.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Totem-&totem-version;</title>

  <indexterm zone="totem">
    <primary sortas="a-Totem">Totem</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Totem</title>

    <para>
      <application>Totem</application> package contains the official
      movie player of the <application>GNOME</application> Desktop based on
      <application>GStreamer</application>. It features a playlist, a full-screen
      mode, seek and volume controls, as well as keyboard navigation. This is
      useful for playing any <application>GStreamer</application> supported file,
      DVD, VCD or digital CD.
    </para>

    &lfs70_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&totem-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&totem-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &totem-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &totem-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &totem-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &totem-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Totem Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="clutter-gst"/>,
      <xref linkend="clutter-gtk"/>,
      <xref linkend="gnome-doc-utils"/>,
      <xref linkend="gnome-icon-theme"/>,
      <xref linkend="gst-plugins-good"/>,
      <xref linkend="iso-codes"/>,
      <xref linkend="libpeas"/>,
      <xref linkend="mx"/>,
      <xref linkend="shared-mime-info"/> and
      <xref linkend="totem-pl-parser"/>
    </para>

    <para>
      Ensure you built <application>GStreamer Good Plugins</application>
      with <application>GConf</application> support or the
      <command>configure</command> script will fail.
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>,
      <xref linkend="nautilus"/>,
      <xref linkend="pygobject3"/>,
      <xref linkend="rarian"/> and
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="http://live.gnome.org/Grilo/">Grilo</ulink>,
      <xref linkend="gtk-doc"/>,
      <ulink url="http://live.gnome.org/libepc/">libepc</ulink>,
      <ulink url="http://www.lirc.org">LIRC</ulink>,
      <ulink url="http://pypi.python.org/pypi/pylint">pylint</ulink> and
      <xref linkend="xulrunner"/>
    </para>

    <para>
      Note: <xref linkend="libdvdcss"/> is a run-time requirement if you
      wish to play encrypted DVDs
    </para>

    <para condition="html" role="usernotes">User Notes:
      <ulink url="&blfs-wiki;/totem"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of Totem</title>

    <para>
      Install <application>Totem</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr \
            --libexecdir=/usr/lib/totem \
            --disable-static &amp;&amp;
make</userinput></screen>

    <para>
      If you have installed the dependencies for the testsuite,
      issue: <command>make check</command>.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>--libexecdir=/usr/lib/totem</parameter>: This
      parameter is used so that the plugin viewer is installed in
      the preferred location of <filename
      class="directory">/usr/lib/totem</filename> instead of 
      <filename class="directory">/usr/libexec</filename>.
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/without-scrollkeeper.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/gtk-doc-rebuild.xml"/>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Totem</title>

    <sect3><title>Configuration Information</title>

      <para>
        You may find that <application>totem</application> crashes. If so,
        you can set the following in your environment, either in ~/.xinitrc or in
        your .Xsession: <command>export CLUTTER_DISABLE_ARGB_VISUAL=1</command>
      </para>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          totem, totem-audio-preview and totem-video-thumbnailer
        </seg>
        <seg>
          libtotem.so
        </seg>
        <seg>
          /usr/include/totem,
          /usr/lib/totem,
          /usr/share/gnome/help/totem,
          /usr/share/gtk-doc/html/totem,
          /usr/share/omf/totem and
          /usr/share/totem
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="totem-prog">
        <term><command>totem</command></term>
        <listitem>
          <para>
            is a <application>GNOME</application> Desktop movie player based
            on <application>GStreamer</application>.
          </para>
          <indexterm zone="totem totem-prog">
            <primary sortas="b-totem">totem</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="totem-video-thumbnailer">
        <term><command>totem-video-thumbnailer</command></term>
        <listitem>
          <para>
            is a video thumbnailer for the <application>GNOME</application>
            Desktop used internally by <application>GNOME</application>
            applications such as <application>Nautilus</application> to
            generate PNG thumbnails of video files. While it is possible to
            invoke it manually, it is usually done automatically by
            <application>Nautilus</application>.
          </para>
          <indexterm zone="totem totem-video-thumbnailer">
            <primary sortas="b-totem-video-thumbnailer">totem-video-thumbnailer</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libtotem">
        <term><filename class='libraryfile'>libtotem.so</filename></term>
        <listitem>
          <para>
            contains the <application>Totem</application> API functions.
          </para>
          <indexterm zone="totem libtotem">
            <primary sortas="c-libtotem">libtotem.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>