source: general/prog/ruby.xml@ d78e102e

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 d78e102e was 809c6b5, checked in by Thomas Trepl <thomas@…>, 16 months ago

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