[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 " ">
|
---|
[1855ac33] | 9 | <!ENTITY ruby-md5sum "0b77dc26b379a0088be45488e0eda60c">
|
---|
[b0c65e84] | 10 | <!ENTITY ruby-size "11 MB">
|
---|
[1855ac33] | 11 | <!ENTITY ruby-buildsize "412 MB, with checks (add 240 MB for C API docs)">
|
---|
| 12 | <!ENTITY ruby-time "1.2 SBU (using parallelism=4; add 3.5 SBU for tests; add 0.5 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 |
|
---|
[49a84b87] | 38 | &lfs83_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"/>,
|
---|
[6a71920c] | 81 | <xref linkend="tk"/>,
|
---|
| 82 | <xref linkend="valgrind"/>, and
|
---|
[b417f2a] | 83 | <xref linkend="yaml"/>
|
---|
[955b7fd2] | 84 | </para>
|
---|
[16f3afb3] | 85 |
|
---|
[1039de3] | 86 | <para condition="html" role="usernotes">User Notes:
|
---|
[cc13920] | 87 | <ulink url="&blfs-wiki;/ruby"/>
|
---|
| 88 | </para>
|
---|
[16f3afb3] | 89 | </sect2>
|
---|
| 90 |
|
---|
| 91 | <sect2 role="installation">
|
---|
| 92 | <title>Installation of Ruby</title>
|
---|
| 93 |
|
---|
[cc13920] | 94 | <para>
|
---|
| 95 | Install <application>Ruby</application> by running the following
|
---|
[75457cc] | 96 | command:
|
---|
[cc13920] | 97 | </para>
|
---|
[16f3afb3] | 98 |
|
---|
[9d4de3fb] | 99 | <screen><userinput>./configure --prefix=/usr \
|
---|
[b9d56ad4] | 100 | --enable-shared \
|
---|
[e02c1e3] | 101 | --docdir=/usr/share/doc/ruby-&ruby-version; &&
|
---|
| 102 | make</userinput></screen>
|
---|
[75457cc] | 103 |
|
---|
| 104 | <para>
|
---|
| 105 | Optionally, build the CAPI documents by running the following
|
---|
| 106 | commands:
|
---|
| 107 | </para>
|
---|
| 108 |
|
---|
[e02c1e3] | 109 | <screen><userinput>make capi</userinput></screen>
|
---|
[16f3afb3] | 110 |
|
---|
[cc13920] | 111 | <para>
|
---|
[c6afa0d] | 112 | To test the results, issue: <command>make check</command>. There
|
---|
[15fb148] | 113 | are 17393 tests. A few (two) fail.
|
---|
| 114 | If the tests are
|
---|
[b548e98] | 115 | run in a directory that has a world writable component (e.g. /tmp)
|
---|
[15fb148] | 116 | then several additional tests may fail and the tests terminate after
|
---|
[7b45a275] | 117 | 25 failures.
|
---|
[cc13920] | 118 | </para>
|
---|
[40d6bab] | 119 |
|
---|
[cc13920] | 120 | <para>
|
---|
| 121 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 122 | </para>
|
---|
[16f3afb3] | 123 |
|
---|
| 124 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 125 |
|
---|
| 126 | </sect2>
|
---|
| 127 |
|
---|
| 128 | <sect2 role="commands">
|
---|
| 129 | <title>Command Explanations</title>
|
---|
| 130 |
|
---|
[b9d56ad4] | 131 | <para>
|
---|
| 132 | <parameter>--enable-shared</parameter>: This switch enables building of
|
---|
[cc13920] | 133 | the <filename class="libraryfile">libruby</filename> shared library.
|
---|
| 134 | </para>
|
---|
[16f3afb3] | 135 |
|
---|
[5d388f2] | 136 | <para>
|
---|
| 137 | <option>--disable-install-doc</option>: This switch disables building and
|
---|
| 138 | installing rdoc indexes and C API documents.
|
---|
| 139 | </para>
|
---|
| 140 |
|
---|
| 141 | <para>
|
---|
| 142 | <option>--disable-install-rdoc</option>: This switch disables building
|
---|
| 143 | and installing rdoc indexes.
|
---|
| 144 | </para>
|
---|
| 145 |
|
---|
| 146 | <para>
|
---|
| 147 | <option>--disable-install-capi</option>: This switch disables building
|
---|
| 148 | and installing C API documents.
|
---|
| 149 | </para>
|
---|
| 150 |
|
---|
[16f3afb3] | 151 | </sect2>
|
---|
| 152 |
|
---|
| 153 | <sect2 role="content">
|
---|
| 154 | <title>Contents</title>
|
---|
| 155 |
|
---|
| 156 | <segmentedlist>
|
---|
| 157 | <segtitle>Installed Programs</segtitle>
|
---|
| 158 | <segtitle>Installed Libraries</segtitle>
|
---|
| 159 | <segtitle>Installed Directories</segtitle>
|
---|
| 160 |
|
---|
| 161 | <seglistitem>
|
---|
[cc13920] | 162 | <seg>
|
---|
[8461a06] | 163 | erb, gem, irb, rake, rdoc, ri, and ruby
|
---|
[cc13920] | 164 | </seg>
|
---|
| 165 | <seg>
|
---|
[8461a06] | 166 | libruby.so and libruby-static.a
|
---|
[cc13920] | 167 | </seg>
|
---|
| 168 | <seg>
|
---|
[909a015] | 169 | /usr/include/ruby-&ruby-minor-version;.0
|
---|
[cc13920] | 170 | /usr/lib/ruby,
|
---|
[7cc1bcd] | 171 | /usr/share/doc/ruby-&ruby-version; and
|
---|
[cc13920] | 172 | /usr/share/ri
|
---|
| 173 | </seg>
|
---|
[16f3afb3] | 174 | </seglistitem>
|
---|
| 175 | </segmentedlist>
|
---|
| 176 |
|
---|
| 177 | <variablelist>
|
---|
| 178 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 179 | <?dbfo list-presentation="list"?>
|
---|
| 180 | <?dbhtml list-presentation="table"?>
|
---|
| 181 |
|
---|
[909a015] | 182 | <varlistentry id="erb">
|
---|
| 183 | <term><command>erb</command></term>
|
---|
[16f3afb3] | 184 | <listitem>
|
---|
[cc13920] | 185 | <para>
|
---|
[909a015] | 186 | is Tiny eRuby. It interprets a
|
---|
| 187 | <application>Ruby</application> code embedded text file.
|
---|
[cc13920] | 188 | </para>
|
---|
[909a015] | 189 | <indexterm zone="ruby erb">
|
---|
| 190 | <primary sortas="b-erb">erb</primary>
|
---|
| 191 | </indexterm>
|
---|
| 192 | </listitem>
|
---|
| 193 | </varlistentry>
|
---|
| 194 |
|
---|
| 195 | <varlistentry id="gem">
|
---|
| 196 | <term><command>gem</command></term>
|
---|
| 197 | <listitem>
|
---|
| 198 | <para>
|
---|
| 199 | command for RubyGems - a sophisticated package manager for
|
---|
| 200 | <application>Ruby</application>.
|
---|
| 201 | </para>
|
---|
| 202 | <indexterm zone="ruby gem">
|
---|
| 203 | <primary sortas="b-gem">gem</primary>
|
---|
[16f3afb3] | 204 | </indexterm>
|
---|
| 205 | </listitem>
|
---|
| 206 | </varlistentry>
|
---|
| 207 |
|
---|
| 208 | <varlistentry id="irb">
|
---|
| 209 | <term><command>irb</command></term>
|
---|
| 210 | <listitem>
|
---|
[cc13920] | 211 | <para>
|
---|
| 212 | is the interactive interface for
|
---|
| 213 | <application>Ruby</application>.
|
---|
| 214 | </para>
|
---|
[16f3afb3] | 215 | <indexterm zone="ruby irb">
|
---|
| 216 | <primary sortas="b-irb">irb</primary>
|
---|
| 217 | </indexterm>
|
---|
| 218 | </listitem>
|
---|
| 219 | </varlistentry>
|
---|
| 220 |
|
---|
[909a015] | 221 | <varlistentry id="rake">
|
---|
| 222 | <term><command>rake</command></term>
|
---|
[16f3afb3] | 223 | <listitem>
|
---|
[cc13920] | 224 | <para>
|
---|
[909a015] | 225 | a make-like build utility for <application>Ruby</application>.
|
---|
[cc13920] | 226 | </para>
|
---|
[909a015] | 227 | <indexterm zone="ruby rake">
|
---|
| 228 | <primary sortas="b-rake">rake</primary>
|
---|
| 229 | </indexterm>
|
---|
| 230 | </listitem>
|
---|
| 231 | </varlistentry>
|
---|
| 232 |
|
---|
| 233 | <varlistentry id="rdoc">
|
---|
| 234 | <term><command>rdoc</command></term>
|
---|
| 235 | <listitem>
|
---|
| 236 | <para>
|
---|
| 237 | generates <application>Ruby</application> documentation.
|
---|
| 238 | </para>
|
---|
| 239 | <indexterm zone="ruby rdoc">
|
---|
| 240 | <primary sortas="b-rdoc">rdoc</primary>
|
---|
[16f3afb3] | 241 | </indexterm>
|
---|
| 242 | </listitem>
|
---|
| 243 | </varlistentry>
|
---|
| 244 |
|
---|
| 245 | <varlistentry id="ri">
|
---|
| 246 | <term><command>ri</command></term>
|
---|
| 247 | <listitem>
|
---|
[cc13920] | 248 | <para>
|
---|
| 249 | displays documentation from a database on
|
---|
[00217270] | 250 | <application>Ruby</application> classes, modules, and methods.
|
---|
[cc13920] | 251 | </para>
|
---|
[16f3afb3] | 252 | <indexterm zone="ruby ri">
|
---|
| 253 | <primary sortas="b-ri">ri</primary>
|
---|
| 254 | </indexterm>
|
---|
| 255 | </listitem>
|
---|
| 256 | </varlistentry>
|
---|
| 257 |
|
---|
[909a015] | 258 | <varlistentry id="ruby-prog">
|
---|
| 259 | <term><command>ruby</command></term>
|
---|
| 260 | <listitem>
|
---|
| 261 | <para>
|
---|
| 262 | is an interpreted scripting language for quick
|
---|
| 263 | and easy object-oriented programming.
|
---|
| 264 | </para>
|
---|
| 265 | <indexterm zone="ruby ruby-prog">
|
---|
| 266 | <primary sortas="b-ruby">ruby</primary>
|
---|
| 267 | </indexterm>
|
---|
| 268 | </listitem>
|
---|
| 269 | </varlistentry>
|
---|
| 270 |
|
---|
[16f3afb3] | 271 | <varlistentry id="libruby">
|
---|
[92b0b42] | 272 | <term><filename role="libraryfile">libruby.so</filename></term>
|
---|
[16f3afb3] | 273 | <listitem>
|
---|
[cc13920] | 274 | <para>
|
---|
| 275 | contains the API functions required by <application>Ruby</application>.
|
---|
| 276 | </para>
|
---|
[16f3afb3] | 277 | <indexterm zone="ruby libruby">
|
---|
| 278 | <primary sortas="c-libruby">libruby.so</primary>
|
---|
| 279 | </indexterm>
|
---|
| 280 | </listitem>
|
---|
| 281 | </varlistentry>
|
---|
| 282 |
|
---|
| 283 | </variablelist>
|
---|
| 284 |
|
---|
| 285 | </sect2>
|
---|
[a1f7daa] | 286 |
|
---|
| 287 | </sect1>
|
---|