source: archive/slib.xml@ c339779

<?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 slib-download-http
  "http://groups.csail.mit.edu/mac/ftpdir/scm/slib-&slib-version;.tar.gz">
  <!ENTITY slib-download-ftp  " ">
  <!ENTITY slib-md5sum        "dcada65c4df4209c8f71211095bcef8e">
  <!ENTITY slib-size          "956 KB">
  <!ENTITY slib-buildsize     "10 MB (includes building and installing docs)">
  <!ENTITY slib-time          "0.5 SBU">
]>

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

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

  <title>SLIB-&slib-version;</title>

  <indexterm zone="slib">
    <primary sortas="a-SLIB">SLIB</primary>
  </indexterm>

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

    <para>The <application>SLIB</application> package is a portable library for
    the <application>Scheme</application> programming language. It provides a
    platform independent framework for using <quote>packages</quote> of
    <application>Scheme</application> procedures and syntax.
    Its catalog can be transparently extended to accommodate packages specific
    to a site, implementation, user or directory. SLIB provides compatibility
    and utility functions for all standard Scheme implementations including
    Bigloo, Chez, ELK 3.0, GAMBIT 3.0, Guile, JScheme, MacScheme, MITScheme,
    PLT Scheme (DrScheme and MzScheme), Pocket Scheme, RScheme, scheme->C,
    Scheme48, SCM, SCM Mac, scsh, Stk, T3.1, umb-scheme, and VSCM.</para>

    &lfs74_checked;

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

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

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

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

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

    <para>Install <application>SLIB</application> by issuing the following
    commands:</para>

<screen><userinput>sed -i 's|usr/lib|usr/share|' RScheme.init                      &amp;&amp;
./configure --prefix=/usr --libdir=/usr/share                   &amp;&amp;

sed -i -e 's# scm$# guile#;s#ginstall-info#install-info#' \
       -e 's/no-split -o/no-split --force -o/' Makefile         &amp;&amp;

makeinfo -o slib.txt --plaintext --force slib.texi              &amp;&amp;
makeinfo -o slib.html --html --no-split --force slib.texi</userinput></screen>

<!-- Thee are errors in slib.texi
    <para>If you have <xref linkend="texlive"/> installed and wish to build PDF
    or Postscript documentation, issue any or all of the following
    commands:</para>

<screen><userinput>texi2pdf slib.texi &amp;&amp;
texi2dvi slib.texi &amp;&amp;
dvips -o slib.ps slib.dvi</userinput></screen>
-->
    <para>This package does not come with a functional test suite.</para>

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

<screen role="root"><userinput>make install                                            &amp;&amp;
ln -v -sf ../slib /usr/share/guile                      &amp;&amp;
mkdir -pv /usr/share/guile/site/2.0                     &amp;&amp;
guile -c "(use-modules (ice-9 slib)) (require 'printf)" &amp;&amp;
install -v -m755 -d /usr/share/doc/slib-&slib-version;             &amp;&amp;
install -v -m644 ANNOUNCE FAQ README slib.{txt,html} /usr/share/doc/slib-&slib-version;</userinput></screen>

<!--
    <para>If you built any of the optional documentation, install it using the
    following command as the <systemitem class="username">root</systemitem>
    user:</para>

<screen role="root"><userinput>install -v -m644 slib.{pdf,dvi,ps} /usr/share/doc/slib-&slib-version;</userinput></screen>
 -->
 </sect2>

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

    <para><command>sed -i 's|usr/lib|usr/share|' RScheme.init</command>:
    This command is used to change the <envar>libdir</envar> variable embedded
    in the script to match the installation.</para>

    <para><option>--libdir=/usr/share</option>: This option puts the installed
    in files <filename class="directory">/usr/share/slib</filename> instead of
    <filename class="directory">/usr/lib/slib</filename>.</para>

    <para><command>makeinfo ... --force ... </command>: This command creates
    needed documentation, but needs the <option>--force</option> option to
    overcome warnings that are flagged as errors in recent versions of
    <command>makeinfo</command>.</para>

    <para><command>ln -v -sf ../slib /usr/share/guile</command>: This command
    puts a symbolic link to the <application>slib</application> files in
    <application>Guile</application>'s default <quote>Implementation
    Vicinity</quote>.</para>

    <para><command>guile -c "(use-modules (ice-9 slib)) (require
    'printf)"</command>: This command creates a guile catalog of the
    <application>slib</application> files.</para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>slib</seg>
        <seg>a <application>Scheme</application> library system</seg>
        <seg>/usr/share/slib,
             /usr/share/guile/site/2.0, and
             /usr/share/doc/slib-&slib-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="slib-prog">
        <term><command>slib</command></term>
        <listitem>
          <para>is a shell script used to initialize
          <application>SLIB</application> in a named
          <application>Scheme</application> implementation. It can also be
          used to initialize an <application>SLIB</application> session using
          a given executable.</para>
          <indexterm zone="slib slib-prog">
            <primary sortas="b-slib">slib</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>