1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta http-equiv="Content-Language" content="en">
<title>Installing Programs with setup.rb</title>
</head>
<body>
<h1>Installing Programs with setup.rb</h1>
<h2>Quick Start</h2>
<p>
Type this (You might needs super user previledge):
</p>
<pre>
($ su)
# ruby setup.rb
</pre>
<p>
If you want to install a program in to your home directory
($HOME), use following instead:
</p>
<pre>
$ ruby setup.rb all --prefix=$HOME
</pre>
<h2>Detailed Installtion Process</h2>
<p>
setup.rb invokes installation by three steps. There are
"config", "setup" and "install". You can invoke each steps
separately as following:
</p>
<pre>
$ ruby setup.rb config
$ ruby setup.rb setup
# ruby setup.rb install
</pre>
<p>
You can controll installation process by giving detailed
options for each tasks. For example, --bin-dir=$HOME/bin
let setup.rb install commands in $HOME/bin.
</p>
<p>
For details, see "Task Options".
</p>
<h2>Global Options</h2>
<p>
"Global Option" is a command line option which you can use
for all tasks. You must give a global option before any task
name.
</p>
<dl>
<dt>-q,--quiet</dt>
<dd><p>
suppress message outputs
</p>
</dd>
<dt>--verbose</dt>
<dd><p>
output messages verbosely (default)
</p>
</dd>
<dt>-h,--help</dt>
<dd><p>
prints help and quit
</p>
</dd>
<dt>-v,--version</dt>
<dd><p>
prints version and quit
</p>
</dd>
<dt>--copyright</dt>
<dd><p>
prints copyright and quit
</p>
</dd>
</dl>
<h2>Tasks</h2>
<p>
These are acceptable tasks:
</p>
<dl>
<dt>all</dt>
<dd><p>
Invokes `config', `setup', then `install'.
Task options for all is same with config.
</p>
</dd>
<dt>config</dt>
<dd><p>
Checks and saves configurations.
</p>
</dd>
<dt>show</dt>
<dd><p>
Prints current configurations.
</p>
</dd>
<dt>setup</dt>
<dd><p>
Compiles ruby extentions.
</p>
</dd>
<dt>install</dt>
<dd><p>
Installs files.
</p>
</dd>
<dt>test</dt>
<dd><p>
Invokes tests.
</p>
</dd>
<dt>clean</dt>
<dd><p>
Removes created files.
</p>
</dd>
<dt>distclean</dt>
<dd><p>
Removes all created files.
</p>
</dd>
</dl>
<h2>Task Options for CONFIG/ALL</h2>
<p>
You can pass following long options for CONFIG task
and ALL task.
</p>
<p>
All options accept parameterized value, like
--rbdir=$siterubyver or --sodir=$siterubyverarch.
On UNIX shells, you should escape "$" character,
so use --rbdir=\$siterubyver or --sodir=$siterubyverach.
</p>
<dl>
<dt>--installdirs=(std|site|home)</dt>
<dd><p>
A handy option to set common install target.
</p>
<p>
std: install files under $libruby.
</p>
<p>
site: install files under $siteruby.
</p>
<p>
home: install files under home directory ($HOME).
</p>
</dd>
<dt>--prefix=PATH</dt>
<dd><p>
The path prefix of target directory pathes like $bindir, $libdir...
</p>
</dd>
<dt>--bindir=PATH</dt>
<dd><p>
The directory for commands.
</p>
</dd>
<dt>--rbdir=PATH</dt>
<dd><p>
The directory for ruby scripts.
</p>
</dd>
<dt>--sodir=PATH</dt>
<dd><p>
The directory for ruby extentions.
</p>
</dd>
<dt>--datadir=PATH</dt>
<dd><p>
The directory for shared data.
</p>
</dd>
<dt>--sysconfdir=PATH</dt>
<dd><p>
The directory for configuration files.
</p>
</dd>
<dt>--mandir=PATH</dt>
<dd><p>
The directory for manual pages.
</p>
</dd>
<dt>--libruby=PATH</dt>
<dd><p>
The directory for ruby libraries.
</p>
</dd>
<dt>--librubyver=PATH</dt>
<dd><p>
The directory for standard ruby libraries.
</p>
</dd>
<dt>--librubyverarch=PATH</dt>
<dd><p>
The directory for standard ruby extensions.
</p>
</dd>
<dt>--siteruby=PATH</dt>
<dd><p>
The directory for version-independent non-standard
ruby libraries
</p>
</dd>
<dt>--siterubyver=PATH</dt>
<dd><p>
The directory for non-standard ruby libraries.
</p>
</dd>
<dt>--siterubyverarch=PATH</dt>
<dd><p>
The directory for non-standard ruby extensions.
</p>
</dd>
<dt>--rubypath=PATH</dt>
<dd><p>
The path to set to #! line.
</p>
</dd>
<dt>--shebang=(all|ruby|never)</dt>
<dd><p>
Shenbang line (#!) rewriting mode.
</p>
<p>
all: replace all shebang lines.
</p>
<p>
ruby: replace shebang lines which invokes ruby.
</p>
<p>
never: never rewrite shebang.
</p>
</dd>
<dt>--rubyprog=PATH</dt>
<dd><p>
The ruby program using for installation.
</p>
</dd>
<dt>--makeprog=NAME</dt>
<dd><p>
The make program to compile ruby extentions.
</p>
</dd>
<dt>--without-ext</dt>
<dd><p>
Forces to setup.rb never to compile/install
ruby extentions.
</p>
</dd>
<dt>--rbconfig=PATH</dt>
<dd><p>
Your rbconfig.rb to load.
</p>
</dd>
</dl>
<p>
If there's the directory named "packages",
You can also use these options:
</p>
<dl>
<dt>--with=NAME,NAME,NAME...</dt>
<dd><p>
Package names which you want to install.
</p>
</dd>
<dt>--without=NAME,NAME,NAME...</dt>
<dd><p>
Package names which you do not want to install.
</p>
</dd>
</dl>
<p>
[NOTE] You can pass options to extconf.rb like this:
</p>
<pre>
ruby setup.rb config -- --with-tklib=/usr/lib/libtk-ja.so.8.0
</pre>
<h2>Task Options for INSTALL</h2>
<dl>
<dt>--no-harm</dt>
<dd><p>
prints what to do and done nothing really.
</p>
</dd>
<dt>--prefix=PATH</dt>
<dd><p>
The prefix of the installing directory path.
This option may help binary package maintainers.
A default value is an empty string.
</p>
</dd>
</dl>
</body>
</html>
|
