Debian Codegraph @

INSTALL.ja.adoc

raw
1 // -*- coding: utf-8 -*-
2 :source-highlighter: pygments
3
4
5 = Gaucheのコンパイルとインストール
6
7 NOTE: Gaucheは開発中のシステムで、頻繁に更新しています。次のURLで最新の
8 情報が得られます:
9 https://practical-scheme.net/gauche/
10
11 このドキュメントでは、配布されるtarballからGaucheをコンパイルしてインストールする
12 方法を説明します。ソースリポジトリをcloneしてコンパイルする場合はさらに準備が必要です。
13 詳しくは link:HACKING.adoc[] ファイルを参照してください。
14
15
16 == 必要なもの
17
18
19 Unix環境の標準的なビルドツールとGNU makeが必要です。
20
21 それに加え、以下のツールとライブラリをあらかじめ入れておくことを
22 推奨します。無くてもGaucheはビルドできますが、一部機能が使えなくなります。
23
24 - Makeinfo (バージョン5.0以降) - infoドキュメントをビルドするのに使います。
25 入ってなければドキュメントはインストールされません (その場合、REPLでのオンラインドキュメント
26 も使えません)
27 - Gzip - 同じくドキュメントビルド時に使われます。
28 - Libiconv - 文字エンコーディング変換に使われます。下の説明も参照。
29 - link:https://tls.mbed.org/[Mbed TLS] - TLS/SSL接続に使われます。下の説明も参照。
30
31 他のオプショナルなライブラリについては以下で順次説明します。
32
33 Windows上では、MSYS/MinGWを使ってビルドできます。
34 詳しくはlink:doc/HOWTO-mingw.adoc[]を参照してください。
35
36
37 == 簡単な方法
38
39 [source,console]
40 ----
41 % ./configure
42 % make
43 % make check
44 % make install
45 ----
46
47 これで、Gaucheシステムが `/usr/local/bin`, `/usr/local/lib/gauche` 及び
48 `/usr/local/share/gauche` 以下にインストールされます。
49
50 既にGaucheがインストールされているシステムで、
51 全く同じconfigurationオプションで新しいバージョンのGaucheをインストール
52 する場合、`configure` の代わりに次のコマンドを使うこともできます。
53
54 [source,console]
55 ----
56 % gauche-config --reconfigure | sh
57 ----
58
59 `--reconfigure` オプションが与えられると、 `gauche-config` は現在
60 インストールされているGaucheがconfigureされた時のコマンドラインを
61 標準出力に書き出します。それをシェルに評価させれば、同じオプションで
62 configureすることができます。Gaucheをアップデートする場合に便利です。
63
64
65 == TLS/SSL のサポート
66
67 Gaucheはセキュアソケット通信にlink:https://tls.mbed.org/[MbedTLS]を
68 使っています。
69
70 デフォルトでは、システムにMbedTLSライブラリがあればそれを使い、
71 無ければTLSのサポートを組み込みません。
72 システムにMbedTLSをインストールできない事情があったり、
73 コンパイル後のバイナリだけを別環境に持ってゆくので依存ライブラリを減らしたい場合は、
74 ビルド中にMbedTLSのソースをダウンロードしてGaucheに組み込んでしまうこともできます。
75
76 [horizontal]
77 `--with-tls=none` :: do not include TLS/SSL support
78 `--with-tls=mbedtls` :: include only mbedTLS support
79 `--with-tls=mbedtls-internal` :: During the build, MbedTLS source is downloaded
80 and compiled with Gauche. See below.
81
82
83 `mbedtls-internal` を指定すると、ビルド中にMbedTLSのソースを
84 ダウンロードして、Gaucheの拡張ライブラリの一部として組み込みます。生成されるバイナリは
85 システムのMbedTLSライブラリには依存しないので、MbedTLSが入っていないターゲットシステムに
86 もバイナリをそのまま持って行けます。このオプションを使う場合はビルドにCMakeが必要です。
87 またその場合、`rfc--tls--mbed.so`および`libgauche-static-*.a`に
88 MbedTLSのコードが含まれるため、バイナリの配布にあたってはMbedTLSのライセンスにも従う
89 必要があります (Apache License 2.0)。
90
91 MbedTLSライブラリはコンパイル時にでマルチスレッド対応にするかどうかを
92 選べるようになっていますが、Gaucheではマルチスレッド対応でないと使えません。
93 システムのMbedTLSライブラリがマルチスレッド対応でコンパイルされていない場合は、
94 Gaucheに組み込むオプションを使ってください。
95
96 TLSを使う場合、サーバー証明書を認証するためにはCA(認証局)証明書が必要になります。
97 どこから証明書を探すかについて、いくつか選択肢を指定できます。
98
99 [horizontal]
100 `--with-ca-bundle=check` :: Use heuristics to find CA bundle (default)
101 `--with-ca-bundle=none` :: Do not set default CA bundle
102 `--with-ca-bundle=system` :: Use system CA bundle.
103 On MinGW, it accesses system CA store via
104 Windows API. Otherwise, it checks several
105 known paths used for popular systems.
106 `--with-ca-bundle=<path>` :: Use given path as the CA bundle file
107
108
109 詳しくはマニュアルの`rfc.tls`の項を参照してください。
110
111
112 == 共通コマンド名
113
114 Schemeの仕様を議論するSRFI (Scheme Requrests for Implementation) では、
115 準拠する実装について、特定のコマンド名を推奨していることがあります。それらのコマンド名は
116 他の処理系も使ってる可能性があるため、デフォルトではインストールされません。
117
118 オプション `--enable-shared-commands` を指定すると、以下のコマンドがインストールされます。
119
120 `scheme-r7rs`, `scheme-srfi-0`, `scheme-srfi-7`::
121 `gosh`の別名。
122
123 `compile-r7rs`::
124 `gauche-compile-r7rs`の別名。
125
126
127
128 == DBMデータベースのサポート
129
130 デフォルトでは、Gaucheはシステム中にgdbm, ndbm, odbm (original dbm)のライブラリ
131 があるかどうかを調べ、見つかったライブラリに対するインタフェースサポートをビルドします。
132
133 もし特定のdbmライブラリのサポートを除外したい場合は、configureスクリプトの`--with-dbm`
134 オプションに、*含めたいライブラリ*を列挙してください。例えば `--with-dbm=ndbm,odbm` と
135 すれば、gdbmがシステムにあってもそれらは含まれず、
136 ndbmとodbmのサポートだけビルドされます。いずれのライブラリサポートも含めたくなければ
137 `--with-dbm=no` と指定してください。
138
139
140 == 文字エンコーディング変換
141
142 GaucheはUnicode(UTF-8, 16, 32)、Latin-N、および代表的な日本語文字エンコーディングを
143 認識し変換することができますが、それ以外のエンコーディングに関しては、iconvが利用可能で
144 あればそれを利用して変換を行います。iconvが標準でインストールされていないシステムでは、
145 `--with-iconv` オプションで外部のiconvライブラリを利用することができます。
146
147 [source,sh]
148 ----
149 --with-iconv=DIR
150 ----
151
152
153 例えば `--with-iconv=/usr/local` とすれば、Gaucheは `iconv.h` を `/usr/local/include`
154 から、 `libiconv` を `/usr/local/lib` から探します。もしあなたのiconvライブラリが
155 libiconv以外の名前 ( `libmyconv` とか) だったとしたら、
156 `--with-iconv-lib=myconv` というオプションも指定して下さい。
157
158 外部のiconvライブラリとしては、Bruno Haible氏のlibiconvが以下から入手可能です。
159 https://www.gnu.org/software/libiconv/
160
161
162 == ローカルライブラリパス
163
164 Gaucheのビルドに、標準でない場所にインストールされているライブラリを
165 使用したい場合、次のオプションでその場所を指定することができます。
166
167 [source,sh]
168 ----
169 --with-local=PATH:PATH2:...
170 ----
171
172 これで、`PATH/include` 、`PATH2/include` 、... がインクルードパスに、
173 `PATH/lib` 、`PATH2/lib` 、... がライブラリサーチパスに追加されます。
174
175 例えば、`/usr/local` にインストールされたgdbmライブラリを使用したい
176 場合は次のようにします。
177
178 [source,sh]
179 ----
180 --with-local=/usr/local
181 ----
182
183
184 == SLIBの場所
185
186 link:http://people.csail.mit.edu/jaffer/SLIB[SLIB]は、
187 ポータブルなSchemeライブラリで、いろいろ便利な機能が
188 完全にSchemeで書かれています。GaucheはSLIBがインストールされていれば
189 その機能を利用することができます。
190
191 configureスクリプトは、 `/usr/local/slib` や `/usr/share/slib` などいくつかの基本的なディレクトリ
192 からSLIBを自動的に探します。もしあなたのSLIBシステムが標準的ではない場所に
193 インストールされていたら、次のオプションでその場所を指定してください。
194
195 [source,sh]
196 ----
197 ./configure --with-slib=PATH
198 ----
199
200 ここで、`PATH` はSLIBがインストールされたパスです。
201
202 GauchehはSLIB無しでも動作します。SLIBを使う必要がなければ、このオプションは
203 気にしなくてよいです。
204
205 SLIBは最初に使う前にGaucheのライブラリディレクトリにカタログファイルを
206 作成します。Gaucheのインストール時に既にSLIBが存在すればインストール
207 スクリプトがカタログファイルを作成しますが、Gaucheインストール後にSLIB
208 がインストールされた場合、最初にSLIBを使おうとした時点でカタログファイルが
209 作成されます。この時、Gauche使用者がライブラリディレクトリに書き込み権限を
210 持っていないとエラーとなります。書き込み権限を持つユーザが `gosh` を起動して
211 例えば次のような式を評価すればカタログファイルが正しく作られます。
212
213 [source,scheme]
214 ----
215 (use slib)
216 (require 'logical)
217 ----
218
219
220 == 実行時のライブラリパス
221
222 しばしば、環境のコントロールができない箇所でGaucheを走らせなければならない
223 場合があります。例えばCGIスクリプトをISPのサーバーで走らせる場合などです。
224 もし、Gaucheが標準的でない場所にインストールされた共有ライブラリに依存し
225 ている場合、それが問題となります。
226
227 例えば、最新の `libiconv.so` を自分でコンパイルして `/home/yours/lib` に
228 インストールしたとします。`--with-iconv=/home/yours/lib` としてconfigure
229 すれば、Gaucheはあなたのiconvを使うようにコンパイルされます。実行時に適切
230 な環境変数、例えば `LD_LIBRARY_PATH` などを設定しておけば、Gaucheの
231 インタプリタ `gosh` は `libiconv.so` を捜し出すことができます。しかし、
232 CGIスクリプトはWeb serverによって起動され、Web serverは `LD_LIBRARY_PATH`
233 を設定してくれないかもしれません。その場合、`gosh` は `libiconv.so` が見つけられずに
234 起動に失敗するかもしれません。
235
236 コンパイラによっては、プログラムが依存している共有ライブラリのパスをプログラム
237 本体に書き込んでしまえるオプションを持っています。 `configure` の `--with-rpath`
238 オプションはそれを利用します。 `--with-rpath=DIR` とすると、実行時に `DIR` から
239 共有ライブラリを探すような設定になります。このオプションは今のところ `gcc` でしか
240 動作しません。
241
242
243 == インストール先の指定
244
245 次のようにconfigureスクリプトを起動することにより、インストール先の
246 ディレクトリを指定できます。
247
248 [source,console]
249 ----
250 % ./configure --prefix=$PREFIX --exec-prefix=$EXEC_PREFIX
251 ----
252
253
254 `--prefix` オプションが指定されなければ、 `/usr/local` が指定されたものとみなされます。
255 `--exec-prefix` オプションが指定されなければ、 `EXEC_PREFIX` は `PREFIX` と同じものに
256 なります。
257
258
259 インストールされるファイルの内訳は以下の通りです。
260
261 `$EXEC_PREFIX/bin/*`::
262 インタプリタ (`gosh`) とコンフィグレーションスクリプト (`gauche-config`)
263
264 `$EXEC_PREFIX/lib/*`::
265 ライブラリ (`libgauche.a`).
266
267 `$PREFIX/share/gauche/VERSION/include/*`::
268 libgaucheをリンクするアプリケーションに必要なヘッダーファイル
269
270 `$PREFIX/share/gauche/VERSION/lib/*`::
271 マシンに依存しないSchemeファイル
272
273 `$PREFIX/share/info/*`::
274 infoファイル
275
276 `$EXEC_PREFIX/lib/gauche/VERSION/ARCHITECTURE/*`::
277 マシンに依存するファイル (`.so`, `gosh`, `gauche-config`, `libgauche.a`)
278
279 `$PREFIX/share/gauche/site/lib/*`::
280 `$EXEC_PREFIX/lib/gauche/site/VERSION/ARCHITECTURE/*`::
281 ユーザが独自にインストールするマシン非依存/依存ファイルのデフォルトの置き場所。
282
283
284 == 最適化オプション
285
286
287 Make時に、 `make` マクロ `OPTFLAGS` を用いて追加のコンパイルオプションを指定すること
288 ができます。 `configure` が設定する `OPTFLAGS` 以外のオプションを試したい場合は
289 次のように `make` を走らせて下さい。
290
291 [source,sh]
292 ----
293 make OPTFLAGS="--some-compiler-option --other-option"
294 ----
295
296
297 == アンインストール
298
299 インストールされたGaucheソフトウェアを取り除くには、ソースツリーのトップ
300 ディレクトリで
301
302 [source,sh]
303 ----
304 make uninstall
305 ----
306
307 として下さい。
308
309
310 == クロスコンパイル
311
312 Gaucheはautotool標準のクロスコンパイルをサポートしています。
313 つまり、 `configure` スクリプトに `--build` と `--host` オプションを与えて
314 makeするだけです (クロス開発に必要なツールはもちろんインストールされているとします)。
315 ただ、二つばかり気をつけることがあります。
316
317 - クロスコンパイルしようとしているのと同じバージョンのGaucheをビルドマシンに
318 インストールしておいてください。
319 +
320 通常のビルドでは、Gaucheは作ったばかりの `gosh` を使って `ext/` 以下の拡張
321 ライブラリをビルドします。クロスコンパイル時には、作ったばかりの `gosh` は
322 ビルドマシンでは実行できないので、既にビルドマシンにインストールされている
323 `gosh` を使うことになります。
324
325 - `./configure` に `--with-libatomic-ops=no` オプションが必要かもしれません。
326 +
327 このオプションをつけることで、システムにインストールされている `libatomic_ops`
328 ではなく同梱されたソースを使うようになります。どうもconfigureスクリプトが
329 ビルドシステム用の `libatomic_ops` をホスト用と誤認するケースがあるようです。
330
331 例として、次のコマンドラインで、Windows (mingw-w64 32bit) 用バイナリを
332 あなたのシステム上でクロスコンパイルできます:
333
334 [source,sh]
335 ----
336 ./configure --build=`./config.guess` \
337 --host=i686-w64-mingw32 \
338 --with-libatomic-ops=no \
339 --prefix=/usr/local
340 ----
341
342 == 機種依存の情報
343
344
345 * MacOS X - 10.15 (Catalina) では、ダウンロードしたtarballから取り出されたファイル
346 はセキュリティ機構にマークされているため、ビルド時に必要なシェルスクリプトを実行できません。
347 tarballを展開した後、次のコマンドを実行してください。(VERSIONは配布バージョンに
348 置き換えてください)。
349 tarballが真正のものであるかどうかは、https://practical-scheme.net/vault/ に置いてある
350 asc署名で確認してください。
351 +
352 [source,sh]
353 ----
354 xattr -r -d com.apple.quarantine Gauche-VERSION/
355 ----
356
357 * IRIX with 64bit binary - デフォルトの32bit ABIではなく64bit ABIでコンパイル
358 したい場合は次のようにして下さい。
359 +
360 [source,sh]
361 ----
362 CC="cc -64" AS="as -64" ./configure
363 ----
364
365 * Linux/Crusoe TM5800 - 最近のLinuxでは Crusoe TM5800がi686互換とされる
366 ようになったようですが、gc中でi686特有のprefetch命令を使っているところ
367 でコンパイルに失敗するという報告がありました。
368 この場合は以下のように環境依存の最適化を無効にして下さい。
369 +
370 [source,sh]
371 ----
372 ./configure --disable-heuristic-optimization
373 ----