source: kde/add/kdepim.xml@ df46eec

<?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 kdepim-download-http "&trinity-repo-http;/kdepim-&kde-version;.tar.gz">
  <!ENTITY kdepim-download-ftp  "&trinity-repo-ftp;/kdepim-&kde-version;.tar.gz">
  <!ENTITY kdepim-md5sum        "4488062d5400bdd99642fe0b72ebcf9a">
  <!ENTITY kdepim-size          "12.8 MB">
  <!ENTITY kdepim-buildsize     "347 MB">
  <!ENTITY kdepim-time          "6.4 SBU">
]>

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

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

  <title>Kdepim-&trinity-version;</title>

  <indexterm zone="kdepim">
    <primary sortas="a-kdepim">Kdepim</primary>
  </indexterm>

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

    <para><application>Kdepim</application> provides several
    <application>KDE</application> programs for managing personal information.
    Programs include a contact manager, calendar, mail utilities, newsreader,
    X.509 certificate manager, and sticky notes.</para>

    &lfs70_checked;

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

    <!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/kdepim-&kde-version;-charset-1.patch"/></para>
      </listitem>
    </itemizedlist>
    -->

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="kdebase"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="libjpeg"/>,
      <xref linkend="libxml2"/>,
      <xref linkend="gnupg2"/>, and
      <xref linkend="openssl"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="kdeaccessibility"/>,
      <xref linkend="kdemultimedia"/>,
      <xref linkend="cyrus-sasl"/>,
      <xref linkend="pilot-link"/>,
      <xref linkend="gnupg"/> or 
      <xref linkend="gpgme"/>,
      <ulink url="http://www.opensync.org">OpenSync</ulink>,
      <ulink url="http://jasonday.home.att.net/code/libmal/libmal.html">libmal</ulink>,
      <ulink url="http://www.gnokii.org/">gnokii</ulink>,
      <ulink url="http://www.bluez.org">BlueZ</ulink>,
      <ulink url="http://www.boost.org">Boost</ulink>,
      <xref linkend="graphviz"/>, and
      <xref linkend="doxygen"/>
    </para>

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

  </sect2>

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

    <para>Install <application>kdepim</application> with:</para>

<screen><userinput>KDEPIM=`pwd`         &amp;&amp;
rm -rf   $MAKEDIR    &amp;&amp;
mkdir -p $MAKEDIR    &amp;&amp;
cd       $MAKEDIR    &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=$TRINITY_PREFIX \
      -DCMAKE_VERBOSE_MAKEFILE=ON            \
      -DWITH_ARTS=ON                         \
      -DBUILD_ALL=ON                         \
      -DBUILD_INDEXLIB=OFF                   \
      $KDEPIM        &amp;&amp;

unset KDEPIM MAKEDIR &amp;&amp;
make</userinput></screen>

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

    <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><option>-DBUILD_INDEXLIB=OFF</option>: This option requires
    <ulink url="http://www.boost.org">Boost</ulink>.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>akregator, kaddressbook, kalarm, kandy, karm,
        kitchensync, kleopatra, kmail, knode, knotes, konsolekalendar,
        kontact, korganizer, korn, kpilot,
        ktnef, kwatchgnupg, and supporting programs</seg>
        <seg>Numerous kdepim specific libraries</seg>
        <seg>Numerous subdirectories in $KDE_PREFIX/{include,share}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="akregator">
        <term><command>akregator</command></term>
        <listitem>
          <para>is a program to read <acronym>RSS</acronym> and
          other online news feeds.</para>
          <indexterm zone="kdepim akregator">
            <primary sortas="b-akregator">akregator</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kaddressbook">
        <term><command>kaddressbook</command></term>
        <listitem>
          <para>is the <application>KDE</application> address book.</para>
          <indexterm zone="kdepim kaddressbook">
            <primary sortas="b-kaddressbook">kaddressbook</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kalarm">
        <term><command>kalarm</command></term>
        <listitem>
          <para>is a system to provide reminder messages.</para>
          <indexterm zone="kdepim kalarm">
            <primary sortas="b-kalarm">kalarm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kandy">
        <term><command>kandy</command></term>
        <listitem>
          <para>is a program to synchronize mobile phone numbers.</para>
          <indexterm zone="kdepim kandy">
            <primary sortas="b-kandy">kandy</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="karm">
        <term><command>karm</command></term>
        <listitem>
          <para> is a personal time tracker.</para>
          <indexterm zone="kdepim karm">
            <primary sortas="b-karm">karm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kitchensync">
        <term><command>kitchensync</command></term>
        <listitem>
          <para>is the universal syncing tool and framework for kde.</para>
          <indexterm zone="kdepim kitchensync">
            <primary sortas="b-kitchensync">kitchensync</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kleopatra">
        <term><command>kleopatra</command></term>
        <listitem>
          <para>is a tool for managing X.509 certificates in
          a <application>GpgSM</application> keybox and for retrieving
          certificates from <acronym>LDAP</acronym> servers.</para>
          <indexterm zone="kdepim kleopatra">
            <primary sortas="b-kleopatra">kleopatra</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kmail">
        <term><command>kmail</command></term>
        <listitem>
          <para>is <application>KDE</application>'s email client.</para>
          <indexterm zone="kdepim kmail">
            <primary sortas="b-kmail">kmail</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="knode">
        <term><command>knode</command></term>
        <listitem>
          <para> is the <application>KDE</application> newsreader.</para>
          <indexterm zone="kdepim knode">
            <primary sortas="b-knode">knode</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="knotes">
        <term><command>knotes</command></term>
        <listitem>
          <para> is a popup notes utility.</para>
          <indexterm zone="kdepim knotes">
            <primary sortas="b-knotes">knotes</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="konsolekalendar">
        <term><command>konsolekalendar</command></term>
        <listitem>
          <para>is a command line interface to <application>KDE</application>
          calendars.</para>
          <indexterm zone="kdepim konsolekalendar">
            <primary sortas="b-konsolekalendar">konsolekalendar</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kontact">
        <term><command>kontact</command></term>
        <listitem>
          <para>is the integrated solution to personal information management
                (PIM) needs.</para>
          <indexterm zone="kdepim kontact">
            <primary sortas="b-kontact">kontact</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="korganizer">
        <term><command>korganizer</command></term>
        <listitem>
          <para>is a personal calendar/todo system.</para>
          <indexterm zone="kdepim korganizer">
            <primary sortas="b-korganizer">korganizer</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="korn">
        <term><command>korn</command></term>
        <listitem>
          <para>is a <application>KDE</application> mail checker that has the capabilities to
                dock itself to <command>kicker</command>.</para>
          <indexterm zone="kdepim korn">
            <primary sortas="b-korn">korn</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kpilot">
        <term><command>kpilot</command></term>
        <listitem>
          <para>is a program to synchronize a Palm-Pilot.</para>
          <indexterm zone="kdepim kpilot">
            <primary sortas="b-kpilot">kpilot</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ktnef">
        <term><command>ktnef</command></term>
        <listitem>
          <para>allows handling mail attachments using the TNEF format.
          Those attachments are usually found in mails coming
          from <trademark class="registered">Microsoft</trademark>
          mail servers and embed the mail properties as well as the
          actual attachments.</para>
          <indexterm zone="kdepim ktnef">
            <primary sortas="b-ktnef">ktnef</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kwatchgnupg">
        <term><command>kwatchgnupg</command></term>
        <listitem>
          <para>is simple<application>GnuPG</application> log viewer.</para>
          <indexterm zone="kdepim kwatchgnupg">
            <primary sortas="b-kwatchgnupg">kwatchgnupg</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>