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