source: general/prog/ruby.xml@ 7a8cc527

10.1 11.0 11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 7a8cc527 was e4c4af6, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

Update to ruby-3.0.0

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@24061 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 9.0 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 "http://cache.ruby-lang.org/pub/ruby/&ruby-minor-version;/ruby-&ruby-version;.tar.xz">
8 <!ENTITY ruby-download-ftp " ">
9 <!ENTITY ruby-md5sum "fefb57db58b5c3f11534710bab2bba47">
10 <!ENTITY ruby-size "14 MB">
11 <!ENTITY ruby-buildsize "629 MB (add 533 MB for C API docs)">
12 <!ENTITY ruby-time "1.3 SBU (using parallelism=4; add 5.5 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 <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 &lfs10_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="libyaml"/>,
82 <xref linkend="tk"/>,
83 <xref linkend="valgrind"/>, and
84 <ulink url="http://dtrace.org/blogs/about/">DTrace</ulink>
85 </para>
86
87 <para condition="html" role="usernotes">User Notes:
88 <ulink url="&blfs-wiki;/ruby"/>
89 </para>
90 </sect2>
91
92 <sect2 role="installation">
93 <title>Installation of Ruby</title>
94
95 <para>
96 Install <application>Ruby</application> by running the following
97 command:
98 </para>
99
100<screen><userinput>./configure --prefix=/usr \
101 --enable-shared \
102 --docdir=/usr/share/doc/ruby-&ruby-version; &amp;&amp;
103make</userinput></screen>
104
105 <para>
106 Optionally, build the CAPI documents by running the following
107 commands:
108 </para>
109
110<screen><userinput>make capi</userinput></screen>
111
112 <para>
113 To test the results, issue: <command>make check</command>. There are almost
114 21,000 tests. Some tests related to ipv6 may indicate errors. If the
115 tests are run in a directory that has a world writable component (e.g.
116 /tmp) then several additional tests may fail. A few tests my fail due
117 to system configuration expectations.
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 bundle,
164 bundler,
165 erb,
166 gem,
167 irb,
168 racc,
169 rake,
170 rbs,
171 rdoc,
172 ri,
173 ruby, and
174 typeprof
175 </seg>
176 <seg>
177 libruby.so
178 </seg>
179 <seg>
180 /usr/include/ruby-&ruby-minor-version;.0
181 /usr/lib/ruby,
182 /usr/share/doc/ruby-&ruby-version; and
183 /usr/share/ri
184 </seg>
185 </seglistitem>
186 </segmentedlist>
187
188 <variablelist>
189 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
190 <?dbfo list-presentation="list"?>
191 <?dbhtml list-presentation="table"?>
192
193 <varlistentry id="bundle">
194 <term><command>bundle</command></term>
195 <listitem>
196 <para>
197 creates bundles of Ruby Gems.
198 </para>
199 <indexterm zone="ruby bundle">
200 <primary sortas="b-bundle">bundle</primary>
201 </indexterm>
202 </listitem>
203 </varlistentry>
204
205 <varlistentry id="bundler">
206 <term><command>bundler</command></term>
207 <listitem>
208 <para>
209 manages an application's dependencies throughout it's lifecycle.
210 </para>
211 <indexterm zone="ruby bundler">
212 <primary sortas="b-bundler">bundler</primary>
213 </indexterm>
214 </listitem>
215 </varlistentry>
216
217 <varlistentry id="erb">
218 <term><command>erb</command></term>
219 <listitem>
220 <para>
221 is Tiny eRuby. It interprets a
222 <application>Ruby</application> code embedded text file.
223 </para>
224 <indexterm zone="ruby erb">
225 <primary sortas="b-erb">erb</primary>
226 </indexterm>
227 </listitem>
228 </varlistentry>
229
230 <varlistentry id="gem">
231 <term><command>gem</command></term>
232 <listitem>
233 <para>
234 command for RubyGems - a sophisticated package manager for
235 <application>Ruby</application>.
236 </para>
237 <indexterm zone="ruby gem">
238 <primary sortas="b-gem">gem</primary>
239 </indexterm>
240 </listitem>
241 </varlistentry>
242
243 <varlistentry id="irb">
244 <term><command>irb</command></term>
245 <listitem>
246 <para>
247 is the interactive interface for
248 <application>Ruby</application>.
249 </para>
250 <indexterm zone="ruby irb">
251 <primary sortas="b-irb">irb</primary>
252 </indexterm>
253 </listitem>
254 </varlistentry>
255
256 <varlistentry id="rake">
257 <term><command>rake</command></term>
258 <listitem>
259 <para>
260 a make-like build utility for <application>Ruby</application>.
261 </para>
262 <indexterm zone="ruby rake">
263 <primary sortas="b-rake">rake</primary>
264 </indexterm>
265 </listitem>
266 </varlistentry>
267
268 <varlistentry id="rdoc">
269 <term><command>rdoc</command></term>
270 <listitem>
271 <para>
272 generates <application>Ruby</application> documentation.
273 </para>
274 <indexterm zone="ruby rdoc">
275 <primary sortas="b-rdoc">rdoc</primary>
276 </indexterm>
277 </listitem>
278 </varlistentry>
279
280 <varlistentry id="ri">
281 <term><command>ri</command></term>
282 <listitem>
283 <para>
284 displays documentation from a database on
285 <application>Ruby</application> classes, modules, and methods.
286 </para>
287 <indexterm zone="ruby ri">
288 <primary sortas="b-ri">ri</primary>
289 </indexterm>
290 </listitem>
291 </varlistentry>
292
293 <varlistentry id="ruby-prog">
294 <term><command>ruby</command></term>
295 <listitem>
296 <para>
297 is an interpreted scripting language for quick
298 and easy object-oriented programming.
299 </para>
300 <indexterm zone="ruby ruby-prog">
301 <primary sortas="b-ruby">ruby</primary>
302 </indexterm>
303 </listitem>
304 </varlistentry>
305
306 <varlistentry id="libruby">
307 <term><filename role="libraryfile">libruby.so</filename></term>
308 <listitem>
309 <para>
310 contains the API functions required by <application>Ruby</application>.
311 </para>
312 <indexterm zone="ruby libruby">
313 <primary sortas="c-libruby">libruby.so</primary>
314 </indexterm>
315 </listitem>
316 </varlistentry>
317
318 </variablelist>
319
320 </sect2>
321
322</sect1>
Note: See TracBrowser for help on using the repository browser.