source: xfce/core/tumbler.xml@ f88633e

<?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 tumbler-download-http
    "http://archive.xfce.org/src/xfce/tumbler/0.1/tumbler-&tumbler-version;.tar.bz2">
  <!ENTITY tumbler-download-ftp  " ">
  <!ENTITY tumbler-md5sum        "d4edc15c172714c7a3eaf3c719b8faf6">
  <!ENTITY tumbler-size          "468 KB">
  <!ENTITY tumbler-buildsize     "12.5 MB">
  <!ENTITY tumbler-time          "0.2 SBU">
]>

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

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

  <title>tumbler-&tumbler-version;</title>

  <indexterm zone="tumbler">
    <primary sortas="a-tumbler">tumbler</primary>
  </indexterm>

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

    <para>
      The <application>Tumbler</application> package contains a
      <application>D-Bus</application> thumbnailing service based on the
      thumbnail management <application>D-Bus</application> specification.
      This is useful for generating thumbnail images of files.
    </para>

    &lfs72_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="dbus-glib"/> and
      <xref linkend="intltool"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="http://code.google.com/p/ffmpegthumbnailer/">FFmpeg-Thumbnailer</ulink>,
      <xref linkend="freetype2"/>,
      <xref linkend="gdk-pixbuf"/>,
      <xref linkend="gtk-doc"/>,
      <xref linkend="libjpeg"/>,
      <xref linkend="libpng"/>,
      <xref linkend="poppler"/>,.
    </para>

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

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

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

<screen><userinput>./configure --prefix=/usr --disable-static &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>

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

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

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

      <seglistitem>
        <seg>
          libtumbler-1.so, and in
          <filename class="directory">/usr/lib/tumbler-1/plugins</filename>
          (depending on the dependencies you've installed):
          tumbler-ffmpeg-thumbnailer.so,
          tumbler-font-thumbnailer.so,
          tumbler-jpeg-thumbnailer.so,
          tumbler-pixbuf-thumbnailer.so and
          tumbler-poppler-thumbnailer.so.
        </seg>
        <seg>
          /usr/include/tumbler-1,
          /usr/lib/tumbler-1 and
          /usr/share/gtk-doc/html/tumbler.
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libtumbler-1">
        <term><filename class="libraryfile">libtumbler-1.so</filename></term>
        <listitem>
          <para>
            contains functions that the <application>Tumbler</application>
            daemon uses to create thumbnail images.
          </para>
          <indexterm zone="tumbler libtumbler-1">
            <primary sortas="c-libtumbler-1">libtumbler-1.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tumbler-ffmpeg-thumbnailer">
        <term><filename class="libraryfile">tumbler-ffmpeg-thumbnailer.so</filename></term>
        <listitem>
          <para>
            is the <application>Tumbler</application>
            <application>FFmpeg</application> plugin for creating thumbnails
            of video files.
          </para>
          <indexterm zone="tumbler tumbler-ffmpeg-thumbnailer">
            <primary sortas="c-tumbler-ffmpeg-thumbnailer">tumbler-ffmpeg-thumbnailer.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tumbler-font-thumbnailer">
        <term><filename class="libraryfile">tumbler-font-thumbnailer.so</filename></term>
        <listitem>
          <para>
            is the <application>Tumbler</application> font thumbnailer.
          </para>
          <indexterm zone="tumbler tumbler-font-thumbnailer">
            <primary sortas="c-tumbler-font-thumbnailer">tumbler-font-thumbnailer.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tumbler-jpeg-thumbnailer">
        <term><filename class="libraryfile">tumbler-jpeg-thumbnailer.so</filename></term>
        <listitem>
          <para>
            is the <application>Tumbler</application> jpeg thumbnailer for
            creating thumbnails of jpeg images.
          </para>
          <indexterm zone="tumbler tumbler-jpeg-thumbnailer">
            <primary sortas="c-tumbler-jpeg-thumbnailer">tumbler-jpeg-thumbnailer.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tumbler-pixbuf-thumbnailer">
        <term><filename class="libraryfile">tumbler-pixbuf-thumbnailer.so</filename></term>
        <listitem>
          <para>
            is the <application>Tumbler</application>
            <application>Gdk Pixbuf</application> thumbnailer.
          </para>
          <indexterm zone="tumbler tumbler-pixbuf-thumbnailer">
            <primary sortas="c-tumbler-pixbuf-thumbnailer">tumbler-pixbuf-thumbnailer.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tumbler-poppler-thumbnailer">
        <term><filename class="libraryfile">tumbler-poppler-thumbnailer.so</filename></term>
        <listitem>
          <para>
            is the <application>Tumbler</application> PDF thumbnailer.
          </para>
          <indexterm zone="tumbler tumbler-poppler-thumbnailer">
            <primary sortas="c-tumbler-poppler-thumbnailer">tumbler-poppler-thumbnailer.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>