source: general/prog/ruby.xml@ 518538f

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

<!ENTITY ruby-download-http " ">
<!ENTITY ruby-download-ftp "ftp://ftp.ruby-lang.org/pub/ruby/ruby-&ruby-version;.tar.gz">
<!ENTITY ruby-md5sum "8ffc79d96f336b80f2690a17601dea9b">
<!ENTITY ruby-size "3.5 MB">
<!ENTITY ruby-buildsize "36.2 MB">
<!ENTITY ruby-time "0.62 SBU">
]>

<sect1 id="ruby-package" xreflabel="Ruby-&ruby-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="ruby.html"?>
<title>Ruby-&ruby-version;</title>
<indexterm zone="ruby-package"><primary sortas="a-Ruby">Ruby</primary></indexterm>

<sect2>
<title>Introduction to <application>Ruby</application></title>

<para>The <application>Ruby</application> package contains the
<application>Ruby</application> development environment. This
is useful for object-oriented scripting.</para>

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

<sect3><title><application>Ruby</application> dependencies</title>
<sect4><title>Optional</title>
<para><xref linkend="openssl"/>, 
<xref linkend="tk"/>, 
<xref linkend="db"/>, 
<xref linkend="gdbm"/></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>Ruby</application></title>

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

<screen><userinput><command>./configure --prefix=/usr \
    --enable-shared --enable-pthread &amp;&amp;
make &amp;&amp;
make install &amp;&amp;
make install-doc</command></userinput></screen>


</sect2>

<sect2>
<title>Command explanations</title>

<para><parameter>--enable-shared</parameter>: This parameter builds the 
<filename class='libraryfile'>libruby</filename> shared library.</para>

<para><parameter>--enable-pthread</parameter>: This parameter links the 
threading library into the <application>Ruby</application> build.</para>

</sect2>

<sect2>
<title>Contents</title>

<segmentedlist>
<segtitle>Installed Program</segtitle>
<segtitle>Installed Library</segtitle>
<segtitle>Installed Scripts</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>ruby</seg>
<seg>libruby.so</seg>
<seg>irb, erb, rdoc, ri and testrb</seg>
<seg>/usr/lib/ruby and /usr/share/ri</seg></seglistitem>
</segmentedlist>

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

<varlistentry id="ruby">
<term><command>ruby</command></term>
<listitem><para>is an interpreted scripting language for quick
and easy object-oriented programming.</para>
<indexterm zone="ruby-package ruby"><primary sortas="b-ruby">ruby</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="irb">
<term><command>irb</command></term>
<listitem><para>is the interactive interface for
<application>Ruby</application>.</para>
<indexterm zone="ruby-package irb"><primary sortas="d-irb">irb</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="erb">
<term><command>erb</command></term>
<listitem><para>is Tiny eRuby. It interprets a
<application>Ruby</application> code embedded text file.</para>
<indexterm zone="ruby-package erb"><primary sortas="d-erb">erb</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="ri">
<term><command>ri</command></term>
<listitem><para>displays documentation from a database on
<application>Ruby</application> classes, modules and methods.</para>
<indexterm zone="ruby-package ri"><primary sortas="d-ri">ri</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="libruby">
<term><filename role="library">libruby.so</filename></term>
<listitem><para>contains the <acronym>API</acronym> functions required
by <application>Ruby</application>.</para>
<indexterm zone="ruby-package libruby"><primary
sortas="c-libruby">libruby.so</primary></indexterm>
</listitem>
</varlistentry>


</variablelist>

</sect2>

</sect1>