source: general/prog/ruby.xml@ ec6a601

<?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 ruby-download-http "http://www.ibiblio.org/pub/languages/ruby/ruby/ruby-&ruby-version;.tar.gz">
  <!ENTITY ruby-download-ftp  "ftp://ftp.ruby-lang.org/pub/ruby/ruby-&ruby-version;.tar.gz">
  <!ENTITY ruby-md5sum        "bd8c2e593e1fa4b01fd98eaf016329bb">
  <!ENTITY ruby-size          "4.3 MB">
  <!ENTITY ruby-buildsize     "65.9 MB">
  <!ENTITY ruby-time          "1.0 SBU">
]>

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

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

  <title>Ruby-&ruby-version;</title>

  <indexterm zone="ruby">
    <primary sortas="a-Ruby">Ruby</primary>
  </indexterm>

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

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

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <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>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="openssl"/>,
    <xref linkend="tk"/>, and
    <!-- <xref linkend="db"/>, -->
    <xref linkend="gdbm"/></para>

  </sect2>

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

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

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

    <para>To test the results, issue: <command>make test</command>.</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><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 role="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>ruby, irb, erb, rdoc, ri, and testrb</seg>
        <seg>libruby.so and numerous modules located in the
        <filename class='directory'>/usr/lib/ruby</filename> hierarchy.</seg>
        <seg>/usr/lib/ruby and /usr/share/ri</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="ruby-prog">
        <term><command>ruby</command></term>
        <listitem>
          <para>is an interpreted scripting language for quick
          and easy object-oriented programming.</para>
          <indexterm zone="ruby ruby-prog">
            <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 irb">
            <primary sortas="b-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 erb">
            <primary sortas="b-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 ri">
            <primary sortas="b-ri">ri</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>