source: general/prog/ruby.xml@ 0ec63138

11.0 lazarus qt5new trunk
Last change on this file since 0ec63138 was 0ec63138, checked in by Douglas R. Reno <renodr@…>, 5 months ago

Update to vala-0.52.3
Update to libksba-1.5.1
Update to pipewire-0.3.26
Update to graphene-1.10.6
Update to ruby-3.0.1

  • Property mode set to 100644
File size: 8.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 "26da18ccf13e5f40f9b618c30143c4a1">
10 <!ENTITY ruby-size "14 MB">
11 <!ENTITY ruby-buildsize "627 MB (add 1.0 GB for C API docs)">
12 <!ENTITY ruby-time "1.2 SBU (using parallelism=4; add 4.6 SBU for tests; add 1.1 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 &lfs101_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 almost
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 my fail due
116 to system configuration expectations.
117 </para>
118
119 <para>
120 Now, as the <systemitem class="username">root</systemitem> user:
121 </para>
122
123<screen role="root"><userinput>make install</userinput></screen>
124
125 </sect2>
126
127 <sect2 role="commands">
128 <title>Command Explanations</title>
129
130 <para>
131 <parameter>--enable-shared</parameter>: This switch enables building of
132 the <filename class="libraryfile">libruby</filename> shared library.
133 </para>
134
135 <para>
136 <option>--disable-install-doc</option>: This switch disables building and
137 installing rdoc indexes and C API documents.
138 </para>
139
140 <para>
141 <option>--disable-install-rdoc</option>: This switch disables building
142 and installing rdoc indexes.
143 </para>
144
145 <para>
146 <option>--disable-install-capi</option>: This switch disables building
147 and installing C API documents.
148 </para>
149
150 </sect2>
151
152 <sect2 role="content">
153 <title>Contents</title>
154
155 <segmentedlist>
156 <segtitle>Installed Programs</segtitle>
157 <segtitle>Installed Libraries</segtitle>
158 <segtitle>Installed Directories</segtitle>
159
160 <seglistitem>
161 <seg>
162 bundle,
163 bundler,
164 erb,
165 gem,
166 irb,
167 racc,
168 rake,
169 rbs,
170 rdoc,
171 ri,
172 ruby, and
173 typeprof
174 </seg>
175 <seg>
176 libruby.so
177 </seg>
178 <seg>
179 /usr/include/ruby-&ruby-minor-version;.0
180 /usr/lib/ruby,
181 /usr/share/doc/ruby-&ruby-version; and
182 /usr/share/ri
183 </seg>
184 </seglistitem>
185 </segmentedlist>
186
187 <variablelist>
188 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
189 <?dbfo list-presentation="list"?>
190 <?dbhtml list-presentation="table"?>
191
192 <varlistentry id="bundle">
193 <term><command>bundle</command></term>
194 <listitem>
195 <para>
196 creates bundles of Ruby Gems
197 </para>
198 <indexterm zone="ruby bundle">
199 <primary sortas="b-bundle">bundle</primary>
200 </indexterm>
201 </listitem>
202 </varlistentry>
203
204 <varlistentry id="bundler">
205 <term><command>bundler</command></term>
206 <listitem>
207 <para>
208 manages an application's dependencies throughout it's lifecycle
209 </para>
210 <indexterm zone="ruby bundler">
211 <primary sortas="b-bundler">bundler</primary>
212 </indexterm>
213 </listitem>
214 </varlistentry>
215
216 <varlistentry id="erb">
217 <term><command>erb</command></term>
218 <listitem>
219 <para>
220 is Tiny eRuby. It interprets a
221 <application>Ruby</application> code embedded text file
222 </para>
223 <indexterm zone="ruby erb">
224 <primary sortas="b-erb">erb</primary>
225 </indexterm>
226 </listitem>
227 </varlistentry>
228
229 <varlistentry id="gem">
230 <term><command>gem</command></term>
231 <listitem>
232 <para>
233 command for RubyGems - a sophisticated package manager for
234 <application>Ruby</application>
235 </para>
236 <indexterm zone="ruby gem">
237 <primary sortas="b-gem">gem</primary>
238 </indexterm>
239 </listitem>
240 </varlistentry>
241
242 <varlistentry id="irb">
243 <term><command>irb</command></term>
244 <listitem>
245 <para>
246 is the interactive interface for
247 <application>Ruby</application>
248 </para>
249 <indexterm zone="ruby irb">
250 <primary sortas="b-irb">irb</primary>
251 </indexterm>
252 </listitem>
253 </varlistentry>
254
255 <varlistentry id="rake">
256 <term><command>rake</command></term>
257 <listitem>
258 <para>
259 a make-like build utility for <application>Ruby</application>
260 </para>
261 <indexterm zone="ruby rake">
262 <primary sortas="b-rake">rake</primary>
263 </indexterm>
264 </listitem>
265 </varlistentry>
266
267 <varlistentry id="rdoc">
268 <term><command>rdoc</command></term>
269 <listitem>
270 <para>
271 generates <application>Ruby</application> documentation
272 </para>
273 <indexterm zone="ruby rdoc">
274 <primary sortas="b-rdoc">rdoc</primary>
275 </indexterm>
276 </listitem>
277 </varlistentry>
278
279 <varlistentry id="ri">
280 <term><command>ri</command></term>
281 <listitem>
282 <para>
283 displays documentation from a database on
284 <application>Ruby</application> classes, modules, and methods
285 </para>
286 <indexterm zone="ruby ri">
287 <primary sortas="b-ri">ri</primary>
288 </indexterm>
289 </listitem>
290 </varlistentry>
291
292 <varlistentry id="ruby-prog">
293 <term><command>ruby</command></term>
294 <listitem>
295 <para>
296 is an interpreted scripting language for quick
297 and easy object-oriented programming
298 </para>
299 <indexterm zone="ruby ruby-prog">
300 <primary sortas="b-ruby">ruby</primary>
301 </indexterm>
302 </listitem>
303 </varlistentry>
304
305 <varlistentry id="libruby">
306 <term><filename role="libraryfile">libruby.so</filename></term>
307 <listitem>
308 <para>
309 contains the API functions required by <application>Ruby</application>
310 </para>
311 <indexterm zone="ruby libruby">
312 <primary sortas="c-libruby">libruby.so</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 </variablelist>
318
319 </sect2>
320
321</sect1>
Note: See TracBrowser for help on using the repository browser.