source: kde/kf5-apps/kdepimlibs.xml@ b2e07d20

<?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;
]>

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

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

  <title>Kdepimlibs-&kdepimlibs5-version;</title>

  <indexterm zone="kdepimlibs5">
    <primary sortas="a-Kdepimlibs">Kdepimlibs</primary>
  </indexterm>

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

    <para>
      The <application>Kdepimlibs</application> package contains a set of
      common libraries shared among the KDE PIM applications.
    </para>

    &lfs77_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="akonadi5"/>,
      <xref linkend="boost"/>,
      <xref linkend="cyrus-sasl"/>,
      <xref linkend="gpgme"/>,
      <xref linkend="kf5"/>, and
      <xref linkend="libical"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="openldap"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="http://quickgit.kde.org/?p=prison.git">Prison (Qt5 version)</ulink>
    </para>

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

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

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

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

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DLIB_INSTALL_DIR=lib              \
      -DQT_PLUGIN_INSTALL_DIR=&qt5-plugins-dir; \
      -DECM_MKSPECS_INSTALL_DIR=&qt5-mkspecs-dir; \
      -Wno-dev .. &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/cmake-release.xml"/>

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

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

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

  </sect2>

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

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

      <seglistitem>
        <seg>
          akonadi2xml, akonadi_benchmarker, akonadiselftest and akonaditest
        </seg>
        <seg>
          libKF5AkonadiAgentBase.so, libKF5AkonadiCalendar.so,
          libKF5AkonadiContact.so, libKF5AkonadiCore.so, libKF5AkonadiMime.so,
          libKF5AkonadiNotes.so, libKF5AkonadiSocialUtils.so,
          libKF5AkonadiWidgets.so, libKF5AkonadiXml.so, libKF5AlarmCalendar.so,
          libKF5Blog.so, libKF5CalendarCore.so, libKF5CalendarUtils.so,
          libKF5Contacts.so, libKF5Gpgmepp-pthread.so, libKF5Gpgmepp.so,
          libKF5Holidays.so, libKF5IdentityManagement.so, libKF5Imap.so,
          libKF5KontactInterface.so, libKF5Ldap.so, libKF5MailTransport.so,
          libKF5Mbox.so, libKF5Mime.so, libKF5PimTextEdit.so, libKF5PimUtils.so,
          libKF5QGpgme.so, libKF5Syndication.so, libKF5Tnef.so,
          libKF5XmlRpcClient.so and libkimaptest.a
        </seg>
        <seg>
          $KF5_PREFIX/include/KF5/Akonadi/{Calendar,Contact,SocialUtils,KMime,Notes},
          $KF5_PREFIX/include/KF5/akonadi/{calendar,contact,kmime,notes,socialutils},
          $KF5_PREFIX/include/KF5/{AkonadiAgentBase,AkonadiCore,AkonadiWidgets,AkonadiXml,gpgme++},
          $KF5_PREFIX/include/KF5/{KAlarmCal,KBlog,KCalCore,KCalUtils,KContacts,KHolidays},
          $KF5_PREFIX/include/KF5/{KIdentityManagement,KImap,kimaptest,KLDAP,KMbox,KMime},
          $KF5_PREFIX/include/KF5/{KontactInterface,KPIMTextEdit,KPIMUtils,KTNEF,KXmlRpcClient},
          $KF5_PREFIX/include/KF5/{MailTransport,qgpgme,Syndication},
          $KF5_PREFIX/lib/cmake/{KF5Akonadi,KF5AkonadiCalendar,KF5AkonadiContact,KF5AkonadiMime},
          $KF5_PREFIX/lib/cmake/{KF5AkonadiNotes,KF5AkonadiSocialUtils,KF5AlarmCalendar,KF5Blog},
          $KF5_PREFIX/lib/cmake/{KF5CalendarCore,KF5CalendarUtils,KF5Contacts,KF5Gpgmepp,KF5Holidays},
          $KF5_PREFIX/lib/cmake/{KF5IdentityManagement,KF5Imap,KF5KontactInterface,KF5Ldap},
          $KF5_PREFIX/lib/cmake/{KF5MailTransport,KF5Mbox,KF5Mime,KF5PimTextEdit,KF5PimUtils},
          $KF5_PREFIX/lib/cmake/{KF5QGpgme,KF5Syndication,KF5Tnef,KF5XmlRpcClient},
          $KF5_PREFIX/lib/gpgmepp,
          $KF5_PREFIX/&qt5-plugins-dir;/{akonadi,designer},
          $KF5_PREFIX/share/akonadi/agents,
          $KF5_PREFIX/share/doc/HTML/*/kioslave5/{imap,ldap,mbox,nntp,pop3,sieve,smtp},
          $KF5_PREFIX/share/kf5/akonadi/contact,
          $KF5_PREFIX/share/kf5/akonadi/plugins/serializer,
          $KF5_PREFIX/share/kf5/{akonadi_knut_resource,kcontacts,libkholidays} and
          $KF5_PREFIX/share/kservices5/akonadi/contact
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>