source: general/prog/guile.xml@ b1e4cd8

<?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 guile-download-http "&gnu-http;/guile/guile-&guile-version;.tar.xz">
  <!ENTITY guile-download-ftp  " ">
  <!ENTITY guile-md5sum        "258983e0156c2bc66539dcbcb96f2bd2">
  <!ENTITY guile-size          "5.5 MB">
  <!ENTITY guile-buildsize     "221 MB (add 4 MB for tests)">
  <!ENTITY guile-time          "5.9 SBU (Using parallelism=4; add 0.3 SBU for tests)">
]>

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


  <title>Guile-&guile-version;</title>

  <indexterm zone="guile">
    <primary sortas="a-Guile">Guile</primary>
  </indexterm>

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

    <para>
      The <application>Guile</application> package contains the GNU Project's
      extension language library. <application>Guile</application> also
      contains a stand alone <application>Scheme</application> interpreter.
    </para>

    &lfs120_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gc"/> and
      <xref linkend="libunistring"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="emacs"/> and
      <xref linkend="gdb"/> (run-time only dependencies).
    </para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr    \
            --disable-static \
            --docdir=/usr/share/doc/guile-&guile-version; &amp;&amp;
make      &amp;&amp;
make html &amp;&amp;

makeinfo --plaintext -o doc/r5rs/r5rs.txt doc/r5rs/r5rs.texi &amp;&amp;
makeinfo --plaintext -o doc/ref/guile.txt doc/ref/guile.texi</userinput></screen>

    <para>
      To test the results, issue: <command>./check-guile</command>.
      On an i686 system, as many as 10 tests will fail in the
      <filename>numbers.test</filename> test suite due to minor floating-point
      rounding errors.
    </para>
    <!-- 10 of the numbers tests fail on i686. This should probably be looked
         into at a later point in time. -renodr -->

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

<screen role="root"><userinput>make install      &amp;&amp;
make install-html &amp;&amp;

mkdir -p                       /usr/share/gdb/auto-load/usr/lib &amp;&amp;
mv /usr/lib/libguile-*-gdb.scm /usr/share/gdb/auto-load/usr/lib &amp;&amp;
mv /usr/share/doc/guile-&guile-version;/{guile.html,ref} &amp;&amp;
mv /usr/share/doc/guile-&guile-version;/r5rs{.html,}     &amp;&amp;

find examples -name "Makefile*" -delete         &amp;&amp;
cp -vR examples   /usr/share/doc/guile-&guile-version;   &amp;&amp;

for DIRNAME in r5rs ref; do
  install -v -m644  doc/${DIRNAME}/*.txt \
                    /usr/share/doc/guile-&guile-version;/${DIRNAME}
done &amp;&amp;
unset DIRNAME</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"/>

  </sect2>

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

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

      <seglistitem>
        <seg>
          guild, guile, guile-config, guile-snarf and guile-tools
        </seg>
        <seg>
          libguile-3.0.so and guile-readline.so
        </seg>
        <seg>
          /usr/include/guile,
          /usr/lib/guile,
          /usr/share/doc/guile-&guile-version; and
          /usr/share/guile
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="guile-prog">
        <term><command>guile</command></term>
        <listitem>
          <para>
            is a stand-alone Scheme interpreter for
            <application>Guile</application>
          </para>
          <indexterm zone="guile guile-prog">
            <primary sortas="b-guile">guile</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="guile-config">
        <term><command>guile-config</command></term>
        <listitem>
          <para>
            is a <application>Guile</application> script which provides the
            information necessary to link your programs against the
            <application>Guile</application> library, in much the same way
            PkgConfig does
          </para>
          <indexterm zone="guile guile-config">
            <primary sortas="b-guile-config">guile-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="guile-snarf">
        <term><command>guile-snarf</command></term>
        <listitem>
          <para>
            is a script to parse declarations in your
            <application>C</application> code for
            <application>Scheme</application> visible
            <application>C</application> functions
          </para>
          <indexterm zone="guile guile-snarf">
            <primary sortas="b-guile-snarf">guile-snarf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="guild">
        <term><command>guild</command></term>
        <listitem>
          <para>
            is a wrapper program installed along with <command>guile</command>,
            which knows where a particular module is installed and calls it,
            passing its arguments to the program
          </para>
          <indexterm zone="guile guild">
            <primary sortas="b-guild">guild</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="guile-tools">
        <term><command>guile-tools</command></term>
        <listitem>
          <para>
            is a symlink to <command>guild</command>
          </para>
          <indexterm zone="guile guile-tools">
            <primary sortas="b-guile-tools">guile-tools</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>