[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 |
|
---|
[c6b192c] | 7 | <!ENTITY ruby-download-http "https://cache.ruby-lang.org/pub/ruby/&ruby-minor-version;/ruby-&ruby-version;.tar.xz">
|
---|
[2f3226d] | 8 | <!ENTITY ruby-download-ftp " ">
|
---|
[09cf41d5] | 9 | <!ENTITY ruby-md5sum "e2c35af69d1f94e8634f38c80e809c0d">
|
---|
[e4c4af6] | 10 | <!ENTITY ruby-size "14 MB">
|
---|
[09cf41d5] | 11 | <!ENTITY ruby-buildsize "612 MB (add 1.1 GB for C API docs)">
|
---|
| 12 | <!ENTITY ruby-time "2.2 SBU (using parallelism=4; add 7.5 SBU for tests; add 0.8 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 | <date>$Date$</date>
|
---|
| 20 | </sect1info>
|
---|
| 21 |
|
---|
| 22 | <title>Ruby-&ruby-version;</title>
|
---|
| 23 |
|
---|
| 24 | <indexterm zone="ruby">
|
---|
| 25 | <primary sortas="a-Ruby">Ruby</primary>
|
---|
| 26 | </indexterm>
|
---|
| 27 |
|
---|
| 28 | <sect2 role="package">
|
---|
| 29 | <title>Introduction to Ruby</title>
|
---|
| 30 |
|
---|
[cc13920] | 31 | <para>
|
---|
| 32 | The <application>Ruby</application> package contains the
|
---|
| 33 | <application>Ruby</application> development environment. This
|
---|
| 34 | is useful for object-oriented scripting.
|
---|
| 35 | </para>
|
---|
[16f3afb3] | 36 |
|
---|
[8b225938] | 37 | &lfs112_checked;
|
---|
[a1813d08] | 38 |
|
---|
[16f3afb3] | 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
[cc13920] | 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&ruby-download-http;"/>
|
---|
| 44 | </para>
|
---|
[16f3afb3] | 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
[cc13920] | 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&ruby-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
[16f3afb3] | 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
[cc13920] | 52 | <para>
|
---|
| 53 | Download MD5 sum: &ruby-md5sum;
|
---|
| 54 | </para>
|
---|
[16f3afb3] | 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
[cc13920] | 57 | <para>
|
---|
| 58 | Download size: &ruby-size;
|
---|
| 59 | </para>
|
---|
[16f3afb3] | 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
[cc13920] | 62 | <para>
|
---|
| 63 | Estimated disk space required: &ruby-buildsize;
|
---|
| 64 | </para>
|
---|
[16f3afb3] | 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
[cc13920] | 67 | <para>
|
---|
| 68 | Estimated build time: &ruby-time;
|
---|
| 69 | </para>
|
---|
[16f3afb3] | 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect3">Ruby Dependencies</bridgehead>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[955b7fd2] | 76 | <para role="optional">
|
---|
[82fac2c] | 77 | <xref linkend="db"/>,
|
---|
[955b7fd2] | 78 | <xref linkend="doxygen"/>,
|
---|
[cc13920] | 79 | <xref linkend="graphviz"/>,
|
---|
[b738ceb] | 80 | <xref linkend="libyaml"/>,
|
---|
[d28648d] | 81 | <xref linkend="tk"/>,
|
---|
| 82 | <xref linkend="valgrind"/>, and
|
---|
| 83 | <ulink url="http://dtrace.org/blogs/about/">DTrace</ulink>
|
---|
[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>
|
---|
[e6b445c] | 112 | To test the results, issue: <command>make check</command>. There are over
|
---|
[372597e] | 113 | 21,000 tests. Some tests related to ipv6 may indicate errors. If the
|
---|
| 114 | tests are run in a directory that has a world writable component (e.g.
|
---|
[c6d1a80c] | 115 | /tmp) then several additional tests may fail. A few tests may fail due
|
---|
[e4c4af6] | 116 | to system configuration expectations.
|
---|
[cc13920] | 117 | </para>
|
---|
[8558044] | 118 | <!-- With 3.0.2:
|
---|
[e6b445c] | 119 | Finished tests in 443.541527s, 47.5739 tests/s, 6031.9921 assertions/s. 21101 tests, 2675439 assertions, 4 failures, 1 errors, 45 skips -->
|
---|
[40d6bab] | 120 |
|
---|
[cc13920] | 121 | <para>
|
---|
| 122 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 123 | </para>
|
---|
[16f3afb3] | 124 |
|
---|
| 125 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 126 |
|
---|
| 127 | </sect2>
|
---|
| 128 |
|
---|
| 129 | <sect2 role="commands">
|
---|
| 130 | <title>Command Explanations</title>
|
---|
| 131 |
|
---|
[b9d56ad4] | 132 | <para>
|
---|
[0771e2f] | 133 | <parameter>--enable-shared</parameter>: This switch enables building
|
---|
[cc13920] | 134 | the <filename class="libraryfile">libruby</filename> shared library.
|
---|
| 135 | </para>
|
---|
[16f3afb3] | 136 |
|
---|
[5d388f2] | 137 | <para>
|
---|
| 138 | <option>--disable-install-doc</option>: This switch disables building and
|
---|
| 139 | installing rdoc indexes and C API documents.
|
---|
| 140 | </para>
|
---|
| 141 |
|
---|
| 142 | <para>
|
---|
| 143 | <option>--disable-install-rdoc</option>: This switch disables building
|
---|
| 144 | and installing rdoc indexes.
|
---|
| 145 | </para>
|
---|
| 146 |
|
---|
| 147 | <para>
|
---|
| 148 | <option>--disable-install-capi</option>: This switch disables building
|
---|
| 149 | and installing C API documents.
|
---|
| 150 | </para>
|
---|
| 151 |
|
---|
[16f3afb3] | 152 | </sect2>
|
---|
| 153 |
|
---|
| 154 | <sect2 role="content">
|
---|
| 155 | <title>Contents</title>
|
---|
| 156 |
|
---|
| 157 | <segmentedlist>
|
---|
| 158 | <segtitle>Installed Programs</segtitle>
|
---|
| 159 | <segtitle>Installed Libraries</segtitle>
|
---|
| 160 | <segtitle>Installed Directories</segtitle>
|
---|
| 161 |
|
---|
| 162 | <seglistitem>
|
---|
[cc13920] | 163 | <seg>
|
---|
[8558044] | 164 | bundle,
|
---|
| 165 | bundler,
|
---|
| 166 | erb,
|
---|
| 167 | gem,
|
---|
| 168 | irb,
|
---|
| 169 | racc,
|
---|
| 170 | rake,
|
---|
| 171 | rbs,
|
---|
[6b8f495] | 172 | rdbg,
|
---|
[8558044] | 173 | rdoc,
|
---|
| 174 | ri,
|
---|
[e4c4af6] | 175 | ruby, and
|
---|
| 176 | typeprof
|
---|
[cc13920] | 177 | </seg>
|
---|
| 178 | <seg>
|
---|
[d28648d] | 179 | libruby.so
|
---|
[cc13920] | 180 | </seg>
|
---|
| 181 | <seg>
|
---|
[6b8f495] | 182 | /usr/include/ruby-&ruby-minor-version;.0,
|
---|
[cc13920] | 183 | /usr/lib/ruby,
|
---|
[7cc1bcd] | 184 | /usr/share/doc/ruby-&ruby-version; and
|
---|
[cc13920] | 185 | /usr/share/ri
|
---|
| 186 | </seg>
|
---|
[16f3afb3] | 187 | </seglistitem>
|
---|
| 188 | </segmentedlist>
|
---|
| 189 |
|
---|
| 190 | <variablelist>
|
---|
| 191 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 192 | <?dbfo list-presentation="list"?>
|
---|
| 193 | <?dbhtml list-presentation="table"?>
|
---|
| 194 |
|
---|
[d28648d] | 195 | <varlistentry id="bundle">
|
---|
| 196 | <term><command>bundle</command></term>
|
---|
| 197 | <listitem>
|
---|
| 198 | <para>
|
---|
[4c24eb0a] | 199 | creates bundles of Ruby Gems
|
---|
[d28648d] | 200 | </para>
|
---|
| 201 | <indexterm zone="ruby bundle">
|
---|
| 202 | <primary sortas="b-bundle">bundle</primary>
|
---|
| 203 | </indexterm>
|
---|
| 204 | </listitem>
|
---|
| 205 | </varlistentry>
|
---|
| 206 |
|
---|
| 207 | <varlistentry id="bundler">
|
---|
| 208 | <term><command>bundler</command></term>
|
---|
| 209 | <listitem>
|
---|
| 210 | <para>
|
---|
[4c24eb0a] | 211 | manages an application's dependencies throughout it's lifecycle
|
---|
[d28648d] | 212 | </para>
|
---|
| 213 | <indexterm zone="ruby bundler">
|
---|
| 214 | <primary sortas="b-bundler">bundler</primary>
|
---|
| 215 | </indexterm>
|
---|
| 216 | </listitem>
|
---|
| 217 | </varlistentry>
|
---|
| 218 |
|
---|
[909a015] | 219 | <varlistentry id="erb">
|
---|
| 220 | <term><command>erb</command></term>
|
---|
[16f3afb3] | 221 | <listitem>
|
---|
[cc13920] | 222 | <para>
|
---|
[0771e2f] | 223 | is a command line front-end for eRuby, which provides a templating
|
---|
| 224 | system for <application>Ruby</application>
|
---|
[cc13920] | 225 | </para>
|
---|
[909a015] | 226 | <indexterm zone="ruby erb">
|
---|
| 227 | <primary sortas="b-erb">erb</primary>
|
---|
| 228 | </indexterm>
|
---|
| 229 | </listitem>
|
---|
| 230 | </varlistentry>
|
---|
| 231 |
|
---|
| 232 | <varlistentry id="gem">
|
---|
| 233 | <term><command>gem</command></term>
|
---|
| 234 | <listitem>
|
---|
| 235 | <para>
|
---|
[0771e2f] | 236 | is the command for RubyGems, which is a sophisticated package
|
---|
| 237 | manager for <application>Ruby</application>. This is similar
|
---|
| 238 | to Python's 'pip' command
|
---|
[909a015] | 239 | </para>
|
---|
| 240 | <indexterm zone="ruby gem">
|
---|
| 241 | <primary sortas="b-gem">gem</primary>
|
---|
[16f3afb3] | 242 | </indexterm>
|
---|
| 243 | </listitem>
|
---|
| 244 | </varlistentry>
|
---|
| 245 |
|
---|
| 246 | <varlistentry id="irb">
|
---|
| 247 | <term><command>irb</command></term>
|
---|
| 248 | <listitem>
|
---|
[cc13920] | 249 | <para>
|
---|
| 250 | is the interactive interface for
|
---|
[4c24eb0a] | 251 | <application>Ruby</application>
|
---|
[cc13920] | 252 | </para>
|
---|
[16f3afb3] | 253 | <indexterm zone="ruby irb">
|
---|
| 254 | <primary sortas="b-irb">irb</primary>
|
---|
| 255 | </indexterm>
|
---|
| 256 | </listitem>
|
---|
| 257 | </varlistentry>
|
---|
| 258 |
|
---|
[909a015] | 259 | <varlistentry id="rake">
|
---|
| 260 | <term><command>rake</command></term>
|
---|
[16f3afb3] | 261 | <listitem>
|
---|
[cc13920] | 262 | <para>
|
---|
[0771e2f] | 263 | is a make-like build utility for <application>Ruby</application>
|
---|
[cc13920] | 264 | </para>
|
---|
[909a015] | 265 | <indexterm zone="ruby rake">
|
---|
| 266 | <primary sortas="b-rake">rake</primary>
|
---|
| 267 | </indexterm>
|
---|
| 268 | </listitem>
|
---|
| 269 | </varlistentry>
|
---|
| 270 |
|
---|
[6b8f495] | 271 | <varlistentry id="rdbg">
|
---|
| 272 | <term><command>rdbg</command></term>
|
---|
| 273 | <listitem>
|
---|
| 274 | <para>
|
---|
| 275 | is an interactive debugger for <application>Ruby</application>
|
---|
| 276 | </para>
|
---|
| 277 | <indexterm zone="ruby rdbg">
|
---|
| 278 | <primary sortas="b-rdbg">rdbg</primary>
|
---|
| 279 | </indexterm>
|
---|
| 280 | </listitem>
|
---|
| 281 | </varlistentry>
|
---|
| 282 |
|
---|
[909a015] | 283 | <varlistentry id="rdoc">
|
---|
| 284 | <term><command>rdoc</command></term>
|
---|
| 285 | <listitem>
|
---|
| 286 | <para>
|
---|
[4c24eb0a] | 287 | generates <application>Ruby</application> documentation
|
---|
[909a015] | 288 | </para>
|
---|
| 289 | <indexterm zone="ruby rdoc">
|
---|
| 290 | <primary sortas="b-rdoc">rdoc</primary>
|
---|
[16f3afb3] | 291 | </indexterm>
|
---|
| 292 | </listitem>
|
---|
| 293 | </varlistentry>
|
---|
| 294 |
|
---|
| 295 | <varlistentry id="ri">
|
---|
| 296 | <term><command>ri</command></term>
|
---|
| 297 | <listitem>
|
---|
[cc13920] | 298 | <para>
|
---|
| 299 | displays documentation from a database on
|
---|
[4c24eb0a] | 300 | <application>Ruby</application> classes, modules, and methods
|
---|
[cc13920] | 301 | </para>
|
---|
[16f3afb3] | 302 | <indexterm zone="ruby ri">
|
---|
| 303 | <primary sortas="b-ri">ri</primary>
|
---|
| 304 | </indexterm>
|
---|
| 305 | </listitem>
|
---|
| 306 | </varlistentry>
|
---|
| 307 |
|
---|
[909a015] | 308 | <varlistentry id="ruby-prog">
|
---|
| 309 | <term><command>ruby</command></term>
|
---|
| 310 | <listitem>
|
---|
| 311 | <para>
|
---|
| 312 | is an interpreted scripting language for quick
|
---|
[4c24eb0a] | 313 | and easy object-oriented programming
|
---|
[909a015] | 314 | </para>
|
---|
| 315 | <indexterm zone="ruby ruby-prog">
|
---|
| 316 | <primary sortas="b-ruby">ruby</primary>
|
---|
| 317 | </indexterm>
|
---|
| 318 | </listitem>
|
---|
| 319 | </varlistentry>
|
---|
| 320 |
|
---|
[16f3afb3] | 321 | <varlistentry id="libruby">
|
---|
[92b0b42] | 322 | <term><filename role="libraryfile">libruby.so</filename></term>
|
---|
[16f3afb3] | 323 | <listitem>
|
---|
[cc13920] | 324 | <para>
|
---|
[4c24eb0a] | 325 | contains the API functions required by <application>Ruby</application>
|
---|
[cc13920] | 326 | </para>
|
---|
[16f3afb3] | 327 | <indexterm zone="ruby libruby">
|
---|
| 328 | <primary sortas="c-libruby">libruby.so</primary>
|
---|
| 329 | </indexterm>
|
---|
| 330 | </listitem>
|
---|
| 331 | </varlistentry>
|
---|
| 332 |
|
---|
| 333 | </variablelist>
|
---|
| 334 |
|
---|
| 335 | </sect2>
|
---|
[a1f7daa] | 336 |
|
---|
| 337 | </sect1>
|
---|