source: general/genlib/gmp.xml@ a88b03e

<?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 gmp-download-http "http://ftp.gnu.org/gnu/gmp/gmp-&gmp-version;.tar.bz2">
  <!ENTITY gmp-download-ftp  "ftp://ftp.gnu.org/gnu/gmp/gmp-&gmp-version;.tar.bz2">
  <!ENTITY gmp-md5sum        "7ce52531644e6d12f16911b7e3151f3f">
  <!ENTITY gmp-size          "1.7 MB">
  <!ENTITY gmp-buildsize     "36 MB (additional 11 MB for alternative documentation)">
  <!ENTITY gmp-time          "1.0 SBU (additional 0.6 SBU to run the testsuite)">
]>

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

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

  <title>GMP-&gmp-version;</title>

  <indexterm zone="gmp">
    <primary sortas="a-GMP">GMP</primary>
  </indexterm>

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

    <para>The <application>GMP</application> package
    contains math libraries. These have useful functions for arbitrary precision
    arithmetic.</para>

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

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --enable-cxx --enable-mpbsd &amp;&amp;
make</userinput></screen>

    <para>If you have <xref linkend="tetex"/> installed and you wish to create
    alternate formats of the documentation, issue any or all of the following
    commands:</para>

<screen><userinput>make -C doc pdf &amp;&amp;
make -C doc ps &amp;&amp;
make -C doc html &amp;&amp;
texi2html -o doc/gmp_nochunks.html doc/gmp.texi &amp;&amp;
makeinfo --plaintext -o doc/gmp.txt doc/gmp.texi</userinput></screen>

    <para>To test the results, issue: <command>make check</command>.
    Owing to various reports of mis-compilations, the maintainer strongly
    recommends running the test-suite and reporting any failures. The libraries
    should not be used in a production environment if there are problems
    running <command>make check</command>. An easy way to determine if all the
    tests passed is to redirect the output of the tests to a file
    (<command>make check &gt;check.log 2&gt;&amp;1</command>) and issue
    the following command:</para>

<screen><userinput>awk '/tests passed/{total+=$2} ; END{print total}' check.log</userinput></screen>

    <para>139 should be returned.</para>

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

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

    <para>If you created any of the alternate formats of the documentation,
    install it using the following commands as the
    <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/gmp-&gmp-version;/html &amp;&amp;
install -v -m644 doc/gmp.html/* /usr/share/doc/gmp-&gmp-version;/html &amp;&amp;
install -v -m644 doc/{isa_abi_headache,configuration} \
                 doc/*.{pdf,dvi,ps,html,txt} \
    /usr/share/doc/gmp-&gmp-version;</userinput></screen>
  </sect2>

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

    <para><parameter>--enable-cxx</parameter>: This parameter
    enables C++ support by building the
    <filename class="libraryfile">libgmpxx</filename> libraries.</para>

    <para><parameter>--enable-mpbsd</parameter>: This parameter
    enables building the Berkeley MP compatibility
    (<filename class="libraryfile">libmp</filename>) libraries.</para>

  </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>libgmp.{so,a}, libgmpxx.{so,a} and libmp.{so,a}</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgmp">
        <term><filename class='libraryfile'>libgmp.{so,a}</filename></term>
        <listitem>
          <para>contains functions to operate on signed integers, rational
          numbers, and floating point numbers.</para>
          <indexterm zone="gmp libgmp">
            <primary sortas="c-libgmp">libgmp.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>