Annotation of OpenXM/doc/install.oxweave, Revision 1.21
1.21 ! takayama 1: %% $OpenXM: OpenXM/doc/install.oxweave,v 1.20 2000/02/01 05:18:28 takayama Exp $
1.1 takayama 2: OpenXM/doc/install.oxweave
3:
1.6 takayama 4: /*&C
5: OpenXM URL : http://www.math.kobe-u.ac.jp/OpenXM
1.16 takayama 6: Consult firstly the ERRATA section for your release on this web cite
7: for troubles.
1.6 takayama 8:
9: OpenXM package : Getting started.
10:
11: */
1.1 takayama 12: /*&jp
1.6 takayama 13: ★ OpenXM パッケージの利用方法
14: この節では, OpenXM package binary distribution のインストール法を説明します.
15: インストールに必要なシステムの仕様については, 動作環境を御覧ください.
1.1 takayama 16: */
17: /*&eg
1.6 takayama 18: ***** HOW TO USE OpenXM PACKAGE?
19: In this section, we will explain how to install OpenXM package binary
20: distribution.
21: As to the required environment, see the section "System Requirement"
22: */
23: /*&jp
24:
25: (1) Tar ボールより次のようにしてディレクトリ OpenXM を取り出します.
1.13 takayama 26: OpenXM はどこにおいてもかまいません. ルートになってインストール
27: する必要もありません.
28: できれば, /usr/local/OpenXM においてほしいと思います.
1.6 takayama 29:
1.1 takayama 30: */
1.6 takayama 31: /*&eg
1.1 takayama 32:
1.6 takayama 33: (1) Extract the directory OpenXM from the tar ball.
34: You can put the directory OpenXM at any place in the file system.
1.13 takayama 35: You do not need to be a root to install it.
36: We are happy if you put OpenXM at /usr/local/OpenXM
1.2 takayama 37:
38: */
1.6 takayama 39: /*&C
40: tar xzvf OpenXM-binary-OPERATING_SYSTEM_CPU_TYPE.tgz
41:
1.2 takayama 42: */
1.6 takayama 43: /*&jp
44: 以下 (1) で生成されたディレクトリ OpenXM の絶対パスを /xxx/yyy/OpenXM
45: と書きます.
46:
1.1 takayama 47: */
1.6 takayama 48: /*&eg
49: In the sequel, we will denote the absolute path of the directory OpenXM
50: by /xxx/yyy/OpenXM.
1.1 takayama 51:
52: */
53: /*&jp
1.19 takayama 54: (2) 次のように入力して OpenXM/rc/dot.cshrc, OpenXM/rc/dot.bashrc,
55: OpenXM/rc/openxm
1.6 takayama 56: ファイルを自動生成します.
57: これらのファイルには, OpenXM/bin のファイルを実行するための
58: 環境変数が定義されています.
59:
1.5 takayama 60: */
61: /*&eg
1.19 takayama 62: (2) Generate OpenXM/rc/dot.cshrc, OpenXM/rc/dot.bashrc and
63: OpenXM/rc/openxm
1.6 takayama 64: by the following command.
65: Environmental variables to execute commands in OpenXM/bin
66: are defined in these files.
67:
1.5 takayama 68: */
1.6 takayama 69: /*&C
70:
1.8 takayama 71: cd /xxx/yyy/OpenXM/rc
1.6 takayama 72: make
1.5 takayama 73:
74: */
75: /*&jp
1.6 takayama 76: (3) csh を利用してる場合, 次の行を ~/.cshrc の最後に加えます.
77:
1.1 takayama 78: */
79: /*&eg
1.6 takayama 80: (3) Append the following line to the end of ~/.cshrc when you are
81: using csh as your shell.
82:
1.1 takayama 83: */
84: /*&C
1.2 takayama 85:
1.6 takayama 86: source /xxx/yyy/OpenXM/rc/dot.cshrc
1.2 takayama 87:
1.1 takayama 88: */
89: /*&jp
1.6 takayama 90: (3') bash を利用してる場合, 次の行を ~/.bashrc の最後に加えます.
91:
1.1 takayama 92: */
93: /*&eg
1.6 takayama 94: (3') Append the following line to the end of ~/.bashrc when you are
95: using bash as your shell.
96:
97: */
98: /*&C
99:
1.18 takayama 100: source /xxx/yyy/OpenXM/rc/dot.bashrc
1.6 takayama 101:
1.1 takayama 102: */
1.14 takayama 103:
104: /*&jp
105:
106: (3) または (3') を終了したら, いったん logout して login しなおすか
1.18 takayama 107: または, source コマンドで, dot.bashrc または dot.csh を読み込んで下さい.
1.19 takayama 108: (3) または (3') をやらないという選択もあります.
109: この場合, シェルスクリプト
110: OpenXM/rc/openxm を コマンドサーチパスに移し,
111: OpenXM/bin 以下の全てのコマンドの実行は,
112: openxm コマンド名
113: という形で呼び出します.
114: たとえば, openxm asir とか openxm sm1 という形でよびだします.
1.14 takayama 115:
116: */
117: /*&eg
118:
119: After finishing the step (3) or (3'), logout and login again,
1.18 takayama 120: or read dot.bashrc or dot.cshrc file by the source command.
1.19 takayama 121: You may skip the step (3) or (3').
122: In this case, move the shell script OpenXM/rc/openxm to your
123: command search path. To execute commands in OpenXM/bin, type in
124: openxm command-name
125: For example, "openxm asir" starts asir and "openx sm1" starts sm1
126: with a proper setting of environmental variables.
1.14 takayama 127:
128: */
129:
1.6 takayama 130:
1.2 takayama 131: //&C
1.13 takayama 132: //&jp (4) asir の利用には key が必要です.
133: //&eg (4) You need a key to use asir.
1.2 takayama 134: //&C
1.13 takayama 135: /*&jp
136: asir の起動時のメッセージまたは OpenXM/lib/asir/asir_key を
137: 参照して, key を取得して下さい (数秒しかかかりません).
138:
139: */
140: /*&eg
141: Please get the key by following the instruction from asir itself or
142: that in OpenXM/lib/asir/asir_key (it takes only a few seconds
143: to get the key).
144:
145: */
1.6 takayama 146:
147: /*&C
1.8 takayama 148:
149: ***** QUALITY:
150: the following modules and functions have still experimental qualities:
1.6 takayama 151: OpenXM/bin/k0, OpenXM/bin/d0
152: OpenXM/bin/ox_math, OpenXM/bin/math2ox
153: OpenXM/lib/java-support/ *
154: Asir client functions: m_* (Mathematica) , om_* (OpenMath)
1.11 takayama 155: OpenXM/bin/sm1, ox_sm1 on Linux libc6.
1.6 takayama 156: */
157: /*&C
158:
159:
1.8 takayama 160: */
161: /*&jp
162: ★ Java に関する注意:
163: 注意 1.
164: OpenMath 用の OMproxy には現在のところ, jdk が必要です.
165: たとえば bash を利用している場合, .bashrc で
166: PATH=/usr/local/jdk1.1.8/bin:$PATH
167: export PATH
1.10 takayama 168: などとして, jdk の java, javac をサーチパスの先のほうへもっていくようにして
1.8 takayama 169: ください.
1.10 takayama 170: csh を利用している場合, .cshrc で
171: set path=(/usr/local/jdk1.1.8/bin $path)
172: として, jdk の java, javac をサーチパスにいれます.
1.17 takayama 173:
174: 注意:
175: なお, Kaffe 1.0.b4 の java は, class BigInteger に method
176: toByteArray が含まれてないため, OpenMath モジュールでは使用できません.
1.8 takayama 177: */
178: /*&eg
179: ***** JAVA
180: In order to use OMproxy, asir client om_*,
181: you need to install JDK.
182: The bin dir of the JDK must be in yur search path.
183: For example, you need to add the following line
1.10 takayama 184: to your .chsrc when your shell is csh
1.8 takayama 185: set path=(/usr/local/jdk1.1.8/bin $path)
1.10 takayama 186: Bash users put the following line to .bashrc
187: PATH=/usr/local/jdk1.1.8/bin:$PATH
188: export PATH
1.17 takayama 189:
190: Remark:
191: The Java interpreter of Kaffe 1.0.b4 does not contain the method
192: toByteArray in the class BigInteger.
193: So, it cannot be used for the OpenMath module.
1.8 takayama 194: */
195:
196: /*&C
197:
198:
1.6 takayama 199:
200:
201: */
202: /*&jp
203: ★ 動作環境
204:
205: */
206: /*&eg
1.7 takayama 207: ***** SYSTEM REQUIREMENTS
1.6 takayama 208:
209: */
210: /*&C
211:
1.11 takayama 212: OS: FreeBSD 3.3 (Intel CPU),
213: Linux systems (Intel CPU):
1.15 takayama 214: Most Linux with libc5 and with libc6 (glibc 2.x).
1.7 takayama 215:
216: X window system is required.
217:
218: Most part of the OpenXM package may work on other versions of
1.11 takayama 219: FreeBSD 3.x and Linux, but we have not yet tested.
1.6 takayama 220:
221: */
222: /*&jp
1.8 takayama 223: 次の modules は, OS の標準 distribution 以外に, さらに下に記したソフトを
1.6 takayama 224: 必要とします.
225: */
226: /*&eg
227: The following modules require the listed softwares other than the standard
228: OS package.
229: */
230: /*&C
231:
232: (1) OpenXM/bin/ox_math : Mathematica Version 3.x or 4.x
233: (Mathematica server) at /usr/local/Mathematica
234: OpenXM/bin/math2ox [ see http://www.wolfram.com ]
235: Asir client functions m_*
236: (2) OpenXM/lib/java-support : JDK at /usr/local/jdk??
1.8 takayama 237: [ see the section on JAVA]
1.6 takayama 238: Asir client functions om_*
239: sm1 client functions om_*
1.7 takayama 240: (3) PHC pack (OpenXM/bin/phc) and asir client functions
241: phc_* run only on linux (glib5).
1.8 takayama 242: If you install the linux emulation^{note 1} on Free BSD, they run on
243: FreeBSD, too.
244: <note 1>
245: Add linux_enable="YES" in /etc/rc.conf
246: You need the following packages:
247: pkg_info | grep linu
248: linux_base-5.2 The base set of packages needed in Linux mode
249: linux_devtools-5.2 Packages needed for doing development in Linux mode
1.6 takayama 250:
251: */
252:
253:
1.1 takayama 254: /*&jp
1.7 takayama 255: 日本語版の注意.
1.3 maekawa 256: 注意 1.
257: asir で日本語のヘルプを利用するには,
1.1 takayama 258: PAGER=jless
259: export PAGER
1.3 maekawa 260: などで, 日本語を扱える PAGER を指定する必要があるかもしれません.
1.1 takayama 261: */
1.7 takayama 262:
263: /*&eg
264:
1.8 takayama 265: The installation is completed.
1.7 takayama 266:
267: */
268: /*&jp
269:
270: 以上.
271:
272: */
273:
1.1 takayama 274: /*&jp
1.7 takayama 275: ★ 文書
276:
277: OpenXM パッケージでもっとも充実しているクライアントは,
278: asir です.
279: asir のつかいかたは
280: OpenXM/doc/asir2000/man-jp.dvi
281: または OpenXM/doc/asir2000/html-jp の HTML ファイルを見て下さい.
282: asir 用 OpenXM クライアントライブラリのつかい方は,
283: OpenXM/doc/asir-contrib/cman-jp.dvi
284: を見て下さい. dvi の付くファイルは xdvi で見ることができます.
285:
286: OpenXM の設計の概要については,
287: OpenXM/doc/issac2000/issac2000.ps
288: を見て下さい.
289: ps の付くファイルは, ghostview で見ることができます.
290:
291: */
292: /*&eg
293: ***** DOCUMENTS
294:
295: The best OpenXM client in the OpenXM package is now
296: asir.
297: Documents on asir are
298: OpenXM/doc/asir2000/man-eg.dvi
299: OpenXM/doc/asir2000/html-eg (HTML)
300:
301: The file
302: OpenXM/doc/asir-contrib/cman-eg.dvi
303: is a document on OpenXM client libraries for asir.
1.1 takayama 304:
1.7 takayama 305: The design outline is described in
306: OpenXM/doc/issac2000/issac2000.ps
307:
308: Dvi files can be previewed by xdvi and
309: ps files can be previewed by ghostview.
310: */
1.1 takayama 311:
312:
1.8 takayama 313: /*&eg
314:
315:
316: ***** A QUICK TOUR OF OPENXM BY ASIR
317:
318: */
1.7 takayama 319: /*&jp
1.1 takayama 320:
321:
1.8 takayama 322: ★ ASIR による使用例
1.1 takayama 323:
324:
1.3 maekawa 325: asir を動作させるには, key が必要です.
1.8 takayama 326: OpenXM/lib/asir/asir_key のコメントまたは起動時のメッセージをみて,
327: key を E-mail でとりよせて下さい.
1.1 takayama 328:
1.8 takayama 329: */
330: /*&C
331: ---------------- Call ox_sm1 from asir.
332: bash-2.03$ asir
333: This is Risa/Asir, Version 20000120.
334: Copyright (C) FUJITSU LABORATORIES LIMITED.
335: 1994-1999. All rights reserved.
336: xm Version 20000116. ox_help(0); ox_help("keyword"); for help message
337: [269] sm1_genericAnn([x^3-y^2,[s,x,y]]);
338: /* The annihilating ideal of (x^3-y^2)^s */
339: [-2*y*dx-3*x^2*dy,2*x*dx+3*y*dy-6*s]
340:
341:
342: --------------- Call gnuplot from asir.
343: bash-2.03$ asir
344: This is Risa/Asir, Version 20000120.
345: Copyright (C) FUJITSU LABORATORIES LIMITED.
346: 1994-1999. All rights reserved.
347: xm Version 20000116. ox_help(0); ox_help("keyword"); for help message
348: [269] gnuplot("plot sin(x);");
349: 0
350: [270]
1.13 takayama 351:
352: */
353:
354: /*&jp
355:
356: ★ sm1 クライアントの利用例
357:
358: */
359: /*&eg
360:
361: ****** Example of the use of sm1 client
1.1 takayama 362:
1.8 takayama 363: */
1.1 takayama 364:
1.8 takayama 365: /*&C
366: -------------------------------------- call ox_asir from sm1
1.1 takayama 367: sm1
368: (oxasir.sm1) run ;
1.8 takayama 369: [(x^20-y^20) (x,y)] fctr pmat ; factorize x^20-y^20 by call ox_asir
1.1 takayama 370:
371:
1.8 takayama 372: */
1.1 takayama 373:
1.8 takayama 374: /*&jp
1.5 takayama 375: [著作権表示]
376: OpenXM/Copyright を御覧ください.
1.6 takayama 377: */
1.8 takayama 378: /*&eg
379: [COPYRIGHT]
380: See OpenXM/Copyright.
381: */
382:
383: /*&eg
384:
1.6 takayama 385:
1.7 takayama 386:
1.8 takayama 387: ***** TO COMPILE FROM A SOURCE *****
1.7 takayama 388:
389: */
1.6 takayama 390: /*&jp
1.8 takayama 391:
392:
1.6 takayama 393: ★ OpenXM パッケージの Make 法
394: FreeBSD 2.2.8, FreeBSD 3.3, Linux で動作するものと期待してます.
1.8 takayama 395: Linux glib6 では, いまのところ, /usr/include/features.h
1.20 takayama 396: で #define __FAVOR_BSD 1 してコンパイルする必要がありしたが,
397: 一部のソースを
398: -D_BSD_SOURCE option をつけて gcc でコンパイルするように変えてます
399: (setjmp と sigsetjmp の問題, dirty trick).
1.8 takayama 400:
1.6 takayama 401: OpenXM, OpenXM_contrib, OpenXM_contrib2 が必要です.
402: cvs コミッタの場合次のようにしてソースをとりよせます.
403: */
404: /*&eg
405: * How to make OpenXM package?
406: We have tested the OpenXM package on FreeBSD 2.2.8, FreeBSD 3.3, Linux.
1.20 takayama 407: On Linux glib6, we needed to define
1.8 takayama 408: #define __FAVOR_BSD 1
1.20 takayama 409: in /usr/include/features.h,
410: but now we are compiling some sources with -D_BSD_SOURCE
411: (setjmp vs sigsetjmp).
1.8 takayama 412:
1.6 takayama 413: Do you have directories OpenXM, OpenXM_contrib, OpenXM_contrib2?
414: If you are a CVS committer, then you can get all sources as follows:
415: */
416: //&C rcvs checkout OpenXM OpenXM_contrib OpenXM_contrib2
417: //&C
418: //&jp これらがそろっていたらあとは次のように入力するだけです.
419: //&eg Check that you have these directories, then just type in the following commands
420: /*&C
421:
422: cd OpenXM/src
423: make configure
424: make
425: make install
426:
427: */
428: /*&jp なお, OpenXM/src/ox_math のコンパイルおよび利用には Mathematica が,
429: OpenXM/src/OpenMath のコンパイルおよび利用には
430: には, jdk (java 環境) が必要です.
1.12 takayama 431:
432: Documents を生成するには, tex, ptex (ascii 日本語 tex), dvips, texinfo,
433: texi2html, nkf,
434: が必要です. 詳しくは Makefiles を見て下さい.
435: Document は, binary distribution の OpenXM/doc, OpenXM/lib
436: より得るのが簡単です.
1.6 takayama 437: */
438: /*&eg In order to use and compile OpenXM/src/ox_math, you need Mathematica.
439: In order to use and compile OpenXM/src/OpenMath,
440: you need jdk (java environment).
1.12 takayama 441:
442: In order to generate the full documentation including Japanese documents,
443: you need tex, ptex (ASCII Inc. Japanese tex), dvips, texinfo, texi2html,
444: nkf. See each Makefile.
445: The generated documents are in OpenXM/doc and OpenXM/lib
446: in the binary distribution.
1.15 takayama 447: If you do not like to install Japanese environment such as ptex,
448: type in R for the tex error prompt ? or
449: prepare empty shell scripts ptex and nkf.
1.6 takayama 450: */
451: /*&C
1.9 takayama 452:
453: */
454: /*&jp
455:
456: OpenXM_contrib2/asir2000 の配布を受けてない場合 (ソースライセンスを
457: 富士通より受ける必要があります),
458: OpenXM/src/Makefile の各モジュール名 たとえば
459: make all-kan96xx
460: などと各モジュール名を指定してコンパイルして下さい.
461:
462: */
463: /*&eg
464:
465: If you cannot get a source liscence of OpenXM_contrib2/asir2000
466: from Fujitsu labs,
467: compile each modules independently, e.g.,
468: make all-kan96xx
1.1 takayama 469:
1.6 takayama 470: */
1.1 takayama 471:
1.6 takayama 472: /*&jp
1.1 takayama 473:
1.8 takayama 474: [OpenXM 下のファイルの構成メモ]
1.3 maekawa 475: lib/asir には, asir のライブラリ, ox_asir 本体
476:
1.8 takayama 477: cd OpenXM/src/kxx ; make install-for-debug した場合,
1.3 maekawa 478: lib/sm1 は src/SSkan/Doc への symbolic link
479: であり, sm1 のライブラリファイルが格納されています.
480: lib/sm1/bin には, binaryfiles
1.1 takayama 481: sm1, ox_sm1, ox, ox_log, ox_sm1_*
1.3 maekawa 482: へのシンボリックリンクが格納されます.
1.8 takayama 483: このシンボリックリンクは src/kxx で make install-for-debug を実行することにより
1.3 maekawa 484: 作成されます.
1.1 takayama 485:
1.3 maekawa 486: sm1 が ox_asir を利用するのに必要なファイル.
1.1 takayama 487: lib/asir/ox_asir,
488: lib/sm1/bin/ox, lib/sm1/bin/ox_log (src/kxx/ox, src/kxx/ox_log)
489: lib/sm1/ox.sm1, lib/sm1/oxasir.sm1
490:
1.3 maekawa 491: asir が ox_sm1_forAsir を利用するのに必要なファイル:
1.1 takayama 492: lib/asir/ox_launch
1.3 maekawa 493: lib/sm1/bin/ox_sm1_forAsir (ox_sm1 へのリンク)
1.1 takayama 494: lib/asir/xm
1.3 maekawa 495: lib/sm1/ 以下の *.sm1 なるすべての ライブラリファイル.
1.1 takayama 496: callsm1.sm1 callsm1b.sm1
1.3 maekawa 497: (ox_sm1_forAsir の定義ファイル, src/kxx/oxserver00.c
498: ox_sm1 が ox_sm1_forAsir という名前で呼ばれるとこれらのファイルをロード.)
1.1 takayama 499:
1.3 maekawa 500: asir が ox_sm1_gnuplot を利用するのに必要なファイル:
1.1 takayama 501: lib/asir/ox_launch
1.3 maekawa 502: lib/sm1/bin/ox_sm1_gnuplot (ox_sm1 へのリンク, ox_sm1_gnuplot は fork して
1.4 maekawa 503: gnuplot4ox を実行します.)
1.1 takayama 504: lib/asir/xm
505: lib/sm1/callsm1.sm1, lib/sm1/gnuplot.sm1
1.3 maekawa 506: (ox_sm1_gnuplot の定義ファイル, src/kxx/oxserver00.c
507: ox_sm1 が ox_sm1_gnuplot という名前で呼ばれるとこれらのファイルをロード.)
1.4 maekawa 508: bin/gnuplot4ox, bin/gnuplot_x11 (gnuplot 本体, src/gnuplot*)
1.1 takayama 509:
510: ----------------------------------------
1.3 maekawa 511: [開発者用メモ]
1.1 takayama 512:
1.3 maekawa 513: << sm1, ox_sm1, ox, oxlog の debug >>
514: binary file は各 directory の make install により
515: OpenXM/bin にコピーされますが,
516: debug 用にいちいちコピーするのは面倒なので,
1.8 takayama 517: OpenXM/src/kan96xx で make install-for-debug
518: OpenXM/src/kxx で make install-for-debug
1.3 maekawa 519: を実行すると,
520: OpenXM/bin/sm1, ox, ox_sm1, oxlog より,
1.1 takayama 521: OpenXM/src/kan96xx/Kan/sm1
522: OpenXM/src/kxx/ox, OpenXM/src/kxx/ox_sm1, OpenXM/src/kxx/oxlog
1.3 maekawa 523: へのシンボリックリンクが作成されます.
1.1 takayama 524:
1.3 maekawa 525: [CVSコミッタ用メモ]
526: << OpenXM ディレクトリ配布版の作成方法 >>
1.1 takayama 527: rcvs export -rHEAD OpenXM
528: rcvs export -rHEAD OpenXM_contrib
529: rcvs export -rHEAD OpenXM_contrib2
1.21 ! takayama 530: cd OpenXM/src ; make generate-source-distribution
1.3 maekawa 531: して, OpenXM, OpenXM_contrib, OpenXM_contrib2 全体を tar+gzip.
1.7 takayama 532: */
533:
534: /*&C
535:
536: */
537: /*&jp
538:
539: ★ Solaris に関する注意.
540: Solaris ではまだ問題が山積してます.
541: Solaris での make の問題点については, OpenXM/doc/OpenXM-FAQ-jp.txt
542: を見てください.
1.8 takayama 543: Solaris でコンパイルするには, /usr/ccs/bin をサーチパスの最初へもっていって
544: おきます.
1.7 takayama 545:
546: */
1.8 takayama 547: /*&eg
548: ***** COMPILE ON SOLARIS
549: There are a lot of troubles on Solaris for now.
550: At least,
551: /usr/ccs/bin must be at the top of the command search path to compile
552: on Solaris.
553: */
554:
1.7 takayama 555:
556: /*&C
557:
1.1 takayama 558: */
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>