setup 4.1.0 → 4.2.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,100 +0,0 @@
1
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
- <html lang="en">
3
- <head>
4
- <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
5
- <meta http-equiv="Content-Language" content="en">
6
- <link href="../../assets/images/setup-small.png" rel="shortcut icon"/>
7
- <link href="custom.css" rel="stylesheet" type="text/css"/>
8
- <title>Setup Hook Script API</title>
9
- </head>
10
- <body>
11
- <div id="content">
12
- <img src="../../assets/images/setup-small.png" align="left"/>
13
- <h1>Hook Script API</h1>
14
- <hr/>
15
- <dl>
16
- <dt>get_config(<var>key</var>) -&gt; String</dt>
17
- <dt>config(<var>key</var>) -&gt; String</dt>
18
- <dd><p>
19
- get a configuration. (e.g. config('prefix') for --prefix)
20
- </p>
21
- </dd>
22
- <dt>set_config(<var>key</var>, <var>val</var>)</dt>
23
- <dd><p>
24
- set a configuration KEY to VAL. (e.g. set_config(&quot;prefix&quot;, &quot;/usr&quot;))
25
- </p>
26
- </dd>
27
- <dt>curr_srcdir -&gt; String</dt>
28
- <dd><p>
29
- the current srcdir.
30
- </p>
31
- </dd>
32
- <dt>curr_objdir -&gt; String</dt>
33
- <dd><p>
34
- the current objdir.
35
- </p>
36
- </dd>
37
- <dt>srcdir_root -&gt; String</dt>
38
- <dd><p>
39
- the root directory of srcdir.
40
- When the hook script is called from setup.rb, this method
41
- returns the top directory of each package directory
42
- (ARCHIVE_TOP/packages/*/).
43
- </p>
44
- </dd>
45
- <dt>objdir_root -&gt; String</dt>
46
- <dd><p>
47
- the root directory of objdir.
48
- When the hook script is called from setup.rb, this method
49
- returns the top directory of each package directory
50
- (OBJDIR/packages/*/).
51
- </p>
52
- </dd>
53
- <dt>srcfile(<var>filename</var>) -&gt; String</dt>
54
- <dd><p>
55
- expands relational path FNAME which is in the current srcdir,
56
- into the absolute path.
57
- </p>
58
- </dd>
59
- <dt>srcexist?(<var>filename</var>)</dt>
60
- <dd><p>
61
- true if a file FNAME exists in the current srcdir.
62
- </p>
63
- </dd>
64
- <dt>srcdirectory?(<var>filename</var>)</dt>
65
- <dd><p>
66
- true if a directory FNAME exists in the current srcdir.
67
- </p>
68
- </dd>
69
- <dt>srcfile?(<var>filename</var>)</dt>
70
- <dd><p>
71
- true if a normal file FNAME exists in the current srcdir.
72
- </p>
73
- </dd>
74
- <dt>srcentries(<var>relative_path</var> = '.') -&gt; [String]</dt>
75
- <dd><p>
76
- returns the list of file entiries in the directory
77
- &quot;current srcdir + '/' + relpath&quot;
78
- </p>
79
- </dd>
80
- <dt>srcfiles(<var>relative_path</var> = '.') -&gt; [String]</dt>
81
- <dd><p>
82
- returns the list of file names in the directory
83
- &quot;current srcdir + '/' + relpath&quot;
84
- </p>
85
- </dd>
86
- <dt>srcdirectories(<var>relative_path</var> = '.') -&gt; [String]</dt>
87
- <dd><p>
88
- returns the list of directory names in the directory
89
- &quot;current srcdir + '/' + relpath&quot;
90
- </p>
91
- </dd>
92
- </dl>
93
- </div>
94
-
95
- <div id="tigerops">
96
- <iframe src="http://tigerops.org/assets/adverts/banner-900-1.html" scrolling="no"></frame>
97
- </div>
98
-
99
- </body>
100
- </html>
@@ -1,50 +0,0 @@
1
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
- <html lang="en">
3
- <head>
4
- <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
5
- <meta http-equiv="Content-Language" content="en">
6
- <link href="../../assets/images/setup-small.png" rel="shortcut icon"/>
7
- <link href="custom.css" rel="stylesheet" type="text/css"/>
8
- <title>Setup.rb User Manual</title>
9
- </head>
10
- <body>
11
- <div id="content">
12
- <img src="../../assets/images/setup-small.png" align="left"/>
13
- <h1>Setup.rb User Manual</h1>
14
- <hr/>
15
- <h2>Introduction</h2>
16
- <p>
17
- Setup.rb is a generic installer for ruby scripts/extentions.
18
- You can automate configuration and installation of your program
19
- package.
20
- </p>
21
- <p style="color: red;">
22
- Please note this documentation is still largely for 3.4.1,
23
- and may contain some descrepencies with the current version.
24
- </p>
25
- <h2>Table of Contents</h2>
26
- <ul>
27
- <li><a href="usage.html">Installing Packages</a></li>
28
- <li><a href="devel.html">Creating Packages</a></li>
29
- <li><a href="hookapi.html">Hook Script Reference</a></li>
30
- <li><a href="metaconfapi.html">Metaconfig Reference</a></li>
31
- </ul>
32
- <h2>External Links</h2>
33
- <ul>
34
- <li><a href="http://setup.rubyforge.org">Homepage</a></li>
35
- <li><a href="http://rubyforge.org/projects/setup">Development</a></li>
36
- <li><a href="http://">Mailing List</a></li>
37
- </ul>
38
- </div>
39
- <div id="copyright">
40
- Setup.rb is the artful work of Minero Aoki and 7rans Hasbeensetup.
41
- Copyright (c) 2002, 2008. LGPL / Ruby License.
42
- </div>
43
-
44
- <div id="tigerops">
45
- <iframe src="http://tigerops.org/assets/adverts/banner-900-1.html" scrolling="no"></frame>
46
- </div>
47
-
48
- </body>
49
- </html>
50
-
@@ -1,91 +0,0 @@
1
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
- <html lang="en">
3
- <head>
4
- <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
5
- <meta http-equiv="Content-Language" content="en">
6
- <link href="../../assets/images/setup-small.png" rel="shortcut icon"/>
7
- <link href="custom.css" rel="stylesheet" type="text/css"/>
8
- <title>Setup metaconfig API</title>
9
- </head>
10
- <body>
11
- <div id="content">
12
- <img src="../../assets/images/setup-small.png" align="left"/>
13
- <h1>Metaconfig API</h1>
14
- <hr/>
15
-
16
- <dl>
17
- <dt>add_path_config(<var>confname</var>, <var>default</var>, <var>description</var>)</dt>
18
- <dd><dl class="typedecl">
19
- <dt>confname</dt><dd>String</dd>
20
- <dt>default</dt><dd>String</dd>
21
- <dt>description</dt><dd>String</dd>
22
- </dl>
23
- <p>
24
- defines a path config option CONFNAME.
25
- DEFAULT is the <var>default</var> value of this option.
26
- DESCRIPTION is the short <var>description</var> of this option
27
- which is used from '--help' global option.
28
- </p>
29
- </dd>
30
- <dt>add_bool_config(<var>confname</var>, <var>default</var>, <var>description</var>)</dt>
31
- <dd><dl class="typedecl">
32
- <dt>confname</dt><dd>String</dd>
33
- <dt>default</dt><dd>String</dd>
34
- <dt>description</dt><dd>String</dd>
35
- </dl>
36
- <p>
37
- defines a bool config option CONFNAME.
38
- DEFAULT is the <var>default</var> value of this option.
39
- DESCRIPTION is the short <var>description</var> of this option
40
- which is used from '--help' global option.
41
- </p>
42
- </dd>
43
- <dt>set_config_default(<var>confname</var>, <var>val</var>)</dt>
44
- <dd><dl class="typedecl">
45
- <dt>confname</dt><dd>String</dd>
46
- <dt>val</dt><dd>String | bool</dd>
47
- </dl>
48
- <p>
49
- set <var>default</var> value of config CONFNAME to VAL.
50
- If CONFNAME is a bool config, VAL should be boolean.
51
- Else VAL should be a String.
52
- </p>
53
- </dd>
54
- <dt>remove_config(<var>confname</var>)</dt>
55
- <dd><dl class="typedecl">
56
- <dt>confname</dt><dd>String</dd>
57
- </dl>
58
- <p>
59
- removes config entry CONFNAME from the installer completely.
60
- You must use this method at your own lisk. For example,
61
- 'remove_config(&quot;prefix&quot;)' causes fatal error.
62
- </p>
63
- </dd>
64
- <!--
65
- <dt>packages -&gt; [String]</dt>
66
- <dd><p>
67
- Returns the list of package names.
68
- This method raises RuntimeError if called in the single
69
- package archive.
70
- </p>
71
- </dd>
72
- <dt>declare_packages(<var>list</var>)</dt>
73
- <dd><dl class="typedecl">
74
- <dt>list</dt><dd>[String]</dd>
75
- </dl>
76
- <p>
77
- Set the ordered <var>list</var> of installing package names.
78
- This method raises RuntimeError if called in the single
79
- package archive.
80
- </p>
81
- </dd>
82
- -->
83
- </dl>
84
- </div>
85
-
86
- <div id="tigerops">
87
- <iframe src="http://tigerops.org/assets/adverts/banner-900-1.html" scrolling="no"></frame>
88
- </div>
89
-
90
- </body>
91
- </html>
@@ -1,306 +0,0 @@
1
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
- <html lang="en">
3
- <head>
4
- <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
5
- <meta http-equiv="Content-Language" content="en">
6
- <link href="../../assets/images/setup-small.png" rel="shortcut icon"/>
7
- <link href="custom.css" rel="stylesheet" type="text/css"/>
8
- <title>Installing Programs with setup.rb</title>
9
- </head>
10
- <body>
11
- <div id="content">
12
- <img src="../../assets/images/setup-small.png" align="left"/>
13
- <h1>Installing Programs</h1>
14
- <hr/>
15
- <h2>Quick Start</h2>
16
- <p>
17
- Type this (You might needs super user previledge):
18
- </p>
19
- <pre>
20
- ($ su)
21
- # ruby setup.rb
22
- </pre>
23
- <p>
24
- If you want to install a program in to your home directory
25
- ($HOME), use following instead:
26
- </p>
27
- <pre>
28
- $ ruby setup.rb all --prefix=$HOME
29
- </pre>
30
- <h2>Detailed Installtion Process</h2>
31
- <p>
32
- setup.rb invokes installation by three steps. There are
33
- &quot;config&quot;, &quot;setup&quot; and &quot;install&quot;. You can invoke each steps
34
- separately as following:
35
- </p>
36
- <pre>
37
- $ ruby setup.rb config
38
- $ ruby setup.rb setup
39
- # ruby setup.rb install
40
- </pre>
41
- <p>
42
- You can controll installation process by giving detailed
43
- options for each tasks. For example, --bin-dir=$HOME/bin
44
- let setup.rb install commands in $HOME/bin.
45
- </p>
46
- <p>
47
- For details, see &quot;Task Options&quot;.
48
- </p>
49
- <h2>Global Options</h2>
50
- <p>
51
- &quot;Global Option&quot; is a command line option which you can use
52
- for all tasks. You must give a global option before any task
53
- name.
54
- </p>
55
- <dl>
56
- <dt>-q,--quiet</dt>
57
- <dd><p>
58
- suppress message outputs
59
- </p>
60
- </dd>
61
- <dt>--verbose</dt>
62
- <dd><p>
63
- output messages verbosely (default)
64
- </p>
65
- </dd>
66
- <dt>-h,--help</dt>
67
- <dd><p>
68
- prints help and quit
69
- </p>
70
- </dd>
71
- <dt>-v,--version</dt>
72
- <dd><p>
73
- prints version and quit
74
- </p>
75
- </dd>
76
- <dt>--copyright</dt>
77
- <dd><p>
78
- prints copyright and quit
79
- </p>
80
- </dd>
81
- </dl>
82
- <h2>Tasks</h2>
83
- <p>
84
- These are acceptable tasks:
85
- </p>
86
- <dl>
87
- <dt>all</dt>
88
- <dd><p>
89
- Invokes `config', `setup', then `install'.
90
- Task options for all is same with config.
91
- </p>
92
- </dd>
93
- <dt>config</dt>
94
- <dd><p>
95
- Checks and saves configurations.
96
- </p>
97
- </dd>
98
- <dt>show</dt>
99
- <dd><p>
100
- Prints current configurations.
101
- </p>
102
- </dd>
103
- <dt>setup</dt>
104
- <dd><p>
105
- Compiles ruby extentions.
106
- </p>
107
- </dd>
108
- <dt>install</dt>
109
- <dd><p>
110
- Installs files.
111
- </p>
112
- </dd>
113
- <dt>test</dt>
114
- <dd><p>
115
- Invokes tests.
116
- </p>
117
- </dd>
118
- <dt>clean</dt>
119
- <dd><p>
120
- Removes created files.
121
- </p>
122
- </dd>
123
- <dt>distclean</dt>
124
- <dd><p>
125
- Removes all created files.
126
- </p>
127
- </dd>
128
- </dl>
129
- <h2>Task Options for CONFIG/ALL</h2>
130
- <p>
131
- You can pass following long options for CONFIG task
132
- and ALL task.
133
- </p>
134
- <p>
135
- All options accept parameterized value, like
136
- --rbdir=$siterubyver or --sodir=$siterubyverarch.
137
- On UNIX shells, you should escape &quot;$&quot; character,
138
- so use --rbdir=\$siterubyver or --sodir=$siterubyverach.
139
- </p>
140
- <dl>
141
- <dt>--installdirs=(std|site|home)</dt>
142
- <dd><p>
143
- A handy option to set common install target.
144
- </p>
145
- <p>
146
- std: install files under $libruby.
147
- </p>
148
- <p>
149
- site: install files under $siteruby.
150
- </p>
151
- <p>
152
- home: install files under home directory ($HOME).
153
- </p>
154
- </dd>
155
- <dt>--prefix=PATH</dt>
156
- <dd><p>
157
- The path prefix of target directory pathes like $bindir, $libdir...
158
- </p>
159
- </dd>
160
- <dt>--bindir=PATH</dt>
161
- <dd><p>
162
- The directory for commands.
163
- </p>
164
- </dd>
165
- <dt>--rbdir=PATH</dt>
166
- <dd><p>
167
- The directory for ruby scripts.
168
- </p>
169
- </dd>
170
- <dt>--sodir=PATH</dt>
171
- <dd><p>
172
- The directory for ruby extentions.
173
- </p>
174
- </dd>
175
- <dt>--datadir=PATH</dt>
176
- <dd><p>
177
- The directory for shared data.
178
- </p>
179
- </dd>
180
- <dt>--sysconfdir=PATH</dt>
181
- <dd><p>
182
- The directory for configuration files.
183
- </p>
184
- </dd>
185
- <dt>--mandir=PATH</dt>
186
- <dd><p>
187
- The directory for manual pages.
188
- </p>
189
- </dd>
190
- <dt>--libruby=PATH</dt>
191
- <dd><p>
192
- The directory for ruby libraries.
193
- </p>
194
- </dd>
195
- <dt>--librubyver=PATH</dt>
196
- <dd><p>
197
- The directory for standard ruby libraries.
198
- </p>
199
- </dd>
200
- <dt>--librubyverarch=PATH</dt>
201
- <dd><p>
202
- The directory for standard ruby extensions.
203
- </p>
204
- </dd>
205
- <dt>--siteruby=PATH</dt>
206
- <dd><p>
207
- The directory for version-independent non-standard
208
- ruby libraries
209
- </p>
210
- </dd>
211
- <dt>--siterubyver=PATH</dt>
212
- <dd><p>
213
- The directory for non-standard ruby libraries.
214
- </p>
215
- </dd>
216
- <dt>--siterubyverarch=PATH</dt>
217
- <dd><p>
218
- The directory for non-standard ruby extensions.
219
- </p>
220
- </dd>
221
- <dt>--rubypath=PATH</dt>
222
- <dd><p>
223
- The path to set to #! line.
224
- </p>
225
- </dd>
226
- <dt>--shebang=(all|ruby|never)</dt>
227
- <dd><p>
228
- Shenbang line (#!) rewriting mode.
229
- </p>
230
- <p>
231
- all: replace all shebang lines.
232
- </p>
233
- <p>
234
- ruby: replace shebang lines which invokes ruby.
235
- </p>
236
- <p>
237
- never: never rewrite shebang.
238
- </p>
239
- </dd>
240
- <dt>--rubyprog=PATH</dt>
241
- <dd><p>
242
- The ruby program using for installation.
243
- </p>
244
- </dd>
245
- <dt>--makeprog=NAME</dt>
246
- <dd><p>
247
- The make program to compile ruby extentions.
248
- </p>
249
- </dd>
250
- <dt>--without-ext</dt>
251
- <dd><p>
252
- Forces to setup.rb never to compile/install
253
- ruby extentions.
254
- </p>
255
- </dd>
256
- <dt>--rbconfig=PATH</dt>
257
- <dd><p>
258
- Your rbconfig.rb to load.
259
- </p>
260
- </dd>
261
- </dl>
262
- <p>
263
- If there's the directory named &quot;packages&quot;,
264
- You can also use these options:
265
- </p>
266
- <dl>
267
- <dt>--with=NAME,NAME,NAME...</dt>
268
- <dd><p>
269
- Package names which you want to install.
270
- </p>
271
- </dd>
272
- <dt>--without=NAME,NAME,NAME...</dt>
273
- <dd><p>
274
- Package names which you do not want to install.
275
- </p>
276
- </dd>
277
- </dl>
278
- <p>
279
- [NOTE] You can pass options to extconf.rb like this:
280
- </p>
281
- <pre>
282
- ruby setup.rb config -- --with-tklib=/usr/lib/libtk-ja.so.8.0
283
- </pre>
284
- <h2>Task Options for INSTALL</h2>
285
- <dl>
286
- <dt>--no-harm</dt>
287
- <dd><p>
288
- prints what to do and done nothing really.
289
- </p>
290
- </dd>
291
- <dt>--prefix=PATH</dt>
292
- <dd><p>
293
- The prefix of the installing directory path.
294
- This option may help binary package maintainers.
295
- A default value is an empty string.
296
- </p>
297
- </dd>
298
- </dl>
299
- </div>
300
-
301
- <div id="tigerops">
302
- <iframe src="http://tigerops.org/assets/adverts/banner-900-1.html" scrolling="no"></frame>
303
- </div>
304
-
305
- </body>
306
- </html>