source: general/genlib/gmime.xml@ 6722219

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY gmime-download-http "http://spruce.sourceforge.net/gmime/sources/v2.1/gmime-&gmime-version;.tar.gz">
  <!ENTITY gmime-download-ftp  " ">
  <!ENTITY gmime-md5sum        "9a3075219597d461f153c4c34056f553">
  <!ENTITY gmime-size          "919 KB">
  <!ENTITY gmime-buildsize     "18.6 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>
    <keywordset>
      <keyword role="package">gmime-&gmime-version;.tar</keyword>
      <keyword role="ftpdir">gmime</keyword>
    </keywordset>
  </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>

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

    <para>Note: the package version listed above is considered to be in the
    development branch of <application>GMime</application>. This version is
    used in the BLFS book, as the only package that requires it,
    <application>Balsa</application>, requires a version equal to or greater
    than 2.1.9. Not to worry though, as the maintainer has this to say about
    the versions: <quote>at this time, even though 2.1.x has not made the
    final 2.2.0 release, it is considered more stable and more robust than the
    2.0.x series</quote>. You can see this quote at <ulink
    url="http://spruce.sourceforge.net/gmime/sources/NOTE_ABOUT_2.0"/>.</para>

    <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"><ulink url="http://go-mono.com/sources/">Gtk#</ulink>
    (requires a .NET framework:
    <ulink url="http://www.mono-project.com/Main_Page">Mono</ulink> or
    <ulink url="http://www.southern-storm.com.au/portable_net.html">
    DotGNU Portable.NET</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 &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</para>

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

    <para>This package will overwrite the <command>uudecode</command> and
    <command>uuencode</command> programs installed by the
    <application>sharutils</application> package (or any other package that
    may install these programs) if they exist in
    <filename class='directory'>/usr/bin</filename>. If you wish to preserve
    the existing programs, ensure you rename them before issuing the following
    commands.</para>

<screen role="root"><userinput>make install &amp;&amp;
install -v -m755 \
    -d /usr/share/doc/gmime-&gmime-version;/{tutorial,examples,tests} &amp;&amp;
install -v -m644 README /usr/share/doc/gmime-&gmime-version; &amp;&amp;
install -v -m644 examples/{README,{basic,imap}-example.c} \
    /usr/share/doc/gmime-&gmime-version;/examples &amp;&amp;
install -v -m755 examples/{basic,imap}-example \
    /usr/share/doc/gmime-&gmime-version;/examples &amp;&amp;
install -v -m644 tests/test-{best,html,iconv,mbox,mime,parser}.c \
    /usr/share/doc/gmime-&gmime-version;/tests &amp;&amp;
install -v -m644 tests/test{-{partial,pgp{,mime},streams}.c,?.eml} \
    /usr/share/doc/gmime-&gmime-version;/tests &amp;&amp;
install -v -m755 tests/test-{best,html,iconv,mbox,mime,parser} \
    /usr/share/doc/gmime-&gmime-version;/tests &amp;&amp;
install -v -m755 tests/test-{partial,pgp{,mime},streams} \
    /usr/share/doc/gmime-&gmime-version;/tests &amp;&amp;
cp -v -R docs/tutorial/html/* /usr/share/doc/gmime-2.1.17/tutorial</userinput></screen>

  </sect2>

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

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

      <seglistitem>
        <seg>gmime-config, uudecode and uuencode</seg>
        <seg>libgmime-2.0.{so,a} and optionally,
        <application>Mono</application> bindings</seg>
        <seg>/usr/include/gmime-2.0, /usr/lib/mono/gac/gmime-sharp,
        /usr/lib/mono/gmime-sharp, /usr/share/doc/gmime-2.1.17 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="gmime-config">
        <term><command>gmime-config</command></term>
        <listitem>
          <para>is used to gather information about how and where
          <application>GMime</application> was installed. It is typically
          used by other programs seeking to link to the
          <application>GMime</application> library.</para>
          <indexterm zone="gmime gmime-config">
            <primary sortas="b-gmime-config">gmime-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="uudecode">
        <term><command>uudecode</command></term>
        <listitem>
          <para>is used to decode files or data encoded with
          <command>uuencode</command>.</para>
          <indexterm zone="gmime uudecode">
            <primary sortas="b-uudecode">uudecode</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="uuencode">
        <term><command>uuencode</command></term>
        <listitem>
          <para>is a method of encoding binary data into 7-bit ASCII
          data.</para>
          <indexterm zone="gmime uuencode">
            <primary sortas="b-uuencode">uuencode</primary>
          </indexterm>
        </listitem>
      </varlistentry>


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

    </variablelist>

  </sect2>

</sect1>