source: gnome/add/totem.xml@ 8cf3617

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

  <!ENTITY totem-download-http "&gnome-download-http;/totem/1.2/totem-&totem-version;.tar.bz2">
  <!ENTITY totem-download-ftp  "&gnome-download-ftp;/totem/1.2/totem-&totem-version;.tar.bz2">
  <!ENTITY totem-md5sum        "7915469973500dba01d51edfd9e49cf3">
  <!ENTITY totem-size          "1.4 MB">
  <!ENTITY totem-buildsize     "27.6 MB">
  <!ENTITY totem-time          "0.6 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">totem-&totem-version;.tar</keyword>
      <keyword role="ftpdir">totem</keyword>
    </keywordset>
  </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>The <application>Totem</application> package contains the official
    movie player of the GNOME desktop environment based on
    <application>xine-lib</application> or
    <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>xine-lib</application> or
    <application>GStreamer</application> supported file, DVD, VCD or
    digital CD.</para>

    <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="gnome-icon-theme"/>,
    <xref linkend="gnome-desktop"/>,
    <xref linkend="iso-codes"/>,
    <xref linkend="libmusicbrainz"/>, and
    <xref linkend="xine-lib"/> (default back-end) or
    <xref linkend="gst-plugins"/> (and <ulink
    url="http://gstreamer.freedesktop.org/modules/gst-ffmpeg.html">
    GStreamer FFmpeg plug-in</ulink>)</para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="nautilus"/>,
    <xref linkend="seamonkey"/> or <xref linkend="firefox"/>
    (to build the browser plug-in, requires <xref linkend="dbus"/> also),
    <ulink url="http://www.evation.com/libirman/libirman.html">libirman</ulink>,
    <ulink url="http://www.lirc.org">LIRC</ulink>,
    <ulink url="http://www.home.unix-ag.org/simon/gromit/">Gromit</ulink>
    (required for the telestrator mode), and
    <ulink url="http://sourceforge.net/projects/nv-tv-out/">NvTv Simple</ulink></para>

    <para>Note: <xref linkend="libdvdcss"/> is a run-time requirement if you
    wish to play encrypted DVDs</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=`pkg-config --variable=prefix ORBit-2.0` \
            --libexecdir=`pkg-config \
            --variable=prefix ORBit-2.0`/lib/totem \
            --localstatedir=/var/lib \
            --sysconfdir=&gnome-etc-dir; &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</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=`pkg-config 
    --variable=prefix ORBit-2.0`/lib/totem</parameter>: This parameter is
    used so that the movie player plugin for browsers is installed in
    <filename class='directory'>$GNOME_PREFIX/lib/totem</filename> instead
    of <filename class='directory'>$GNOME_PREFIX/libexec</filename>.</para>

    <para><parameter>--localstatedir=/var/lib</parameter>: This switch
    puts <application>ScrollKeeper</application> files in
    <filename class="directory">/var/lib/scrollkeeper</filename> instead of
    <filename class="directory">$GNOME_PREFIX/var/scrollkeeper</filename>.</para>

    <para><parameter>--sysconfdir=&gnome-etc-dir;</parameter>: This switch puts
    configuration files in <filename class="directory">&gnome-etc-dir;</filename>
    instead of <filename class="directory">$GNOME_PREFIX/etc</filename>.</para>

    <para><option>--enable-vanity</option>: Using this parameter will build the
    webcam utility (still in development).</para>

  </sect2>

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

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

      <para>There are no configuration files that need to be directly edited.
      Configuration is accomplished by setting the desired values in the
      various menu options accessed via the <command>totem</command> graphical
      interface.</para>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>totem, totem-video-thumbnailer and optionally, vanity</seg>
        <seg>libtotem-plparser.[so,a], a <application>Nautilus</application>
        extension plugin and optionally, a <application>Mozilla</application>
        video plugin</seg>
        <seg>&gnome-etc-dir;/gconf/gconf.xml.defaults/[[,schemas/]apps/totem,
        [,schemas/]desktop/gnome/[thumbnailers, url-handlers]/[too many to list]]
        and the following subdirectories of $GNOME_PREFIX/:
        include/totem,
        lib/totem,
        share/[,gnome/help/ ,omf/]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 GNOME-desktop movie player.</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 GNOME desktop used internally by
          GNOME 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>
    </variablelist>

  </sect2>

</sect1>