source: general/prog/ruby.xml@ 4454113

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 xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 4454113 was edfcf34d, checked in by Thomas Trepl <thomas@…>, 17 months ago

Upgrade ruby-3.1.3
  • Property mode set to 100644
File size: 9.9 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 "093edbcb070be014991b43f499abf083">
10 <!ENTITY ruby-size "14.5 MB">
11 <!ENTITY ruby-buildsize "619 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)">
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 &lfs112_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 <note>
128 <para>
129 If you have Ruby-On-Rails applications installed and did an
130 upgrade of <application>Ruby</application> by installing this
131 package, you might need to run an update there, too:
132 </para>
133
134<screen><userinput role="nodump">cd /path/to/web/app
135bundle update rake
136/etc/rc.d/init.d/httpd restart</userinput></screen>
137 </note>
138
139 </sect2>
140
141 <sect2 role="commands">
142 <title>Command Explanations</title>
143
144 <para>
145 <parameter>--enable-shared</parameter>: This switch enables building
146 the <filename class="libraryfile">libruby</filename> shared library.
147 </para>
148
149 <para>
150 <option>--disable-install-doc</option>: This switch disables building and
151 installing rdoc indexes and C API documents.
152 </para>
153
154 <para>
155 <option>--disable-install-rdoc</option>: This switch disables building
156 and installing rdoc indexes.
157 </para>
158
159 <para>
160 <option>--disable-install-capi</option>: This switch disables building
161 and installing C API documents.
162 </para>
163
164 </sect2>
165
166 <sect2 role="content">
167 <title>Contents</title>
168
169 <segmentedlist>
170 <segtitle>Installed Programs</segtitle>
171 <segtitle>Installed Libraries</segtitle>
172 <segtitle>Installed Directories</segtitle>
173
174 <seglistitem>
175 <seg>
176 bundle,
177 bundler,
178 erb,
179 gem,
180 irb,
181 racc,
182 rake,
183 rbs,
184 rdbg,
185 rdoc,
186 ri,
187 ruby, and
188 typeprof
189 </seg>
190 <seg>
191 libruby.so
192 </seg>
193 <seg>
194 /usr/include/ruby-&ruby-minor-version;.0,
195 /usr/lib/ruby,
196 /usr/share/doc/ruby-&ruby-version; and
197 /usr/share/ri
198 </seg>
199 </seglistitem>
200 </segmentedlist>
201
202 <variablelist>
203 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
204 <?dbfo list-presentation="list"?>
205 <?dbhtml list-presentation="table"?>
206
207 <varlistentry id="bundle">
208 <term><command>bundle</command></term>
209 <listitem>
210 <para>
211 creates bundles of Ruby Gems
212 </para>
213 <indexterm zone="ruby bundle">
214 <primary sortas="b-bundle">bundle</primary>
215 </indexterm>
216 </listitem>
217 </varlistentry>
218
219 <varlistentry id="bundler">
220 <term><command>bundler</command></term>
221 <listitem>
222 <para>
223 manages an application's dependencies throughout it's lifecycle
224 </para>
225 <indexterm zone="ruby bundler">
226 <primary sortas="b-bundler">bundler</primary>
227 </indexterm>
228 </listitem>
229 </varlistentry>
230
231 <varlistentry id="erb">
232 <term><command>erb</command></term>
233 <listitem>
234 <para>
235 is a command line front-end for eRuby, which provides a templating
236 system for <application>Ruby</application>
237 </para>
238 <indexterm zone="ruby erb">
239 <primary sortas="b-erb">erb</primary>
240 </indexterm>
241 </listitem>
242 </varlistentry>
243
244 <varlistentry id="gem">
245 <term><command>gem</command></term>
246 <listitem>
247 <para>
248 is the command for RubyGems, which is a sophisticated package
249 manager for <application>Ruby</application>. This is similar
250 to Python's 'pip' command
251 </para>
252 <indexterm zone="ruby gem">
253 <primary sortas="b-gem">gem</primary>
254 </indexterm>
255 </listitem>
256 </varlistentry>
257
258 <varlistentry id="irb">
259 <term><command>irb</command></term>
260 <listitem>
261 <para>
262 is the interactive interface for
263 <application>Ruby</application>
264 </para>
265 <indexterm zone="ruby irb">
266 <primary sortas="b-irb">irb</primary>
267 </indexterm>
268 </listitem>
269 </varlistentry>
270
271 <varlistentry id="rake">
272 <term><command>rake</command></term>
273 <listitem>
274 <para>
275 is a make-like build utility for <application>Ruby</application>
276 </para>
277 <indexterm zone="ruby rake">
278 <primary sortas="b-rake">rake</primary>
279 </indexterm>
280 </listitem>
281 </varlistentry>
282
283 <varlistentry id="rdbg">
284 <term><command>rdbg</command></term>
285 <listitem>
286 <para>
287 is an interactive debugger for <application>Ruby</application>
288 </para>
289 <indexterm zone="ruby rdbg">
290 <primary sortas="b-rdbg">rdbg</primary>
291 </indexterm>
292 </listitem>
293 </varlistentry>
294
295 <varlistentry id="rdoc">
296 <term><command>rdoc</command></term>
297 <listitem>
298 <para>
299 generates <application>Ruby</application> documentation
300 </para>
301 <indexterm zone="ruby rdoc">
302 <primary sortas="b-rdoc">rdoc</primary>
303 </indexterm>
304 </listitem>
305 </varlistentry>
306
307 <varlistentry id="ri">
308 <term><command>ri</command></term>
309 <listitem>
310 <para>
311 displays documentation from a database on
312 <application>Ruby</application> classes, modules, and methods
313 </para>
314 <indexterm zone="ruby ri">
315 <primary sortas="b-ri">ri</primary>
316 </indexterm>
317 </listitem>
318 </varlistentry>
319
320 <varlistentry id="ruby-prog">
321 <term><command>ruby</command></term>
322 <listitem>
323 <para>
324 is an interpreted scripting language for quick
325 and easy object-oriented programming
326 </para>
327 <indexterm zone="ruby ruby-prog">
328 <primary sortas="b-ruby">ruby</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
333 <varlistentry id="libruby">
334 <term><filename role="libraryfile">libruby.so</filename></term>
335 <listitem>
336 <para>
337 contains the API functions required by <application>Ruby</application>
338 </para>
339 <indexterm zone="ruby libruby">
340 <primary sortas="c-libruby">libruby.so</primary>
341 </indexterm>
342 </listitem>
343 </varlistentry>
344
345 </variablelist>
346
347 </sect2>
348
349</sect1>
Note: See TracBrowser for help on using the repository browser.