source: general/genlib/gmime3.xml

<?xml version="1.0" encoding="UTF-8"?>
<!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 gmime3-download-http "&gnome-download-http;/gmime/3.2/gmime-&gmime3-version;.tar.xz">
  <!ENTITY gmime3-download-ftp  " ">
  <!ENTITY gmime3-md5sum        "7ecd9aa75e0cd2e8668206b1d53df874">
  <!ENTITY gmime3-size          "2.1 MB">
  <!ENTITY gmime3-buildsize     "25 MB (with tests)">
  <!ENTITY gmime3-time          "0.3 SBU (with tests)">
]>

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


  <title>GMime-&gmime3-version;</title>

  <indexterm zone="gmime3">
    <primary sortas="a-GMime-3">GMime 3</primary>
  </indexterm>

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

    <para>
      The <application>GMime</application> package contains a set of
      utilities for parsing and creating messages using the Multipurpose
      Internet Mail Extension (MIME) as defined by the applicable RFCs. See the
      <ulink url="https://spruce.sourceforge.net/gmime/">GMime web site</ulink>
      for the RFCs resourced. This is useful as it provides an API which adheres
      to the MIME specification as closely as possible while also providing
      programmers with an extremely easy to use interface to the API functions.
    </para>

    &lfs121_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="glib2"/> (GObject Introspection recommended) and
      <xref linkend="libgpg-error"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="docbook-utils"/>,
      <xref linkend="gpgme"/>,
      <xref linkend="gtk-doc"/>,
      <xref linkend="libnsl"/>,
      <xref linkend="vala"/>, and
      <ulink url="https://download.mono-project.com/sources/gtk-sharp/">Gtk#</ulink> (requires
      <ulink url="https://www.mono-project.com/Main_Page">Mono</ulink>)
    </para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --disable-static &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</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>

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

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

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libgmime-3.0.so
        </seg>
        <seg>
          /usr/include/gmime-3.0 and
          /usr/share/gtk-doc/html/gmime-3.0
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgmime-3">
        <term><filename class="libraryfile">libgmime-3.0.so</filename></term>
        <listitem>
          <para>
            contains API functions used by programs that need to comply to
            the MIME standards
          </para>
          <indexterm zone="gmime3 libgmime-3">
            <primary sortas="c-libgmime-3">libgmime-3.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>