=================================================================== RCS file: /home/cvs/OpenXM/doc/install.oxweave,v retrieving revision 1.5 retrieving revision 1.19 diff -u -p -r1.5 -r1.19 --- OpenXM/doc/install.oxweave 2000/01/18 12:41:13 1.5 +++ OpenXM/doc/install.oxweave 2000/01/27 01:13:17 1.19 @@ -1,196 +1,483 @@ -%% $OpenXM: OpenXM/doc/install.oxweave,v 1.4 2000/01/07 22:24:17 maekawa Exp $ +%% $OpenXM: OpenXM/doc/install.oxweave,v 1.18 2000/01/26 07:48:10 takayama Exp $ OpenXM/doc/install.oxweave +/*&C +OpenXM URL : http://www.math.kobe-u.ac.jp/OpenXM +Consult firstly the ERRATA section for your release on this web cite +for troubles. + +OpenXM package : Getting started. + +*/ /*&jp -★ OpenXM パッケージの Make 法 - FreeBSD 2.2.8, FreeBSD 3.3, Linux で動作するものと期待してます. - OpenXM, OpenXM_contrib, OpenXM_contrib2 が必要です. - cvs コミッタの場合次のようにしてソースをとりよせます. +★ OpenXM パッケージの利用方法 +この節では, OpenXM package binary distribution のインストール法を説明します. +インストールに必要なシステムの仕様については, 動作環境を御覧ください. */ /*&eg -* How to make OpenXM package? - We have tested the OpenXM package on FreeBSD 2.2.8, FreeBSD 3.3, Linux. - Do you have directories OpenXM, OpenXM_contrib, OpenXM_contrib2? - If you are a CVS committer, then you can get all sources as follows: +***** HOW TO USE OpenXM PACKAGE? +In this section, we will explain how to install OpenXM package binary +distribution. +As to the required environment, see the section "System Requirement" */ -//&C rcvs checkout OpenXM OpenXM_contrib OpenXM_contrib2 -//&C -//&jp これらがそろっていたらあとは次のように入力するだけです. -//&eg Check that you have these directories, then just type in the following commands +/*&jp + +(1) Tar ボールより次のようにしてディレクトリ OpenXM を取り出します. + OpenXM はどこにおいてもかまいません. ルートになってインストール + する必要もありません. + できれば, /usr/local/OpenXM においてほしいと思います. + +*/ +/*&eg + +(1) Extract the directory OpenXM from the tar ball. + You can put the directory OpenXM at any place in the file system. + You do not need to be a root to install it. + We are happy if you put OpenXM at /usr/local/OpenXM + +*/ /*&C + tar xzvf OpenXM-binary-OPERATING_SYSTEM_CPU_TYPE.tgz - cd OpenXM/src - make configure - make - make install +*/ +/*&jp +以下 (1) で生成されたディレクトリ OpenXM の絶対パスを /xxx/yyy/OpenXM +と書きます. */ -/*&jp なお, OpenXM/src/ox_math のコンパイルおよび利用には Mathematica が, -OpenXM/src/OpenMath のコンパイルおよび利用には -には, jdk (java 環境) が必要です. +/*&eg +In the sequel, we will denote the absolute path of the directory OpenXM +by /xxx/yyy/OpenXM. + */ -/*&eg In order to use and compile OpenXM/src/ox_math, you need Mathematica. -In order to use and compile OpenXM/src/OpenMath, -you need jdk (java environment). +/*&jp +(2) 次のように入力して OpenXM/rc/dot.cshrc, OpenXM/rc/dot.bashrc, + OpenXM/rc/openxm + ファイルを自動生成します. + これらのファイルには, OpenXM/bin のファイルを実行するための + 環境変数が定義されています. + */ +/*&eg +(2) Generate OpenXM/rc/dot.cshrc, OpenXM/rc/dot.bashrc and + OpenXM/rc/openxm + by the following command. + Environmental variables to execute commands in OpenXM/bin + are defined in these files. + +*/ /*&C + cd /xxx/yyy/OpenXM/rc + make + */ /*&jp - Solaris でコンパイルするには, /usr/ccs/bin をサーチパスの最初へもっていって - おきます. +(3) csh を利用してる場合, 次の行を ~/.cshrc の最後に加えます. + */ /*&eg - /usr/ccs/bin must be at the top of the command search path to compile - on Solaris. +(3) Append the following line to the end of ~/.cshrc when you are + using csh as your shell. + */ -/*& +/*&C + source /xxx/yyy/OpenXM/rc/dot.cshrc + */ /*&jp -★ OpenXM パッケージの利用方法 -OpenXM をホームの直下に展開した場合, 次のようにします. +(3') bash を利用してる場合, 次の行を ~/.bashrc の最後に加えます. + */ /*&eg -* How to use the OpenXM package? -If you have OpenXM under your home directory, do as follows. +(3') Append the following line to the end of ~/.bashrc when you are + using bash as your shell. + */ /*&C - cp OpenXM/rc/asirrc ~/.asirrc - source OpenXM/rc/bashrc (in case of bash) - source OpenXM/rc/cshrc (in case of csh) + source /xxx/yyy/OpenXM/rc/dot.bashrc */ + /*&jp -OpenXM をホームの直下に展開してない場合は OpenXM/rc/bashrc, OpenXM/rc/cshrc を -適当に変更して使用してください. + + (3) または (3') を終了したら, いったん logout して login しなおすか + または, source コマンドで, dot.bashrc または dot.csh を読み込んで下さい. + (3) または (3') をやらないという選択もあります. + この場合, シェルスクリプト + OpenXM/rc/openxm を コマンドサーチパスに移し, + OpenXM/bin 以下の全てのコマンドの実行は, + openxm コマンド名 + という形で呼び出します. + たとえば, openxm asir とか openxm sm1 という形でよびだします. + */ -/*&eg -If you have OpenXM in a different place, edit OpenXM/rc/bashrc or -OpenXM/rc/cshrc properly. +/*&eg + + After finishing the step (3) or (3'), logout and login again, + or read dot.bashrc or dot.cshrc file by the source command. + You may skip the step (3) or (3'). + In this case, move the shell script OpenXM/rc/openxm to your + command search path. To execute commands in OpenXM/bin, type in + openxm command-name + For example, "openxm asir" starts asir and "openx sm1" starts sm1 + with a proper setting of environmental variables. + */ + + //&C -//&jp asir の利用には key が必要です. 以下のファイルを御覧ください. -//&eg You need key to use asir. See the following file: -//&C OpenXM/lib/asir/asir_key +//&jp (4) asir の利用には key が必要です. +//&eg (4) You need a key to use asir. //&C +/*&jp + asir の起動時のメッセージまたは OpenXM/lib/asir/asir_key を + 参照して, key を取得して下さい (数秒しかかかりません). + +*/ +/*&eg + Please get the key by following the instruction from asir itself or + that in OpenXM/lib/asir/asir_key (it takes only a few seconds + to get the key). + +*/ + +/*&C + +***** QUALITY: + the following modules and functions have still experimental qualities: + OpenXM/bin/k0, OpenXM/bin/d0 + OpenXM/bin/ox_math, OpenXM/bin/math2ox + OpenXM/lib/java-support/ * + Asir client functions: m_* (Mathematica) , om_* (OpenMath) + OpenXM/bin/sm1, ox_sm1 on Linux libc6. +*/ +/*&C + + +*/ /*&jp +★ Java に関する注意: 注意 1. -asir で日本語のヘルプを利用するには, -PAGER=jless -export PAGER -などで, 日本語を扱える PAGER を指定する必要があるかもしれません. -注意 2. OpenMath 用の OMproxy には現在のところ, jdk が必要です. +たとえば bash を利用している場合, .bashrc で PATH=/usr/local/jdk1.1.8/bin:$PATH export PATH -などとして, jdk の javac をサーチパスの先のほうへもっていくようにして +などとして, jdk の java, javac をサーチパスの先のほうへもっていくようにして ください. +csh を利用している場合, .cshrc で +set path=(/usr/local/jdk1.1.8/bin $path) +として, jdk の java, javac をサーチパスにいれます. + +注意: +なお, Kaffe 1.0.b4 の java は, class BigInteger に method +toByteArray が含まれてないため, OpenMath モジュールでは使用できません. */ +/*&eg +***** JAVA +In order to use OMproxy, asir client om_*, +you need to install JDK. +The bin dir of the JDK must be in yur search path. +For example, you need to add the following line +to your .chsrc when your shell is csh +set path=(/usr/local/jdk1.1.8/bin $path) +Bash users put the following line to .bashrc +PATH=/usr/local/jdk1.1.8/bin:$PATH +export PATH + +Remark: +The Java interpreter of Kaffe 1.0.b4 does not contain the method +toByteArray in the class BigInteger. +So, it cannot be used for the OpenMath module. +*/ + +/*&C + + + + +*/ /*&jp +★ 動作環境 -以上. 以下の使用例へ進んで下さい. +*/ +/*&eg +***** SYSTEM REQUIREMENTS -★(1) asir のマニュアルは, - OpenXM_contrib2/asir2000/doc の README を見てね. - (2) asir-contrib のマニュアルは, - OpenXM/src/asir-contrib/packages/doc で make したあと, - ptex cman.texi (日本語) - tex cman-eg.texi (英語) - すればよろしい. - Online manual : ox_help(xxx) を利用するには, - (cd OpenXM/src/asir-contrib/packages/doc ; make install-help) - とします. +*/ +/*&C -注意: -$OpenXM_HOME/bin の下の, fep, phc は, いまのところ -linux 用のバイナリまたはバイナリへのシンボリックリンクです. -Linux 以外の場合はバイナリを入れ換える必要があります. +OS: FreeBSD 3.3 (Intel CPU), + Linux systems (Intel CPU): + Most Linux with libc5 and with libc6 (glibc 2.x). -Solaris での make の問題点については, OpenXM/doc/OpenXM-FAQ-jp.txt -を見てください. + X window system is required. ---------------- インストール完了 --------------------------- + Most part of the OpenXM package may work on other versions of + FreeBSD 3.x and Linux, but we have not yet tested. -★使用例 +*/ +/*&jp +次の modules は, OS の標準 distribution 以外に, さらに下に記したソフトを +必要とします. +*/ +/*&eg +The following modules require the listed softwares other than the standard +OS package. +*/ +/*&C -OpenXM は X Window System 上でしか動作しません. +(1) OpenXM/bin/ox_math : Mathematica Version 3.x or 4.x + (Mathematica server) at /usr/local/Mathematica + OpenXM/bin/math2ox [ see http://www.wolfram.com ] + Asir client functions m_* +(2) OpenXM/lib/java-support : JDK at /usr/local/jdk?? + [ see the section on JAVA] + Asir client functions om_* + sm1 client functions om_* +(3) PHC pack (OpenXM/bin/phc) and asir client functions + phc_* run only on linux (glib5). + If you install the linux emulation^{note 1} on Free BSD, they run on + FreeBSD, too. + + Add linux_enable="YES" in /etc/rc.conf + You need the following packages: + pkg_info | grep linu + linux_base-5.2 The base set of packages needed in Linux mode + linux_devtools-5.2 Packages needed for doing development in Linux mode +*/ + + +/*&jp +日本語版の注意. +注意 1. +asir で日本語のヘルプを利用するには, +PAGER=jless +export PAGER +などで, 日本語を扱える PAGER を指定する必要があるかもしれません. +*/ + +/*&eg + +The installation is completed. + +*/ +/*&jp + +以上. + +*/ + +/*&jp +★ 文書 + + OpenXM パッケージでもっとも充実しているクライアントは, + asir です. + asir のつかいかたは + OpenXM/doc/asir2000/man-jp.dvi + または OpenXM/doc/asir2000/html-jp の HTML ファイルを見て下さい. + asir 用 OpenXM クライアントライブラリのつかい方は, + OpenXM/doc/asir-contrib/cman-jp.dvi + を見て下さい. dvi の付くファイルは xdvi で見ることができます. + + OpenXM の設計の概要については, + OpenXM/doc/issac2000/issac2000.ps + を見て下さい. + ps の付くファイルは, ghostview で見ることができます. + +*/ +/*&eg +***** DOCUMENTS + + The best OpenXM client in the OpenXM package is now + asir. + Documents on asir are + OpenXM/doc/asir2000/man-eg.dvi + OpenXM/doc/asir2000/html-eg (HTML) + + The file + OpenXM/doc/asir-contrib/cman-eg.dvi + is a document on OpenXM client libraries for asir. + + The design outline is described in + OpenXM/doc/issac2000/issac2000.ps + + Dvi files can be previewed by xdvi and + ps files can be previewed by ghostview. +*/ + + +/*&eg + + +***** A QUICK TOUR OF OPENXM BY ASIR + +*/ +/*&jp + + +★ ASIR による使用例 + + asir を動作させるには, key が必要です. -OpenXM/lib/asir/asir_key のコメントをみて, key を E-mail で -とりよせて下さい. +OpenXM/lib/asir/asir_key のコメントまたは起動時のメッセージをみて, +key を E-mail でとりよせて下さい. --------------------------------------------------- -OpenXM クライアント : asir 入門 ----------------- 例 : asir に kan/sm1 を組み込む. -asir -load("xm"); -P=sm1_start(); /* P はプロセス番号 */ -load("katsura"); -sm1_pgb(P,[katsura(4),[u0,u1,u2,u3,u4]]); /* sm1 でグレブナ基底を計算 */ +*/ +/*&C +---------------- Call ox_sm1 from asir. +bash-2.03$ asir +This is Risa/Asir, Version 20000120. +Copyright (C) FUJITSU LABORATORIES LIMITED. +1994-1999. All rights reserved. +xm Version 20000116. ox_help(0); ox_help("keyword"); for help message +[269] sm1_genericAnn([x^3-y^2,[s,x,y]]); + /* The annihilating ideal of (x^3-y^2)^s */ +[-2*y*dx-3*x^2*dy,2*x*dx+3*y*dy-6*s] ---------------- 例 : asir より gnuplot を呼び出す. -asir -load("xm"); -P=gnuplot_start(); -gnuplot(P,"plot tan(x); "); -gnuplot(P,"splot sin(x)*cos(x); "); ---------------- 例 : asir より tigers を呼び出す. -asir -load("xm"); -tigers_start(); -B = tigers(0,[[1,1,1,1],[0,1,2,3]]); -length(B) は 8 です. これは, 行列 A = [[1,1,1,1],[0,1,2,3]] -に付随した, toric ideal I_A の Grobner fan が 8 つの maximal -dimensional fan を持つことを意味します. -A[i] は i 番目の GB (グレブナ基底)です. -Binomial polynomial x^a-x^b を [[a_1, ..., a_n],[b_1, ..., b_n]] なる形式で -表示します. -たとえば A[0]; -[[[1,0,1,0],[0,2,0,0]],[[1,0,0,1],[0,1,1,0]],[[0,1,0,1],[0,0,2,0]]] -ですから, -x1 x3 - x2^2, x1 x4 - x2 x3, x2 x4 - x3^2 -が GB であり, initial ideal は -x1 x3 , x1 x4 , x2 x4 -で生成されています. +--------------- Call gnuplot from asir. +bash-2.03$ asir +This is Risa/Asir, Version 20000120. +Copyright (C) FUJITSU LABORATORIES LIMITED. +1994-1999. All rights reserved. +xm Version 20000116. ox_help(0); ox_help("keyword"); for help message +[269] gnuplot("plot sin(x);"); +0 +[270] ----------------------------------- +*/ + +/*&jp + +★ sm1 クライアントの利用例 + +*/ +/*&eg + +****** Example of the use of sm1 client + +*/ + +/*&C +-------------------------------------- call ox_asir from sm1 sm1 (oxasir.sm1) run ; -(x^20-1). fctr pmat ; sm1 より ox_asir を呼び出して因数分解させる. +[(x^20-y^20) (x,y)] fctr pmat ; factorize x^20-y^20 by call ox_asir +*/ +/*&jp [著作権表示] OpenXM/Copyright を御覧ください. +*/ +/*&eg +[COPYRIGHT] +See OpenXM/Copyright. +*/ -OpenXM : url http://www.math.kobe-u.ac.jp/OpenXM - cvs cite : kerberos.math.kobe-u.ac.jp -sm1 : 作者 Nobuki Takayama, url http://www.math.kobe-u.ac.jp/KAN, -asir : 作者 url - ライセンス形態 ?? -gnuplot : 作者 url - ライセンス形態 GPL? -phc : 作者 Jan Verschelde, url - ライセンス形態 ?? -tigers : 作者 Birk Hubert, url - ライセンス形態 ?? +/*&eg -[OpenXM についての連絡先] -takayama@math.sci.kobe-u.ac.jp -[OpenXM_HOME 下のファイルの構成] + +***** TO COMPILE FROM A SOURCE ***** + +*/ +/*&jp + + +★ OpenXM パッケージの Make 法 + FreeBSD 2.2.8, FreeBSD 3.3, Linux で動作するものと期待してます. + Linux glib6 では, いまのところ, /usr/include/features.h + で #define __FAVOR_BSD 1 してコンパイルする必要があります. + (setjmp と sigsetjmp の問題, dirty trick) + + OpenXM, OpenXM_contrib, OpenXM_contrib2 が必要です. + cvs コミッタの場合次のようにしてソースをとりよせます. +*/ +/*&eg +* How to make OpenXM package? + We have tested the OpenXM package on FreeBSD 2.2.8, FreeBSD 3.3, Linux. + On Linux glib6, you need to define + #define __FAVOR_BSD 1 + in /usr/include/features.h + (setjmp vs sigsetjmp) + + Do you have directories OpenXM, OpenXM_contrib, OpenXM_contrib2? + If you are a CVS committer, then you can get all sources as follows: +*/ +//&C rcvs checkout OpenXM OpenXM_contrib OpenXM_contrib2 +//&C +//&jp これらがそろっていたらあとは次のように入力するだけです. +//&eg Check that you have these directories, then just type in the following commands +/*&C + + cd OpenXM/src + make configure + make + make install + +*/ +/*&jp なお, OpenXM/src/ox_math のコンパイルおよび利用には Mathematica が, +OpenXM/src/OpenMath のコンパイルおよび利用には +には, jdk (java 環境) が必要です. + +Documents を生成するには, tex, ptex (ascii 日本語 tex), dvips, texinfo, +texi2html, nkf, +が必要です. 詳しくは Makefiles を見て下さい. +Document は, binary distribution の OpenXM/doc, OpenXM/lib +より得るのが簡単です. +*/ +/*&eg In order to use and compile OpenXM/src/ox_math, you need Mathematica. +In order to use and compile OpenXM/src/OpenMath, +you need jdk (java environment). + +In order to generate the full documentation including Japanese documents, +you need tex, ptex (ASCII Inc. Japanese tex), dvips, texinfo, texi2html, +nkf. See each Makefile. +The generated documents are in OpenXM/doc and OpenXM/lib +in the binary distribution. +If you do not like to install Japanese environment such as ptex, +type in R for the tex error prompt ? or +prepare empty shell scripts ptex and nkf. +*/ +/*&C + +*/ +/*&jp + + OpenXM_contrib2/asir2000 の配布を受けてない場合 (ソースライセンスを + 富士通より受ける必要があります), + OpenXM/src/Makefile の各モジュール名 たとえば + make all-kan96xx + などと各モジュール名を指定してコンパイルして下さい. + +*/ +/*&eg + + If you cannot get a source liscence of OpenXM_contrib2/asir2000 + from Fujitsu labs, + compile each modules independently, e.g., + make all-kan96xx + +*/ + +/*&jp + +[OpenXM 下のファイルの構成メモ] lib/asir には, asir のライブラリ, ox_asir 本体 -(ox_asir.xxyyzz.os なる名前で格納されています) +cd OpenXM/src/kxx ; make install-for-debug した場合, lib/sm1 は src/SSkan/Doc への symbolic link であり, sm1 のライブラリファイルが格納されています. lib/sm1/bin には, binaryfiles sm1, ox_sm1, ox, ox_log, ox_sm1_* へのシンボリックリンクが格納されます. -このシンボリックリンクは src/kxx で make install を実行することにより +このシンボリックリンクは src/kxx で make install-for-debug を実行することにより 作成されます. sm1 が ox_asir を利用するのに必要なファイル. @@ -224,8 +511,8 @@ asir が ox_sm1_gnuplot を利用するのに必要なファイル: binary file は各 directory の make install により OpenXM/bin にコピーされますが, debug 用にいちいちコピーするのは面倒なので, -OpenXM/src/kan96xx で make install2 -OpenXM/src/kxx で make install2 +OpenXM/src/kan96xx で make install-for-debug +OpenXM/src/kxx で make install-for-debug を実行すると, OpenXM/bin/sm1, ox, ox_sm1, oxlog より, OpenXM/src/kan96xx/Kan/sm1 @@ -238,4 +525,30 @@ rcvs export -rHEAD OpenXM rcvs export -rHEAD OpenXM_contrib rcvs export -rHEAD OpenXM_contrib2 して, OpenXM, OpenXM_contrib, OpenXM_contrib2 全体を tar+gzip. +*/ + +/*&C + +*/ +/*&jp + +★ Solaris に関する注意. +Solaris ではまだ問題が山積してます. +Solaris での make の問題点については, OpenXM/doc/OpenXM-FAQ-jp.txt +を見てください. +Solaris でコンパイルするには, /usr/ccs/bin をサーチパスの最初へもっていって +おきます. + +*/ +/*&eg +***** COMPILE ON SOLARIS + There are a lot of troubles on Solaris for now. + At least, + /usr/ccs/bin must be at the top of the command search path to compile + on Solaris. +*/ + + +/*&C + */