source: general/prog/ruby.xml@ 435580e3

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 435580e3 was eb19100e, checked in by Pierre Labastie <pierre.labastie@…>, 17 months ago

Fix a misplaced role
  • 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
19 <title>Ruby-&ruby-version;</title>
20
21 <indexterm zone="ruby">
22 <primary sortas="a-Ruby">Ruby</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to Ruby</title>
27
28 <para>
29 The <application>Ruby</application> package contains the
30 <application>Ruby</application> development environment. This
31 is useful for object-oriented scripting.
32 </para>
33
34 &lfs112_checked;
35
36 <bridgehead renderas="sect3">Package Information</bridgehead>
37 <itemizedlist spacing="compact">
38 <listitem>
39 <para>
40 Download (HTTP): <ulink url="&ruby-download-http;"/>
41 </para>
42 </listitem>
43 <listitem>
44 <para>
45 Download (FTP): <ulink url="&ruby-download-ftp;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download MD5 sum: &ruby-md5sum;
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download size: &ruby-size;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Estimated disk space required: &ruby-buildsize;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated build time: &ruby-time;
66 </para>
67 </listitem>
68 </itemizedlist>
69
70 <bridgehead renderas="sect3">Ruby Dependencies</bridgehead>
71
72 <bridgehead renderas="sect4">Optional</bridgehead>
73 <para role="optional">
74 <xref linkend="db"/>,
75 <xref linkend="doxygen"/>,
76 <xref linkend="graphviz"/>,
77 <xref linkend="libyaml"/>,
78 <xref linkend="tk"/>,
79 <xref linkend="valgrind"/>, and
80 <ulink url="http://dtrace.org/blogs/about/">DTrace</ulink>
81 </para>
82
83 <para condition="html" role="usernotes">User Notes:
84 <ulink url="&blfs-wiki;/ruby"/>
85 </para>
86 </sect2>
87
88 <sect2 role="installation">
89 <title>Installation of Ruby</title>
90
91 <para>
92 Install <application>Ruby</application> by running the following
93 command:
94 </para>
95
96<screen><userinput>./configure --prefix=/usr \
97 --enable-shared \
98 --docdir=/usr/share/doc/ruby-&ruby-version; &amp;&amp;
99make</userinput></screen>
100
101 <para>
102 Optionally, build the CAPI documents by running the following
103 commands:
104 </para>
105
106<screen><userinput>make capi</userinput></screen>
107
108 <para>
109 To test the results, issue: <command>make check</command>. There are over
110 21,000 tests. Some tests related to ipv6 may indicate errors. If the
111 tests are run in a directory that has a world writable component (e.g.
112 /tmp) then several additional tests may fail. A few tests may fail due
113 to system configuration expectations.
114 </para>
115<!-- With 3.0.2:
116Finished tests in 443.541527s, 47.5739 tests/s, 6031.9921 assertions/s. 21101 tests, 2675439 assertions, 4 failures, 1 errors, 45 skips -->
117
118 <para>
119 Now, as the <systemitem class="username">root</systemitem> user:
120 </para>
121
122<screen role="root"><userinput>make install</userinput></screen>
123
124 <note>
125 <para>
126 If you have Ruby-On-Rails applications installed and did an
127 upgrade of <application>Ruby</application> by installing this
128 package, you might need to run an update there, too
129 (as the &root; user):
130 </para>
131
132<screen role="nodump"><userinput>cd /path/to/web/app
133bundle update rake
134/etc/rc.d/init.d/httpd restart</userinput></screen>
135 </note>
136
137 </sect2>
138
139 <sect2 role="commands">
140 <title>Command Explanations</title>
141
142 <para>
143 <parameter>--enable-shared</parameter>: This switch enables building
144 the <filename class="libraryfile">libruby</filename> shared library.
145 </para>
146
147 <para>
148 <option>--disable-install-doc</option>: This switch disables building and
149 installing rdoc indexes and C API documents.
150 </para>
151
152 <para>
153 <option>--disable-install-rdoc</option>: This switch disables building
154 and installing rdoc indexes.
155 </para>
156
157 <para>
158 <option>--disable-install-capi</option>: This switch disables building
159 and installing C API documents.
160 </para>
161
162 </sect2>
163
164 <sect2 role="content">
165 <title>Contents</title>
166
167 <segmentedlist>
168 <segtitle>Installed Programs</segtitle>
169 <segtitle>Installed Libraries</segtitle>
170 <segtitle>Installed Directories</segtitle>
171
172 <seglistitem>
173 <seg>
174 bundle,
175 bundler,
176 erb,
177 gem,
178 irb,
179 racc,
180 rake,
181 rbs,
182 rdbg,
183 rdoc,
184 ri,
185 ruby, and
186 typeprof
187 </seg>
188 <seg>
189 libruby.so
190 </seg>
191 <seg>
192 /usr/include/ruby-&ruby-minor-version;.0,
193 /usr/lib/ruby,
194 /usr/share/doc/ruby-&ruby-version; and
195 /usr/share/ri
196 </seg>
197 </seglistitem>
198 </segmentedlist>
199
200 <variablelist>
201 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
202 <?dbfo list-presentation="list"?>
203 <?dbhtml list-presentation="table"?>
204
205 <varlistentry id="bundle">
206 <term><command>bundle</command></term>
207 <listitem>
208 <para>
209 creates bundles of Ruby Gems
210 </para>
211 <indexterm zone="ruby bundle">
212 <primary sortas="b-bundle">bundle</primary>
213 </indexterm>
214 </listitem>
215 </varlistentry>
216
217 <varlistentry id="bundler">
218 <term><command>bundler</command></term>
219 <listitem>
220 <para>
221 manages an application's dependencies throughout it's lifecycle
222 </para>
223 <indexterm zone="ruby bundler">
224 <primary sortas="b-bundler">bundler</primary>
225 </indexterm>
226 </listitem>
227 </varlistentry>
228
229 <varlistentry id="erb">
230 <term><command>erb</command></term>
231 <listitem>
232 <para>
233 is a command line front-end for eRuby, which provides a templating
234 system for <application>Ruby</application>
235 </para>
236 <indexterm zone="ruby erb">
237 <primary sortas="b-erb">erb</primary>
238 </indexterm>
239 </listitem>
240 </varlistentry>
241
242 <varlistentry id="gem">
243 <term><command>gem</command></term>
244 <listitem>
245 <para>
246 is the command for RubyGems, which is a sophisticated package
247 manager for <application>Ruby</application>. This is similar
248 to Python's 'pip' command
249 </para>
250 <indexterm zone="ruby gem">
251 <primary sortas="b-gem">gem</primary>
252 </indexterm>
253 </listitem>
254 </varlistentry>
255
256 <varlistentry id="irb">
257 <term><command>irb</command></term>
258 <listitem>
259 <para>
260 is the interactive interface for
261 <application>Ruby</application>
262 </para>
263 <indexterm zone="ruby irb">
264 <primary sortas="b-irb">irb</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 <varlistentry id="rake">
270 <term><command>rake</command></term>
271 <listitem>
272 <para>
273 is a make-like build utility for <application>Ruby</application>
274 </para>
275 <indexterm zone="ruby rake">
276 <primary sortas="b-rake">rake</primary>
277 </indexterm>
278 </listitem>
279 </varlistentry>
280
281 <varlistentry id="rdbg">
282 <term><command>rdbg</command></term>
283 <listitem>
284 <para>
285 is an interactive debugger for <application>Ruby</application>
286 </para>
287 <indexterm zone="ruby rdbg">
288 <primary sortas="b-rdbg">rdbg</primary>
289 </indexterm>
290 </listitem>
291 </varlistentry>
292
293 <varlistentry id="rdoc">
294 <term><command>rdoc</command></term>
295 <listitem>
296 <para>
297 generates <application>Ruby</application> documentation
298 </para>
299 <indexterm zone="ruby rdoc">
300 <primary sortas="b-rdoc">rdoc</primary>
301 </indexterm>
302 </listitem>
303 </varlistentry>
304
305 <varlistentry id="ri">
306 <term><command>ri</command></term>
307 <listitem>
308 <para>
309 displays documentation from a database on
310 <application>Ruby</application> classes, modules, and methods
311 </para>
312 <indexterm zone="ruby ri">
313 <primary sortas="b-ri">ri</primary>
314 </indexterm>
315 </listitem>
316 </varlistentry>
317
318 <varlistentry id="ruby-prog">
319 <term><command>ruby</command></term>
320 <listitem>
321 <para>
322 is an interpreted scripting language for quick
323 and easy object-oriented programming
324 </para>
325 <indexterm zone="ruby ruby-prog">
326 <primary sortas="b-ruby">ruby</primary>
327 </indexterm>
328 </listitem>
329 </varlistentry>
330
331 <varlistentry id="libruby">
332 <term><filename role="libraryfile">libruby.so</filename></term>
333 <listitem>
334 <para>
335 contains the API functions required by <application>Ruby</application>
336 </para>
337 <indexterm zone="ruby libruby">
338 <primary sortas="c-libruby">libruby.so</primary>
339 </indexterm>
340 </listitem>
341 </varlistentry>
342
343 </variablelist>
344
345 </sect2>
346
347</sect1>
Note: See TracBrowser for help on using the repository browser.