source: gnome/applications/evolution.xml@ b423560

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

  <!-- Editors: Make sure directory is correct when updating -->

  <!ENTITY evolution-download-http "&gnome-download-http;/evolution/&gnome-minor-46;/evolution-&evolution-version;.tar.xz">
  <!ENTITY evolution-download-ftp  "&gnome-download-ftp;/evolution/&gnome-minor-46;/evolution-&evolution-version;.tar.xz">
  <!ENTITY evolution-md5sum        "c6c6d66ac00363172f6870c7cab46593">
  <!ENTITY evolution-size          "13 MB">
  <!ENTITY evolution-buildsize     "370 MB">
  <!ENTITY evolution-time          "1.1 SBU (Using parallelism=4)">
]>

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


  <title>Evolution-&evolution-version;</title>

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

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

    <para>
      The <application>Evolution</application> package contains an
      integrated mail, calendar and address book suite designed for the
      <application>GNOME</application> environment.
    </para>

    &lfs112_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&evolution-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&evolution-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &evolution-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &evolution-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &evolution-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &evolution-time;
        </para>
      </listitem>
    </itemizedlist>
    <!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/evolution-&evolution-version;-security_fix-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>
    -->
    <bridgehead renderas="sect3">Evolution Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="adwaita-icon-theme"/>,
      <xref linkend="evolution-data-server"/>,
      <xref linkend="gcr4"/>,
      <xref linkend="gnome-autoar"/>,
      <xref linkend="itstool"/>,
      <xref linkend="shared-mime-info"/>, and
      <xref linkend="webkitgtk"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="bogofilter"/>,
      <xref linkend="enchant"/>,
      <xref linkend="gnome-desktop"/>,
      <xref linkend="gspell"/>,
      <xref linkend="highlight"/>,
      <xref linkend="libcanberra"/>,
      <xref linkend="libgweather"/>,
      <xref linkend="libnotify"/>,
      <xref linkend="openldap"/>, and
      <xref linkend="seahorse"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="clutter-gtk"/>,
      <xref linkend="geoclue2"/>,
      <xref linkend="geocode-glib"/>, and
      <xref linkend="libchamplain"/> (Contact Maps plugin),
      <xref linkend="gtk-doc"/>,
      <ulink url="https://github.com/commonmark/cmark">cmark</ulink>,
      <ulink url="https://glade.gnome.org/">Glade</ulink>,
      <ulink url="http://www.five-ten-sg.com/libpst/">libpst</ulink>,
      <ulink url="https://launchpad.net/libunity/">libunity</ulink>,
      <ulink url="https://github.com/Yeraze/ytnef">libytnef</ulink>
    </para>

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

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

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

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

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DSYSCONF_INSTALL_DIR=/etc  \
      -DENABLE_INSTALLED_TESTS=ON \
      -DENABLE_PST_IMPORT=OFF     \
      -DENABLE_YTNEF=OFF          \
      -DENABLE_CONTACT_MAPS=OFF   \
      -DENABLE_MARKDOWN=OFF       \
      -DENABLE_WEATHER=ON         \
      -G Ninja .. &amp;&amp;
ninja</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>ninja install</userinput></screen>

  </sect2>

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

    <para>
      <parameter>-DENABLE_YTNEF=OFF</parameter>: This switch is used to
      disable the yTNEF library usage because
      <application>libytnef</application> is not part of BLFS.
    </para>

    <para>
      <parameter>-DENABLE_PST_IMPORT=OFF</parameter>: This switch is
      used to disable the pst-import plugin because
      <application>libpst</application> is not part of BLFS.
    </para>

    <para>
      <parameter>-DENABLE_CONTACT_MAPS=OFF</parameter>: This switch disables
      building the Contact Maps plugin. Remove this switch if you have installed
      the necessary dependencies and wish to build the Contact Maps plugin.
    </para>

    <para>
      <parameter>-DENABLE_MARKDOWN=OFF</parameter>: This switch allows
      building without
      <ulink url="https://github.com/commonmark/cmark">cmark</ulink>.
      Remove this switch if you need markdown support and you have
      installed the necessary dependency.
    </para>

    <para>
      <parameter>-DENABLE_WEATHER=ON</parameter>: This switch allows
      building against <xref linkend="libgweather"/>.
    </para>

    <para>
      <option>-DWITH_OPENLDAP=OFF</option>: Use this switch if you
      have not installed <xref linkend='openldap'/>.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          evolution
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /usr/include/evolution,
          /usr/lib/evolution,
          /usr/libexec/evolution,
          /usr/share/evolution,
          /usr/share/installed-tests/evolution,
          /usr/share/help/*/evolution, and optionally
          /usr/share/gtk-doc/html/{evolution-mail-composer,evolution-mail-engine},
          /usr/share/gtk-doc/html/{evolution-mail-formatter,evolution-shell}, and
          /usr/share/gtk-doc/html/evolution-util
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="evolution-prog">
        <term><command>evolution</command></term>
        <listitem>
          <para>
            is an email, calendar and address book suite for
            the <application>GNOME</application> Desktop
          </para>
          <indexterm zone="evolution evolution-prog">
            <primary sortas="b-evolution">evolution</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>