1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY ruby-download-http "http://cache.ruby-lang.org/pub/ruby/&ruby-minor-version;/ruby-&ruby-version;.tar.xz">
|
---|
8 | <!ENTITY ruby-download-ftp " ">
|
---|
9 | <!ENTITY ruby-md5sum "0b77dc26b379a0088be45488e0eda60c">
|
---|
10 | <!ENTITY ruby-size "11 MB">
|
---|
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)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="ruby" xreflabel="Ruby-&ruby-version;">
|
---|
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 |
|
---|
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>
|
---|
37 |
|
---|
38 | &lfs83_checked;
|
---|
39 |
|
---|
40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
41 | <itemizedlist spacing="compact">
|
---|
42 | <listitem>
|
---|
43 | <para>
|
---|
44 | Download (HTTP): <ulink url="&ruby-download-http;"/>
|
---|
45 | </para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>
|
---|
49 | Download (FTP): <ulink url="&ruby-download-ftp;"/>
|
---|
50 | </para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>
|
---|
54 | Download MD5 sum: &ruby-md5sum;
|
---|
55 | </para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>
|
---|
59 | Download size: &ruby-size;
|
---|
60 | </para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>
|
---|
64 | Estimated disk space required: &ruby-buildsize;
|
---|
65 | </para>
|
---|
66 | </listitem>
|
---|
67 | <listitem>
|
---|
68 | <para>
|
---|
69 | Estimated build time: &ruby-time;
|
---|
70 | </para>
|
---|
71 | </listitem>
|
---|
72 | </itemizedlist>
|
---|
73 |
|
---|
74 | <bridgehead renderas="sect3">Ruby Dependencies</bridgehead>
|
---|
75 |
|
---|
76 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
77 | <para role="optional">
|
---|
78 | <xref linkend="db"/>,
|
---|
79 | <xref linkend="doxygen"/>,
|
---|
80 | <xref linkend="graphviz"/>,
|
---|
81 | <xref linkend="tk"/>,
|
---|
82 | <xref linkend="valgrind"/>, and
|
---|
83 | <xref linkend="yaml"/>
|
---|
84 | </para>
|
---|
85 |
|
---|
86 | <para condition="html" role="usernotes">User Notes:
|
---|
87 | <ulink url="&blfs-wiki;/ruby"/>
|
---|
88 | </para>
|
---|
89 | </sect2>
|
---|
90 |
|
---|
91 | <sect2 role="installation">
|
---|
92 | <title>Installation of Ruby</title>
|
---|
93 |
|
---|
94 | <para>
|
---|
95 | Install <application>Ruby</application> by running the following
|
---|
96 | command:
|
---|
97 | </para>
|
---|
98 |
|
---|
99 | <screen><userinput>./configure --prefix=/usr \
|
---|
100 | --enable-shared \
|
---|
101 | --docdir=/usr/share/doc/ruby-&ruby-version; &&
|
---|
102 | make</userinput></screen>
|
---|
103 |
|
---|
104 | <para>
|
---|
105 | Optionally, build the CAPI documents by running the following
|
---|
106 | commands:
|
---|
107 | </para>
|
---|
108 |
|
---|
109 | <screen><userinput>make capi</userinput></screen>
|
---|
110 |
|
---|
111 | <para>
|
---|
112 | To test the results, issue: <command>make check</command>. There
|
---|
113 | are 17393 tests. A few (two) fail.
|
---|
114 | If the tests are
|
---|
115 | run in a directory that has a world writable component (e.g. /tmp)
|
---|
116 | then several additional tests may fail and the tests terminate after
|
---|
117 | 25 failures.
|
---|
118 | </para>
|
---|
119 |
|
---|
120 | <para>
|
---|
121 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
122 | </para>
|
---|
123 |
|
---|
124 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
125 |
|
---|
126 | </sect2>
|
---|
127 |
|
---|
128 | <sect2 role="commands">
|
---|
129 | <title>Command Explanations</title>
|
---|
130 |
|
---|
131 | <para>
|
---|
132 | <parameter>--enable-shared</parameter>: This switch enables building of
|
---|
133 | the <filename class="libraryfile">libruby</filename> shared library.
|
---|
134 | </para>
|
---|
135 |
|
---|
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 |
|
---|
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>
|
---|
162 | <seg>
|
---|
163 | erb, gem, irb, rake, rdoc, ri, and ruby
|
---|
164 | </seg>
|
---|
165 | <seg>
|
---|
166 | libruby.so and libruby-static.a
|
---|
167 | </seg>
|
---|
168 | <seg>
|
---|
169 | /usr/include/ruby-&ruby-minor-version;.0
|
---|
170 | /usr/lib/ruby,
|
---|
171 | /usr/share/doc/ruby-&ruby-version; and
|
---|
172 | /usr/share/ri
|
---|
173 | </seg>
|
---|
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 |
|
---|
182 | <varlistentry id="erb">
|
---|
183 | <term><command>erb</command></term>
|
---|
184 | <listitem>
|
---|
185 | <para>
|
---|
186 | is Tiny eRuby. It interprets a
|
---|
187 | <application>Ruby</application> code embedded text file.
|
---|
188 | </para>
|
---|
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>
|
---|
204 | </indexterm>
|
---|
205 | </listitem>
|
---|
206 | </varlistentry>
|
---|
207 |
|
---|
208 | <varlistentry id="irb">
|
---|
209 | <term><command>irb</command></term>
|
---|
210 | <listitem>
|
---|
211 | <para>
|
---|
212 | is the interactive interface for
|
---|
213 | <application>Ruby</application>.
|
---|
214 | </para>
|
---|
215 | <indexterm zone="ruby irb">
|
---|
216 | <primary sortas="b-irb">irb</primary>
|
---|
217 | </indexterm>
|
---|
218 | </listitem>
|
---|
219 | </varlistentry>
|
---|
220 |
|
---|
221 | <varlistentry id="rake">
|
---|
222 | <term><command>rake</command></term>
|
---|
223 | <listitem>
|
---|
224 | <para>
|
---|
225 | a make-like build utility for <application>Ruby</application>.
|
---|
226 | </para>
|
---|
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>
|
---|
241 | </indexterm>
|
---|
242 | </listitem>
|
---|
243 | </varlistentry>
|
---|
244 |
|
---|
245 | <varlistentry id="ri">
|
---|
246 | <term><command>ri</command></term>
|
---|
247 | <listitem>
|
---|
248 | <para>
|
---|
249 | displays documentation from a database on
|
---|
250 | <application>Ruby</application> classes, modules, and methods.
|
---|
251 | </para>
|
---|
252 | <indexterm zone="ruby ri">
|
---|
253 | <primary sortas="b-ri">ri</primary>
|
---|
254 | </indexterm>
|
---|
255 | </listitem>
|
---|
256 | </varlistentry>
|
---|
257 |
|
---|
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 |
|
---|
271 | <varlistentry id="libruby">
|
---|
272 | <term><filename role="libraryfile">libruby.so</filename></term>
|
---|
273 | <listitem>
|
---|
274 | <para>
|
---|
275 | contains the API functions required by <application>Ruby</application>.
|
---|
276 | </para>
|
---|
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>
|
---|
286 |
|
---|
287 | </sect1>
|
---|