source: kde/core/akonadi.xml@ 9ca304a

<?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 akonadi-download-http "&kde-download-http;akonadi/src/akonadi-&akonadi-version;.tar.bz2">
  <!ENTITY akonadi-download-ftp  "&kde-download-ftp;akonadi/src/akonadi-&akonadi-version;.tar.bz2">
  <!ENTITY akonadi-md5sum        "51ef4c9455f97ce4346c5934174b9da8">
  <!ENTITY akonadi-size          "216 KB">
  <!ENTITY akonadi-buildsize     "50 MB">
  <!ENTITY akonadi-time          "1.9 SBU">
]>

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

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

  <title>Akonadi-&akonadi-version;</title>

  <indexterm zone="akonadi">
    <primary sortas="a-Akonadi">Akonadi</primary>
  </indexterm>

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

    <para><application>Akonadi</application> is an extensible cross-desktop
    storage service for PIM data and metadata providing concurrent read, write,
    and query access. It provides unique desktop-wide object identification and
    retrieval.</para>

    &lfs72_checked;

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

<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/akonadi-&akonadi-version;-fixes-1.patch"/></para>
      </listitem>
    </itemizedlist>
-->
    <bridgehead renderas="sect3">Akonadi Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
    <xref linkend="automoc4"/>,
    <xref linkend="shared-mime-info"/>,
    <xref linkend="boost"/>,
    <xref linkend="soprano"/>, and one of:
    <xref linkend="sqlite"/>,
    <xref linkend="mysql"/>, or
    <xref linkend="postgresql"/>
    </para>

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

  </sect2>

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

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

<screen><userinput>mkdir build &amp;&amp;
cd build &amp;&amp;
cmake -DCMAKE_INSTALL_PREFIX=&kde-dir; \
      -DCMAKE_PREFIX_PATH=&qt-dir; \
      -DCMAKE_BUILD_TYPE=Release \
      -DINSTALL_QSQLITE_IN_QT_PREFIX=TRUE \
      .. &amp;&amp;
make</userinput></screen>

    <para>To test the results,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="commands">
    <title>Command Explanations</title>

    <para><option>-DCMAKE_PREFIX_PATH=&qt-dir;</option>: This switch is used to
    help <command>cmake</command> find <command>automoc4</command>.</para>

    <para><option>-DCMAKE_BUILD_TYPE=Release</option>: This switch is used to apply
    a higher level of compiler optimizations.</para>

    <para><option>-DINSTALL_QSQLITE_IN_QT_PREFIX=TRUE</option>: This switch ensures
    that <application>Akonadi</application> SQLite extension is installed into
    the <application>Qt</application> plugins directory.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>akonadi_agent_launcher, akonadi_agent_server, akonadi_control,
        akonadi_rds, akonadictl and akonadiserver</seg>
        <seg>libakonadiprotocolinternals.so and libqsqlite3.so</seg>
        <seg>&kde-dir;/include/akonadi, &kde-dir;/lib/cmake/Akonadi and
        &kde-dir;/share/config/akonadi</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>