source: general/prog/ruby.xml

trunk
Last change on this file was c86d663, checked in by Bruce Dubbs <bdubbs@…>, 3 days ago

Package updates.
Update to git-2.34.1.
Update to ruby-3.0.3.
Update to libsoup-2.74.2.
Update to mercurial-6.0.

  • Property mode set to 100644
File size: 9.1 KB
Line 
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 "https://cache.ruby-lang.org/pub/ruby/&ruby-minor-version;/ruby-&ruby-version;.tar.xz">
8 <!ENTITY ruby-download-ftp " ">
9 <!ENTITY ruby-md5sum "7b770258fc3e1fafc5a8552212cb00e5">
10 <!ENTITY ruby-size "14 MB">
11 <!ENTITY ruby-buildsize "577 MB (add 532 MB for C API docs)">
12 <!ENTITY ruby-time "1.5 SBU (using parallelism=4; add 4.9 SBU for tests; add 0.8 SBU for C API docs)">
13]>
14
15<sect1 id="ruby" xreflabel="Ruby-&ruby-version;">
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
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>
36
37 &lfs110a_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>
43 Download (HTTP): <ulink url="&ruby-download-http;"/>
44 </para>
45 </listitem>
46 <listitem>
47 <para>
48 Download (FTP): <ulink url="&ruby-download-ftp;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download MD5 sum: &ruby-md5sum;
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download size: &ruby-size;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Estimated disk space required: &ruby-buildsize;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated build time: &ruby-time;
69 </para>
70 </listitem>
71 </itemizedlist>
72
73 <bridgehead renderas="sect3">Ruby Dependencies</bridgehead>
74
75 <bridgehead renderas="sect4">Optional</bridgehead>
76 <para role="optional">
77 <xref linkend="db"/>,
78 <xref linkend="doxygen"/>,
79 <xref linkend="graphviz"/>,
80 <xref linkend="libyaml"/>,
81 <xref linkend="tk"/>,
82 <xref linkend="valgrind"/>, and
83 <ulink url="http://dtrace.org/blogs/about/">DTrace</ulink>
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; &amp;&amp;
102make</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 are over
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.
115 /tmp) then several additional tests may fail. A few tests may fail due
116 to system configuration expectations.
117 </para>
118<!-- With 3.0.2:
119Finished tests in 443.541527s, 47.5739 tests/s, 6031.9921 assertions/s. 21101 tests, 2675439 assertions, 4 failures, 1 errors, 45 skips -->
120
121 <para>
122 Now, as the <systemitem class="username">root</systemitem> user:
123 </para>
124
125<screen role="root"><userinput>make install</userinput></screen>
126
127 </sect2>
128
129 <sect2 role="commands">
130 <title>Command Explanations</title>
131
132 <para>
133 <parameter>--enable-shared</parameter>: This switch enables building of
134 the <filename class="libraryfile">libruby</filename> shared library.
135 </para>
136
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
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>
163 <seg>
164 bundle,
165 bundler,
166 erb,
167 gem,
168 irb,
169 racc,
170 rake,
171 rbs,
172 rdoc,
173 ri,
174 ruby, and
175 typeprof
176 </seg>
177 <seg>
178 libruby.so
179 </seg>
180 <seg>
181 /usr/include/ruby-&ruby-minor-version;.0
182 /usr/lib/ruby,
183 /usr/share/doc/ruby-&ruby-version; and
184 /usr/share/ri
185 </seg>
186 </seglistitem>
187 </segmentedlist>
188
189 <variablelist>
190 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
191 <?dbfo list-presentation="list"?>
192 <?dbhtml list-presentation="table"?>
193
194 <varlistentry id="bundle">
195 <term><command>bundle</command></term>
196 <listitem>
197 <para>
198 creates bundles of Ruby Gems
199 </para>
200 <indexterm zone="ruby bundle">
201 <primary sortas="b-bundle">bundle</primary>
202 </indexterm>
203 </listitem>
204 </varlistentry>
205
206 <varlistentry id="bundler">
207 <term><command>bundler</command></term>
208 <listitem>
209 <para>
210 manages an application's dependencies throughout it's lifecycle
211 </para>
212 <indexterm zone="ruby bundler">
213 <primary sortas="b-bundler">bundler</primary>
214 </indexterm>
215 </listitem>
216 </varlistentry>
217
218 <varlistentry id="erb">
219 <term><command>erb</command></term>
220 <listitem>
221 <para>
222 is Tiny eRuby. It interprets a
223 <application>Ruby</application> code embedded text file
224 </para>
225 <indexterm zone="ruby erb">
226 <primary sortas="b-erb">erb</primary>
227 </indexterm>
228 </listitem>
229 </varlistentry>
230
231 <varlistentry id="gem">
232 <term><command>gem</command></term>
233 <listitem>
234 <para>
235 command for RubyGems - a sophisticated package manager for
236 <application>Ruby</application>
237 </para>
238 <indexterm zone="ruby gem">
239 <primary sortas="b-gem">gem</primary>
240 </indexterm>
241 </listitem>
242 </varlistentry>
243
244 <varlistentry id="irb">
245 <term><command>irb</command></term>
246 <listitem>
247 <para>
248 is the interactive interface for
249 <application>Ruby</application>
250 </para>
251 <indexterm zone="ruby irb">
252 <primary sortas="b-irb">irb</primary>
253 </indexterm>
254 </listitem>
255 </varlistentry>
256
257 <varlistentry id="rake">
258 <term><command>rake</command></term>
259 <listitem>
260 <para>
261 a make-like build utility for <application>Ruby</application>
262 </para>
263 <indexterm zone="ruby rake">
264 <primary sortas="b-rake">rake</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 <varlistentry id="rdoc">
270 <term><command>rdoc</command></term>
271 <listitem>
272 <para>
273 generates <application>Ruby</application> documentation
274 </para>
275 <indexterm zone="ruby rdoc">
276 <primary sortas="b-rdoc">rdoc</primary>
277 </indexterm>
278 </listitem>
279 </varlistentry>
280
281 <varlistentry id="ri">
282 <term><command>ri</command></term>
283 <listitem>
284 <para>
285 displays documentation from a database on
286 <application>Ruby</application> classes, modules, and methods
287 </para>
288 <indexterm zone="ruby ri">
289 <primary sortas="b-ri">ri</primary>
290 </indexterm>
291 </listitem>
292 </varlistentry>
293
294 <varlistentry id="ruby-prog">
295 <term><command>ruby</command></term>
296 <listitem>
297 <para>
298 is an interpreted scripting language for quick
299 and easy object-oriented programming
300 </para>
301 <indexterm zone="ruby ruby-prog">
302 <primary sortas="b-ruby">ruby</primary>
303 </indexterm>
304 </listitem>
305 </varlistentry>
306
307 <varlistentry id="libruby">
308 <term><filename role="libraryfile">libruby.so</filename></term>
309 <listitem>
310 <para>
311 contains the API functions required by <application>Ruby</application>
312 </para>
313 <indexterm zone="ruby libruby">
314 <primary sortas="c-libruby">libruby.so</primary>
315 </indexterm>
316 </listitem>
317 </varlistentry>
318
319 </variablelist>
320
321 </sect2>
322
323</sect1>
Note: See TracBrowser for help on using the repository browser.