[52d29f7] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[52d29f7] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
[cc13920] | 6 |
|
---|
[909a015] | 7 | <!ENTITY ruby-download-http "http://cache.ruby-lang.org/pub/ruby/&ruby-minor-version;/ruby-&ruby-version;.tar.xz">
|
---|
[2f3226d] | 8 | <!ENTITY ruby-download-ftp " ">
|
---|
[c6afa0d] | 9 | <!ENTITY ruby-md5sum "a991f06ea1a1d421f7888c75f80f12d6">
|
---|
| 10 | <!ENTITY ruby-size "9.6 MB">
|
---|
| 11 | <!ENTITY ruby-buildsize "339 MB, with checks (add 212 MB for C API docs)">
|
---|
| 12 | <!ENTITY ruby-time "2.2 SBU (add 3.5 SBU for tests, add 0.4 SBU for C API docs)">
|
---|
[52d29f7] | 13 | ]>
|
---|
| 14 |
|
---|
[5db3785e] | 15 | <sect1 id="ruby" xreflabel="Ruby-&ruby-version;">
|
---|
[16f3afb3] | 16 | <?dbhtml filename="ruby.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>Ruby-&ruby-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="ruby">
|
---|
| 26 | <primary sortas="a-Ruby">Ruby</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to Ruby</title>
|
---|
| 31 |
|
---|
[cc13920] | 32 | <para>
|
---|
| 33 | The <application>Ruby</application> package contains the
|
---|
| 34 | <application>Ruby</application> development environment. This
|
---|
| 35 | is useful for object-oriented scripting.
|
---|
| 36 | </para>
|
---|
[16f3afb3] | 37 |
|
---|
[0e45aee] | 38 | &lfs81_checked;
|
---|
[a1813d08] | 39 |
|
---|
[16f3afb3] | 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
[cc13920] | 43 | <para>
|
---|
| 44 | Download (HTTP): <ulink url="&ruby-download-http;"/>
|
---|
| 45 | </para>
|
---|
[16f3afb3] | 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
[cc13920] | 48 | <para>
|
---|
| 49 | Download (FTP): <ulink url="&ruby-download-ftp;"/>
|
---|
| 50 | </para>
|
---|
[16f3afb3] | 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
[cc13920] | 53 | <para>
|
---|
| 54 | Download MD5 sum: &ruby-md5sum;
|
---|
| 55 | </para>
|
---|
[16f3afb3] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[cc13920] | 58 | <para>
|
---|
| 59 | Download size: &ruby-size;
|
---|
| 60 | </para>
|
---|
[16f3afb3] | 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
[cc13920] | 63 | <para>
|
---|
| 64 | Estimated disk space required: &ruby-buildsize;
|
---|
| 65 | </para>
|
---|
[16f3afb3] | 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
[cc13920] | 68 | <para>
|
---|
| 69 | Estimated build time: &ruby-time;
|
---|
| 70 | </para>
|
---|
[16f3afb3] | 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect3">Ruby Dependencies</bridgehead>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[955b7fd2] | 77 | <para role="optional">
|
---|
[82fac2c] | 78 | <xref linkend="db"/>,
|
---|
[955b7fd2] | 79 | <xref linkend="doxygen"/>,
|
---|
[cc13920] | 80 | <xref linkend="graphviz"/>,
|
---|
[248a536] | 81 | <xref linkend="openssl"/>,
|
---|
[6a71920c] | 82 | <xref linkend="tk"/>,
|
---|
| 83 | <xref linkend="valgrind"/>, and
|
---|
[b417f2a] | 84 | <xref linkend="yaml"/>
|
---|
[955b7fd2] | 85 | </para>
|
---|
[16f3afb3] | 86 |
|
---|
[1039de3] | 87 | <para condition="html" role="usernotes">User Notes:
|
---|
[cc13920] | 88 | <ulink url="&blfs-wiki;/ruby"/>
|
---|
| 89 | </para>
|
---|
[16f3afb3] | 90 | </sect2>
|
---|
| 91 |
|
---|
| 92 | <sect2 role="installation">
|
---|
| 93 | <title>Installation of Ruby</title>
|
---|
| 94 |
|
---|
[cc13920] | 95 | <para>
|
---|
| 96 | Install <application>Ruby</application> by running the following
|
---|
[75457cc] | 97 | command:
|
---|
[cc13920] | 98 | </para>
|
---|
[16f3afb3] | 99 |
|
---|
[9d4de3fb] | 100 | <screen><userinput>./configure --prefix=/usr \
|
---|
[b9d56ad4] | 101 | --enable-shared \
|
---|
[e02c1e3] | 102 | --docdir=/usr/share/doc/ruby-&ruby-version; &&
|
---|
| 103 | make</userinput></screen>
|
---|
[75457cc] | 104 |
|
---|
| 105 | <para>
|
---|
| 106 | Optionally, build the CAPI documents by running the following
|
---|
| 107 | commands:
|
---|
| 108 | </para>
|
---|
| 109 |
|
---|
[e02c1e3] | 110 | <screen><userinput>make capi</userinput></screen>
|
---|
[16f3afb3] | 111 |
|
---|
[cc13920] | 112 | <para>
|
---|
[c6afa0d] | 113 | To test the results, issue: <command>make check</command>. There
|
---|
| 114 | are 16949 tests. Several (about 20) fail and one test hangs, but
|
---|
| 115 | the test process can continue with ctrl-C.
|
---|
[cc13920] | 116 | </para>
|
---|
[40d6bab] | 117 |
|
---|
[cc13920] | 118 | <para>
|
---|
| 119 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 120 | </para>
|
---|
[16f3afb3] | 121 |
|
---|
| 122 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 123 |
|
---|
| 124 | </sect2>
|
---|
| 125 |
|
---|
| 126 | <sect2 role="commands">
|
---|
| 127 | <title>Command Explanations</title>
|
---|
| 128 |
|
---|
[b9d56ad4] | 129 | <para>
|
---|
| 130 | <parameter>--enable-shared</parameter>: This switch enables building of
|
---|
[cc13920] | 131 | the <filename class="libraryfile">libruby</filename> shared library.
|
---|
| 132 | </para>
|
---|
[16f3afb3] | 133 |
|
---|
[5d388f2] | 134 | <para>
|
---|
| 135 | <option>--disable-install-doc</option>: This switch disables building and
|
---|
| 136 | installing rdoc indexes and C API documents.
|
---|
| 137 | </para>
|
---|
| 138 |
|
---|
| 139 | <para>
|
---|
| 140 | <option>--disable-install-rdoc</option>: This switch disables building
|
---|
| 141 | and installing rdoc indexes.
|
---|
| 142 | </para>
|
---|
| 143 |
|
---|
| 144 | <para>
|
---|
| 145 | <option>--disable-install-capi</option>: This switch disables building
|
---|
| 146 | and installing C API documents.
|
---|
| 147 | </para>
|
---|
| 148 |
|
---|
[16f3afb3] | 149 | </sect2>
|
---|
| 150 |
|
---|
| 151 | <sect2 role="content">
|
---|
| 152 | <title>Contents</title>
|
---|
| 153 |
|
---|
| 154 | <segmentedlist>
|
---|
| 155 | <segtitle>Installed Programs</segtitle>
|
---|
| 156 | <segtitle>Installed Libraries</segtitle>
|
---|
| 157 | <segtitle>Installed Directories</segtitle>
|
---|
| 158 |
|
---|
| 159 | <seglistitem>
|
---|
[cc13920] | 160 | <seg>
|
---|
[8461a06] | 161 | erb, gem, irb, rake, rdoc, ri, and ruby
|
---|
[cc13920] | 162 | </seg>
|
---|
| 163 | <seg>
|
---|
[8461a06] | 164 | libruby.so and libruby-static.a
|
---|
[cc13920] | 165 | </seg>
|
---|
| 166 | <seg>
|
---|
[909a015] | 167 | /usr/include/ruby-&ruby-minor-version;.0
|
---|
[cc13920] | 168 | /usr/lib/ruby,
|
---|
[7cc1bcd] | 169 | /usr/share/doc/ruby-&ruby-version; and
|
---|
[cc13920] | 170 | /usr/share/ri
|
---|
| 171 | </seg>
|
---|
[16f3afb3] | 172 | </seglistitem>
|
---|
| 173 | </segmentedlist>
|
---|
| 174 |
|
---|
| 175 | <variablelist>
|
---|
| 176 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 177 | <?dbfo list-presentation="list"?>
|
---|
| 178 | <?dbhtml list-presentation="table"?>
|
---|
| 179 |
|
---|
[909a015] | 180 | <varlistentry id="erb">
|
---|
| 181 | <term><command>erb</command></term>
|
---|
[16f3afb3] | 182 | <listitem>
|
---|
[cc13920] | 183 | <para>
|
---|
[909a015] | 184 | is Tiny eRuby. It interprets a
|
---|
| 185 | <application>Ruby</application> code embedded text file.
|
---|
[cc13920] | 186 | </para>
|
---|
[909a015] | 187 | <indexterm zone="ruby erb">
|
---|
| 188 | <primary sortas="b-erb">erb</primary>
|
---|
| 189 | </indexterm>
|
---|
| 190 | </listitem>
|
---|
| 191 | </varlistentry>
|
---|
| 192 |
|
---|
| 193 | <varlistentry id="gem">
|
---|
| 194 | <term><command>gem</command></term>
|
---|
| 195 | <listitem>
|
---|
| 196 | <para>
|
---|
| 197 | command for RubyGems - a sophisticated package manager for
|
---|
| 198 | <application>Ruby</application>.
|
---|
| 199 | </para>
|
---|
| 200 | <indexterm zone="ruby gem">
|
---|
| 201 | <primary sortas="b-gem">gem</primary>
|
---|
[16f3afb3] | 202 | </indexterm>
|
---|
| 203 | </listitem>
|
---|
| 204 | </varlistentry>
|
---|
| 205 |
|
---|
| 206 | <varlistentry id="irb">
|
---|
| 207 | <term><command>irb</command></term>
|
---|
| 208 | <listitem>
|
---|
[cc13920] | 209 | <para>
|
---|
| 210 | is the interactive interface for
|
---|
| 211 | <application>Ruby</application>.
|
---|
| 212 | </para>
|
---|
[16f3afb3] | 213 | <indexterm zone="ruby irb">
|
---|
| 214 | <primary sortas="b-irb">irb</primary>
|
---|
| 215 | </indexterm>
|
---|
| 216 | </listitem>
|
---|
| 217 | </varlistentry>
|
---|
| 218 |
|
---|
[909a015] | 219 | <varlistentry id="rake">
|
---|
| 220 | <term><command>rake</command></term>
|
---|
[16f3afb3] | 221 | <listitem>
|
---|
[cc13920] | 222 | <para>
|
---|
[909a015] | 223 | a make-like build utility for <application>Ruby</application>.
|
---|
[cc13920] | 224 | </para>
|
---|
[909a015] | 225 | <indexterm zone="ruby rake">
|
---|
| 226 | <primary sortas="b-rake">rake</primary>
|
---|
| 227 | </indexterm>
|
---|
| 228 | </listitem>
|
---|
| 229 | </varlistentry>
|
---|
| 230 |
|
---|
| 231 | <varlistentry id="rdoc">
|
---|
| 232 | <term><command>rdoc</command></term>
|
---|
| 233 | <listitem>
|
---|
| 234 | <para>
|
---|
| 235 | generates <application>Ruby</application> documentation.
|
---|
| 236 | </para>
|
---|
| 237 | <indexterm zone="ruby rdoc">
|
---|
| 238 | <primary sortas="b-rdoc">rdoc</primary>
|
---|
[16f3afb3] | 239 | </indexterm>
|
---|
| 240 | </listitem>
|
---|
| 241 | </varlistentry>
|
---|
| 242 |
|
---|
| 243 | <varlistentry id="ri">
|
---|
| 244 | <term><command>ri</command></term>
|
---|
| 245 | <listitem>
|
---|
[cc13920] | 246 | <para>
|
---|
| 247 | displays documentation from a database on
|
---|
[00217270] | 248 | <application>Ruby</application> classes, modules, and methods.
|
---|
[cc13920] | 249 | </para>
|
---|
[16f3afb3] | 250 | <indexterm zone="ruby ri">
|
---|
| 251 | <primary sortas="b-ri">ri</primary>
|
---|
| 252 | </indexterm>
|
---|
| 253 | </listitem>
|
---|
| 254 | </varlistentry>
|
---|
| 255 |
|
---|
[909a015] | 256 | <varlistentry id="ruby-prog">
|
---|
| 257 | <term><command>ruby</command></term>
|
---|
| 258 | <listitem>
|
---|
| 259 | <para>
|
---|
| 260 | is an interpreted scripting language for quick
|
---|
| 261 | and easy object-oriented programming.
|
---|
| 262 | </para>
|
---|
| 263 | <indexterm zone="ruby ruby-prog">
|
---|
| 264 | <primary sortas="b-ruby">ruby</primary>
|
---|
| 265 | </indexterm>
|
---|
| 266 | </listitem>
|
---|
| 267 | </varlistentry>
|
---|
| 268 |
|
---|
[16f3afb3] | 269 | <varlistentry id="libruby">
|
---|
[92b0b42] | 270 | <term><filename role="libraryfile">libruby.so</filename></term>
|
---|
[16f3afb3] | 271 | <listitem>
|
---|
[cc13920] | 272 | <para>
|
---|
| 273 | contains the API functions required by <application>Ruby</application>.
|
---|
| 274 | </para>
|
---|
[16f3afb3] | 275 | <indexterm zone="ruby libruby">
|
---|
| 276 | <primary sortas="c-libruby">libruby.so</primary>
|
---|
| 277 | </indexterm>
|
---|
| 278 | </listitem>
|
---|
| 279 | </varlistentry>
|
---|
| 280 |
|
---|
| 281 | </variablelist>
|
---|
| 282 |
|
---|
| 283 | </sect2>
|
---|
[a1f7daa] | 284 |
|
---|
| 285 | </sect1>
|
---|