source: general/genlib/gwrap.xml@ feb1f411

<?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 gwrap-download-http "http://download.savannah.gnu.org/releases/g-wrap/g-wrap-&gwrap-version;.tar.gz">
  <!ENTITY gwrap-download-ftp " ">
  <!ENTITY gwrap-md5sum "4d83964f51376500eedced538c1620cb">
  <!ENTITY gwrap-size "826 KB">
  <!ENTITY gwrap-buildsize "8.6 MB">
  <!ENTITY gwrap-time "0.2 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">g-wrap-&gwrap-version;.tar</keyword>
      <keyword role="ftpdir">g-wrap</keyword>
    </keywordset>
  </sect1info>

  <title>G-Wrap-&gwrap-version;</title>

  <indexterm zone="gwrap">
    <primary sortas="a-G-Wrap">G-Wrap</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to G-Wrap</title>

    <para>The <application>G-Wrap</application> package contains tools for
    exporting <application>C</application> libraries into
    <application>Scheme</application> interpreters. The version used here is
    considered a development version, however it has been confirmed to be a
    reliable replacement for the 'stable' version. The 'stable' version of
    <application>G-Wrap</application> will not build against the recent
    versions of <application>Guile</application> and
    <application>SLIB</application> and there will be no further development
    in the 'stable' series. For further information, please visit the
    <application>G-Wrap</application> homepage at
    <ulink url="http://www.nongnu.org/g-wrap/"/>.</para>

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

    <bridgehead renderas="sect3">G-Wrap Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="guile"/>, and
    <xref linkend="GLib"/> or <xref linkend="glib2"/></para>

    <para>If you are building <application>G-Wrap</application> as a dependency
    for <application>GnuCash</application>, ensure you have
    <application>GLib</application>-1 installed and you pass the
    <envar>GLIB_XXX</envar> environment variables to the
    <command>configure</command> script as shown below.</para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="gcc"/> (build Java so that
    <filename class='libraryfile'>libffi</filename> is built),
    <xref linkend="GTK"/>, and
    <ulink url="http://www.gnu.org/software/guile-gtk/">guile-gtk</ulink></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of G-Wrap</title>

    <para>Install <application>G-Wrap</application> by running the following
    commands:</para>

<screen><userinput>GLIB_CFLAGS=$(glib-config --cflags) \
GLIB_LIBS=$(glib-config --libs) \
./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>The test suite for this package is currently broken.</para>

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

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

  </sect2>

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

    <para><command>GLIB_CFLAGS=$(glib-config ...) GLIB_LIBS=$(glib-config ...)
    ./configure ...</command>: The <command>configure</command> script does
    not pull in the proper <application>GLib</application>-1 
    <envar>CFLAGS</envar> and <envar>LIBS</envar> parameters so
    <command>glib-config</command> is used to set them. Omit setting them like
    this if you are not building <application>G-Wrap</application> as a
    dependency for <application>GnuCash</application> and only issue the
    <command>./configure</command> command instead.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>g-wrap-config</seg>
        <seg>/usr/lib/libffi.[so,a], /usr/lib/libgw-guile-*.[so,a] and
        /usr/lib/libgwrap-*.[so,a]</seg>
        <seg>/usr/include/g-wrap, /usr/share/doc/g-wrap-&gwrap-version; and
        /usr/share/guile/site</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="g-wrap-config">
        <term><command>g-wrap-config</command></term>
        <listitem>
          <para>is a tool to generate <envar>CFLAGS</envar> for linking
          <application>C</application> code to the
          <application>Scheme</application> runtime libraries.</para>
          <indexterm zone="gwrap g-wrap-config">
            <primary sortas="b-g-wrap-config">g-wrap-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>