« back to all changes in this revision
Viewing changes to Usage_en.txt
- browse files at revision 1
- compare with another revision
- download diff
- download tarball
- view history from revision 1
- Committer: Bazaar Package Importer
- Author(s): Vincent Fourmond
- Date: 2011-05-30 14:15:58 UTC
- Revision ID: james.westby@ubuntu.com-20110530141558-cir7zvym1mgqrqry
Tags: upstream-3.4.1
Import upstream version 3.4.1
- files added:
- doc.en
- doc.ja
- sample
- test
added
removed
Usage_en.txt
1
Installing Programs with setup.rb
2
=================================
3
4
Quick Start
5
-----------
6
7
Type this (You might needs super user previledge):
8
9
($ su)
10
# ruby setup.rb
11
12
If you want to install a program in to your home directory
13
($HOME), use following instead:
14
15
$ ruby setup.rb all --prefix=$HOME
16
17
Detailed Installtion Process
18
----------------------------
19
20
setup.rb invokes installation by three steps. There are
21
"config", "setup" and "install". You can invoke each steps
22
separately as following:
23
24
$ ruby setup.rb config
25
$ ruby setup.rb setup
26
# ruby setup.rb install
27
28
You can controll installation process by giving detailed
29
options for each tasks. For example, --bin-dir=$HOME/bin
30
let setup.rb install commands in $HOME/bin.
31
32
For details, see "Task Options".
33
34
Global Options
35
--------------
36
37
"Global Option" is a command line option which you can use
38
for all tasks. You must give a global option before any task
39
name.
40
41
-q,--quiet
42
43
suppress message outputs
44
45
--verbose
46
47
output messages verbosely (default)
48
49
-h,--help
50
51
prints help and quit
52
53
-v,--version
54
55
prints version and quit
56
57
--copyright
58
59
prints copyright and quit
60
61
Tasks
62
-----
63
64
These are acceptable tasks:
65
66
all
67
68
Invokes `config', `setup', then `install'.
69
Task options for all is same with config.
70
71
config
72
73
Checks and saves configurations.
74
75
show
76
77
Prints current configurations.
78
79
setup
80
81
Compiles ruby extentions.
82
83
install
84
85
Installs files.
86
87
test
88
89
Invokes tests.
90
91
clean
92
93
Removes created files.
94
95
distclean
96
97
Removes all created files.
98
99
Task Options for CONFIG/ALL
100
---------------------------
101
102
You can pass following long options for CONFIG task
103
and ALL task.
104
105
All options accept parameterized value, like
106
--rbdir=$siterubyver or --sodir=$siterubyverarch.
107
On UNIX shells, you should escape "$" character,
108
so use --rbdir=\$siterubyver or --sodir=$siterubyverach.
109
110
--installdirs=(std|site|home)
111
112
A handy option to set common install target.
113
114
std: install files under $libruby.
115
116
site: install files under $siteruby.
117
118
home: install files under home directory ($HOME).
119
120
--prefix=PATH
121
122
The path prefix of target directory pathes like $bindir, $libdir...
123
124
--bindir=PATH
125
126
The directory for commands.
127
128
--rbdir=PATH
129
130
The directory for ruby scripts.
131
132
--sodir=PATH
133
134
The directory for ruby extentions.
135
136
--datadir=PATH
137
138
The directory for shared data.
139
140
--sysconfdir=PATH
141
142
The directory for configuration files.
143
144
--mandir=PATH
145
146
The directory for manual pages.
147
148
--libruby=PATH
149
150
The directory for ruby libraries.
151
152
--librubyver=PATH
153
154
The directory for standard ruby libraries.
155
156
--librubyverarch=PATH
157
158
The directory for standard ruby extensions.
159
160
--siteruby=PATH
161
162
The directory for version-independent non-standard
163
ruby libraries
164
165
--siterubyver=PATH
166
167
The directory for non-standard ruby libraries.
168
169
--siterubyverarch=PATH
170
171
The directory for non-standard ruby extensions.
172
173
--rubypath=PATH
174
175
The path to set to #! line.
176
177
--shebang=(all|ruby|never)
178
179
Shenbang line (#!) rewriting mode.
180
181
all: replace all shebang lines.
182
183
ruby: replace shebang lines which invokes ruby.
184
185
never: never rewrite shebang.
186
187
--rubyprog=PATH
188
189
The ruby program using for installation.
190
191
--makeprog=NAME
192
193
The make program to compile ruby extentions.
194
195
--without-ext
196
197
Forces to setup.rb never to compile/install
198
ruby extentions.
199
200
--rbconfig=PATH
201
202
Your rbconfig.rb to load.
203
204
If there's the directory named "packages",
205
You can also use these options:
206
207
--with=NAME,NAME,NAME...
208
209
Package names which you want to install.
210
211
--without=NAME,NAME,NAME...
212
213
Package names which you do not want to install.
214
215
[NOTE] You can pass options to extconf.rb like this:
216
217
ruby setup.rb config -- --with-tklib=/usr/lib/libtk-ja.so.8.0
218
219
Task Options for INSTALL
220
------------------------
221
222
--no-harm
223
224
prints what to do and done nothing really.
225
226
--prefix=PATH
227
228
The prefix of the installing directory path.
229
This option may help binary package maintainers.
230
A default value is an empty string.
231
Loggerhead is a web-based interface for Breezy
Version: 2.0.1