source: gnome/platform/evolution-data-server.xml@ 7bfd30d

<?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 evolution-data-server-download-http
           "&gnome-download-http;/evolution-data-server/&gnome-minor-48;/evolution-data-server-&evolution-data-server-version;.tar.xz">
  <!ENTITY evolution-data-server-download-ftp
           "&gnome-download-ftp;/evolution-data-server/&gnome-minor-48;/evolution-data-server-&evolution-data-server-version;.tar.xz">
  <!ENTITY evolution-data-server-md5sum        "4712321afa0a42a4b9280b86da3f4a6b">
  <!ENTITY evolution-data-server-size          "4.7 MB">
  <!ENTITY evolution-data-server-buildsize     "174 MB (with tests)">
  <!ENTITY evolution-data-server-time          "0.6 SBU (using parallelism=4, add 0.1 SBU for tests)">
]>

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


  <title>evolution-data-server-&evolution-data-server-version;</title>

  <indexterm zone="evolution-data-server">
    <primary sortas="a-evolution-data-server">evolution-data-server</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Evolution Data Server</title>

    <para>
      The <application>Evolution Data Server</application> package provides
      a unified backend for programs that work with contacts, tasks, and calendar
      information. It was originally developed for
      <application>Evolution</application> (hence the name), but is now used by
      other packages as well.
    </para>

    &lfs113_checked;

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

    <bridgehead renderas="sect3">Evolution Data Server Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libical"/>,
      <xref linkend="libsecret"/>,
      <xref linkend="nss"/>, and
      <xref linkend="sqlite"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gnome-online-accounts"/>,
      <xref linkend="gobject-introspection"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="icu"/>,
      <xref linkend="libcanberra"/>,
      <xref linkend="libgweather"/>,
      <xref linkend="vala"/>, and
      <xref linkend="webkitgtk"/>
    </para>

    <bridgehead renderas="sect4"
                revision="sysv">Recommended (Runtime)</bridgehead>
    <para role="recommended" revision="sysv">
      <xref linkend="blocaled" role="runtime"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="db"/>,
      <xref linkend="gtk-doc"/>,
      <xref linkend="mitkrb"/>,
      a <xref linkend="server-mail"/> (that provides a <command>sendmail</command> command),
      <xref linkend="openldap"/>, and
      <ulink url="https://github.com/googlei18n/libphonenumber/">libphonenumber</ulink>
    </para>

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

  <sect2 role="installation">
    <title>Installation of Evolution Data Server</title>

    <para>
      Install <application>Evolution Data Server</application> by running
      the following commands:
    </para>

<screen revision="sysv"><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=/usr    \
      -DSYSCONF_INSTALL_DIR=/etc     \
      -DENABLE_VALA_BINDINGS=ON      \
      -DENABLE_INSTALLED_TESTS=ON    \
      -DWITH_OPENLDAP=OFF            \
      -DWITH_KRB5=OFF                \
      -DENABLE_INTROSPECTION=ON      \
      -DENABLE_GTK_DOC=OFF           \
      -DWITH_LIBDB=OFF               \
      -DWITH_SYSTEMDUSERUNITDIR=no   \
      -Wno-dev -G Ninja ..           \
      .. &amp;&amp;
ninja</userinput></screen>

<screen revision="systemd"><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=/usr    \
      -DSYSCONF_INSTALL_DIR=/etc     \
      -DENABLE_VALA_BINDINGS=ON      \
      -DENABLE_INSTALLED_TESTS=ON    \
      -DWITH_OPENLDAP=OFF            \
      -DWITH_KRB5=OFF                \
      -DENABLE_INTROSPECTION=ON      \
      -DENABLE_GTK_DOC=OFF           \
      -DWITH_LIBDB=OFF               \
      -Wno-dev -G Ninja ..           \
      .. &amp;&amp;
ninja</userinput></screen>

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

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

    <para>
      To test the results, issue: <command>ninja test</command>.
    </para>

    <!-- The tests need to be run after the package is installed due to
    compatibility issues that show up when upgrading from previous versions
    of e-d-s. This is due to soup2/soup3 mixing. -->

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

<!--
    <para>
      <parameter>-DENABLE_GOOGLE=ON</parameter>: This switch enables
      access to google services via <xref linkend="libgdata"/> and also
      enables the Google Authentication option.
    </para>
-->

    <para>
      <parameter>-DENABLE_VALA_BINDINGS=ON</parameter>: This switch
      enables building the Vala bindings. Remove if you don't
      have <xref linkend="vala"/> installed.
    </para>

    <para>
      <parameter>-DENABLE_GTK_DOC=OFF</parameter>: This switch
      disables building the API documentation. It is broken for
      this package due to the use of a long deprecated gtk-doc program
      that is no longer available.
    </para>

    <para>
      <parameter>-DWITH_LIBDB=OFF</parameter>: This switch allows building
      this package without <xref linkend="db"/>.  This package only uses
      <xref linkend="db"/> to import data from very outdated releases.
      <xref linkend="sqlite"/> is used for normal operation.
    </para>

<!--
    <para>
      <parameter>-DWITH_GWEATHER4=ON</parameter>: This switch allows building
      this package with <xref linkend="libgweather"/>.
    </para>
-->

    <para>
      <option>-DENABLE_OAUTH2_WEBKITGTK4=OFF</option>: Use this switch if
      you did not build <xref linkend="webkitgtk" role="nodep"/> with GTK-4.
    </para>

    <para revision="sysv">
      <parameter>-DWITH_SYSTEMDUSERUNITDIR=no</parameter>: This switch
      disables installing the systemd units, which are not used for a Sysv
      build.
    </para>

    <note>
      <para>
        To enable many of the optional dependencies, review the information
        from <command>cmake -L CMakeLists.txt</command> for the necessary
        parameters you must pass to the <command>cmake</command> command.
      </para>
    </note>

  </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>
          libcamel-1.2.so,
          libebackend-1.2.so,
          libebook-1.2.so,
          libebook-contacts-1.2.so,
          libecal-2.0.so,
          libedata-book-1.2.so,
          libedata-cal-2.0.so,
          libedataserver-1.2.so,
          libedataserverui-1.2.so,
          libedataserverui4-1.0.so,
          and libetestserverutils.so
        </seg>
        <seg>
          /usr/include/evolution-data-server,
          /usr/lib{,exec}/evolution-data-server,
          /usr/share/evolution-data-server,
          /usr/share/installed-tests/evolution-data-server, and
          <!-- We explicitly disable gtk-doc generation, so comment these out
          /usr/share/gtk-doc/html/{camel,libebackend,libebook},
          /usr/share/gtk-doc/html/{libecal,libedata-book,libedata-cal},
          /usr/share/gtk-doc/html/{libedataserver,libedataserverui} and
          -->
          /usr/share/pixmaps/evolution-data-server
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libcamel-1">
        <term><filename class="libraryfile">libcamel-1.2.so</filename></term>
        <listitem>
          <para>
            is the <application>Evolution</application> MIME message
            handling library
          </para>
          <indexterm zone="evolution-data-server libcamel-1">
            <primary sortas="c-libcamel-1">libcamel-1.2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libebackend-1">
        <term><filename class="libraryfile">libebackend-1.2.so</filename></term>
        <listitem>
          <para>
            is the utility library for
            <application>Evolution Data Server</application> Backends
          </para>
          <indexterm zone="evolution-data-server libebackend-1">
            <primary sortas="c-libebackend-1">libebackend-1.2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libebook-1">
        <term><filename class="libraryfile">libebook-1.2.so</filename></term>
        <listitem>
          <para>
            is the client library for <application>Evolution</application>
            address books
          </para>
          <indexterm zone="evolution-data-server libebook-1">
            <primary sortas="c-libebook-1">libebook-1.2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libebook-contacts-1">
        <term><filename class="libraryfile">libebook-contacts-1.2.so</filename></term>
        <listitem>
          <para>
            is the client library for <application>Evolution</application>
            contacts
          </para>
          <indexterm zone="evolution-data-server libebook-contacts-1">
            <primary sortas="c-libebook-contacts-1">libebook-contacts-1.2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libecal-1">
        <term><filename class="libraryfile">libecal-1.2.so</filename></term>
        <listitem>
          <para>
            is the client library for <application>Evolution</application>
            calendars
          </para>
          <indexterm zone="evolution-data-server libecal-1">
            <primary sortas="c-libecal-1">libecal-1.2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libedata-book-1">
        <term><filename class="libraryfile">libedata-book-1.2.so</filename></term>
        <listitem>
          <para>
            is the backend library for <application>Evolution</application>
            address books
          </para>
          <indexterm zone="evolution-data-server libedata-book-1">
            <primary sortas="c-libedata-book-1">libedata-book-1.2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libedata-cal-1">
        <term><filename class="libraryfile">libedata-cal-1.2.so</filename></term>
        <listitem>
          <para>
            is the backend library for <application>Evolution</application>
            calendars
          </para>
          <indexterm zone="evolution-data-server libedata-cal-1">
            <primary sortas="c-libedata-cal-1">libedata-cal-1.2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libedataserver-1">
        <term><filename class="libraryfile">libedataserver-1.2.so</filename></term>
        <listitem>
          <para>
            is the utility library for
            <application>Evolution Data Server</application>
          </para>
          <indexterm zone="evolution-data-server libedataserver-1">
            <primary sortas="c-libedataserver-1">libedataserver-1.2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libedataserverui-3">
        <term><filename class="libraryfile">libedataserverui-3.0.so</filename></term>
        <listitem>
          <para>
            is the GUI utility library for
            <application>Evolution Data Server</application>
          </para>
          <indexterm zone="evolution-data-server libedataserverui-3">
            <primary sortas="c-libedataserverui-3">libedataserverui-3.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libedataserverui4-1">
        <term><filename class="libraryfile">libedataserverui4-1.0.so</filename></term>
        <listitem>
          <para>
            is the GTK-4 based GUI utility library for
            <application>Evolution Data Server</application>
          </para>
          <indexterm zone="evolution-data-server libedataserverui4-1">
            <primary sortas="c-libedataserverui4-1">libedataserverui4-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libetestserverutils-1">
        <term><filename class="libraryfile">libetestserverutils.so</filename></term>
        <listitem>
          <para>
            is the server test utility library for
            <application>Evolution Data Server</application>
          </para>
          <indexterm zone="evolution-data-server libetestserverutils-1">
            <primary sortas="c-libetestserverutils-1">libetestserverutils.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>


    </variablelist>

  </sect2>

</sect1>