source: kde/core/kfilemetadata.xml@ 2bb2521

<?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 kfilemetadata-download-http "&kde-download-http;&kde-version;/src/kfilemetadata-&kde-version;.tar.xz">
  <!ENTITY kfilemetadata-download-ftp  " ">
  <!ENTITY kfilemetadata-md5sum        "b79265780adad3b5ce97153d07c3a5c3">
  <!ENTITY kfilemetadata-size          "35 KB">
  <!ENTITY kfilemetadata-buildsize     "4.8 MB">
  <!ENTITY kfilemetadata-time          "0.2 SBU">
]>

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

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

  <title>Kfilemetadata-&kde-version;</title>

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

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

    <para>Kfilemetadata is a framework for searching and managing metadata.</para>

    &lfs75_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
    <xref linkend="kdelibs"/>
    </para>
    
    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
    <xref linkend="taglib"/>,
    <xref linkend="poppler"/>,
    <xref linkend="exiv2"/>,
    <xref linkend="ffmpeg"/>,
    <ulink url="http://sourceforge.net/projects/ebook-tools">libepub</ulink> and
    <ulink url="https://projects.kde.org/projects/kde/kdegraphics/kdegraphics-mobipocket">Mobipocket</ulink>
    </para>

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

  </sect2>

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

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

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=&kde-dir; \
      -DCMAKE_BUILD_TYPE=Release         \
      -Wno-dev .. &amp;&amp;
make</userinput></screen>

    <para>
      To run the test suite, issue: <command>make test</command>.
    </para>

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

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

  </sect2>

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

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

      <seglistitem>
        <seg>
          none
        </seg>
        <seg>
          libkfilemetadata.so and several in &kde-dir;/lib/kde4
        </seg>
        <seg>
          &kde-dir;/include/kfilemetadata and &kde-dir;/lib/cmake/KFileMetaData
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>