source: general/genlib/gmime.xml@ c80db1b

<?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 gmime-download-http "&gnome-download-http;/gmime/2.4/gmime-&gmime-version;.tar.xz">
  <!ENTITY gmime-download-ftp "&gnome-download-ftp;/gmime/2.4/gmime-&gmime-version;.tar.xz">
  <!ENTITY gmime-md5sum        "46a52361d43769d20dbd87aa225bc3f9">
  <!ENTITY gmime-size          "672 KB">
  <!ENTITY gmime-buildsize     "21 MB">
  <!ENTITY gmime-time          "0.4 SBU">
]>

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

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

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

  <indexterm zone="gmime">
    <primary sortas="a-GMime">GMime</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="http://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>

    &lfs70_checked;

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

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

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

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

    <para condition="html" role="usernotes">User Notes:
      <ulink url="&blfs-wiki;/gmime"/>
    </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>
      If you have <xref linkend="docbook-utils"/> installed and you wish
      to generate the API tutorials, issue the following commands:
    </para>

<screen><userinput>pushd docs/tutorial &amp;&amp;
docbook2html --nochunks gmime-tut.sgml &amp;&amp;
docbook2pdf             gmime-tut.sgml &amp;&amp;
docbook2ps              gmime-tut.sgml &amp;&amp;
docbook2txt             gmime-tut.sgml &amp;&amp;
popd</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>. Note that
      some tests may fail because the corresponding sub-system is not installed
      or configured properly.
    </para>

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

<screen role="root"><userinput>make install &amp;&amp;
install -v -m755 -d /usr/share/doc/gmime-&gmime-version; &amp;&amp;
install -v -m644    README \
                    /usr/share/doc/gmime-&gmime-version;</userinput></screen>

    <para> 
      If you generated the API tutorials, still as the
      <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>install -v -m644    docs/tutorial/gmime* \
                    /usr/share/doc/gmime-&gmime-version;</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 Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          libgmime-2.4.so
        </seg>
        <seg>
          /usr/include/gmime-2.4,
          /usr/share/doc/gmime-&gmime-version; and
          /usr/share/gtk-doc/html/gmime
        </seg>
      </seglistitem>
    </segmentedlist>

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

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

    </variablelist>

  </sect2>

</sect1>