=================================================================== RCS file: /home/cvs/OpenXM/doc/install.oxweave,v retrieving revision 1.7 retrieving revision 1.49 diff -u -p -r1.7 -r1.49 --- OpenXM/doc/install.oxweave 2000/01/20 03:14:07 1.7 +++ OpenXM/doc/install.oxweave 2005/04/15 00:50:54 1.49 @@ -1,185 +1,269 @@ -%% $OpenXM: OpenXM/doc/install.oxweave,v 1.6 2000/01/19 12:57:39 takayama Exp $ +%% $OpenXM: OpenXM/doc/install.oxweave,v 1.48 2004/02/03 23:36:09 takayama Exp $ OpenXM/doc/install.oxweave /*&C + OpenXM URL : http://www.math.kobe-u.ac.jp/OpenXM + http://www.openxm.org +*/ + +/*&jp + +------------ ソースからコンパイルしてインストールする方法 ---- +(cd OpenXM/src ; make install) + バイナリとライブラリとドキュメント類は + OpenXM/bin, OpenXM/lib, OpenXM/doc + にインストールされます. +(cd OpenXM/rc ; make install) + "asir", "sm1", ... などのシェルスクリプトが生成されて + /usr/local/bin + にコピーされます. + この部分は root で実行してください. + +なお一部のソースは ftp://ftp.math.kobe-u.ac.jp/pub/OpenXM/misc より +OpenXM_dist に make 中にダウンロードされます. したがって, make するときは +インターネットに接続されている必要があります. + +*/ + +/*&eg + OpenXM package : Getting started. + +----------- An instruction for a quick installation from the source code --- +(cd OpenXM/src ; make install) + You will get binaries, libraries, and documents under + OpenXM/bin, OpenXM/lib, OpenXM/doc +(cd OpenXM/rc ; make install) + Shell scripts to start "asir", "sm1", ... will be copied to + /usr/local/bin + This part should be executed as the root. + + +Some sources are downloaded from ftp://ftp.math.kobe-u.ac.jp/pub/OpenXM/misc +to OpenXM_dist during the make. So, your machine must be accessible to +the internet. + */ + + /*&jp -★ OpenXM パッケージの利用方法 -この節では, OpenXM package binary distribution のインストール法を説明します. -インストールに必要なシステムの仕様については, 動作環境を御覧ください. + + +------- Asir と kan だけで十分な場合 +(cd OpenXM/src ; make install-kan-ox ; make install-asir-contrib) + OpenXM 版の Risa/Asir と kan/sm1 が生成インストールされます. +(cd OpenXM/rc ; make install) + +------------------------------------------- +asir-contrib 付きの Risa/Asir は OpenXM パッケージのメインクライアントです. +Risa/asir はコマンド asir で起動できます. +Risa/Asir および Asir-contrib のマニュアルは +OpenXM/doc ディレクトリおよび http://www.openxm.org においてあります. + + */ + + /*&eg -***** 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" + +------- If you need only asir and kan, +(cd OpenXM/src ; make install-asir2000 ; make install-k097 ) + You will get only asir and kan/sm1. +(cd OpenXM/rc ; make install) + +------------------------------------------- +Risa/Asir with asir-contrib is the main client system in the OpenXM project. +You can start Risa/Asir by the command "asir", which is called +OpenXM/Risa/Asir. +It is build by (cd OpenXM/src ; make install-asir-contrib) +The manual of Risa/Asir and Asir-contrib can be found in the +OpenXM/doc directory and http://www.openxm.org + + */ + /*&jp -(1) Tar ボールより次のようにしてディレクトリ OpenXM を取り出します. - OpenXM はどこにおいてもかまいません. - + +----------- 幾つか解説 ------------------ + +Q. (cd OpenXM/rc ; make all) はなにをやるの? +A. + OpenXM/rc/dot.cshrc, OpenXM/rc/dot.bashrc, + OpenXM/rc/openxm, OpenXM/rc/asir, OpenXM/rc/oxmath, 等の + ファイルを自動生成します. + openxm, asir, oxmath などは OpenXM クライアントを起動するための + シエルスクリプトです. これらを /usr/local/bin にインストールするには + 次のように入力します. + */ /*&eg -(1) Extract the directory OpenXM from the tar ball. - You can put the directory OpenXM at any place in the file system. +----------- Some Tips ---------------------- +Q. What is done by the command (cd OpenXM/rc ; make all) ? +A. + It generates OpenXM/rc/dot.cshrc, OpenXM/rc/dot.bashrc and + OpenXM/rc/openxm, OpenXM/rc/asir, OpenXM/rc/oxmath, ... + The files openxm, asir, oxmath are shell scripts to invoke OpenXM clients. + If you want to install these shell scripts to /usr/local/bin, + type in as follows. + */ /*&C - tar xzvf OpenXM-binary-OPERATING_SYSTEM_CPU_TYPE.tgz + cd OpenXM/rc + make install + */ /*&jp -以下 (1) で生成されたディレクトリ OpenXM の絶対パスを /xxx/yyy/OpenXM -と書きます. + /usr/local/bin でなく, home directory の bin にインストールしたい + ときは, 次のように入力してください. + */ /*&eg -In the sequel, we will denote the absolute path of the directory OpenXM -by /xxx/yyy/OpenXM. + + If you want to install them under the bin of your home directory, + type in as follows. */ -/*&jp -(2) 次のように入力して OpenXM/rc/dot.cshrc, OpenXM/rc/dot.bashrc - ファイルを自動生成します. - これらのファイルには, OpenXM/bin のファイルを実行するための - 環境変数が定義されています. +/*&C -*/ -/*&eg -(2) Generate OpenXM/rc/dot.cshrc and OpenXM/rc/dot.bashrc - by the following command. - Environmental variables to execute commands in OpenXM/bin - are defined in these files. + cd OpenXM/rc + make install PREFIX=$HOME/bin */ /*&C - cd /xxx/yyy/OpenXM - make + [Note] If you are Solaris user, you might have to type in like + /usr/ccs/bin/make install PREFIX=$HOME/bin */ /*&jp -(3) csh を利用してる場合, 次の行を ~/.cshrc の最後に加えます. +Q. OpenXM/bin の下のファイルを直接実行できるようにしたい. +A. +OpenXM/bin の下のファイルを直接実行したい場合は, 以下の設定が必要です. + + # csh を利用してる場合, 次の行を ~/.cshrc の最後に加えます. + */ /*&eg -(3) Append the following line to the end of ~/.cshrc when you are + +Q. I want to execute binaries under OpenXM/bin +A. +If you want to execute binaries under OpenXM/bin, you need to do +the following. + + + # 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 + source OpenXM/rc/dot.cshrc */ /*&jp -(3') bash を利用してる場合, 次の行を ~/.bashrc の最後に加えます. + # bash を利用してる場合, 次の行それぞれを ~/.bashrc および ~/.bash_profile +の最後に加えます. */ /*&eg -(3') Append the following line to the end of ~/.bashrc when you are - using bash as your shell. + # Append the following lines to the end of ~/.bashrc and ~/.bash_profile + respectively when you are using bash as your shell. */ /*&C - source /xxx/yyy/OpenXM/rc/dot.bash + source OpenXM/rc/dot.bashrc (.bashrc) -*/ + source ~/.bashrc (.bash_profile) -//&C -//&jp (4) asir の利用には key が必要です. 以下のファイルを御覧ください. -//&eg (5) You need key to use asir. See the following file: -//&C OpenXM/lib/asir/asir_key -//&C - -/*&C -QUALITY: - the following 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) */ -/*&C - - -*/ /*&jp -★ 動作環境 - +Q. ox_asir を icon でスタートするには? +A. 次の行を, .Xdefaults または, xrdb で読み込むファイルに書いておきます. */ /*&eg -***** SYSTEM REQUIREMENTS - +Q. How to start ox_asir in the iconic mode? +A. Add the following line to .Xdefaults or a file you read by xrdb. */ /*&C -OS: FreeBSD 3.3, - Linux systems (Plamo Linux on Linux 2.0.33, glibc5, ) + ox_xterm*iconic: on - X window system is required. - - Most part of the OpenXM package may work on other versions of - FreeBSD and Linux versions, but we have not yet tested. - */ + /*&jp -次の module は, OS の標準 distribution 以外に, さらに下に記したソフトを + +Q. Make は無事終了しますが, 途中でエラーがでます. +A. +OS の標準添付の環境以外が必要なコンポーネントのコンパイルエラーは +無視されます. +次の modules は, OS の標準 distribution 以外に, さらに下に記したソフトを 必要とします. */ /*&eg -The following modules require the listed softwares other than the standard -OS package. + +Q. Make finishes, but it outputs errors. +A. +Compilation errors due to missing commands other than +standard commands are ignored. +The following modules require the listed software systems +other than the standard OS package. */ /*&C -(1) OpenXM/bin/ox_math : Mathematica Version 3.x or 4.x +(1) OpenXM/bin/oxmath : 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?? +(2) OpenXM/lib/OpenMath : JDK + Asir client functions om_* sm1 client functions om_* -(3) PHC pack (OpenXM/bin/phc) and asir client functions - phc_* run only on linux (glib5). +(3) PHC pack (OpenXM/bin/phc) and asir client functions phc_* + phc_* run only on linux. If you install the linux emulation on Free BSD, they run on - FreeBSD, too. (In this case, generate OpenXM/bin/phc by hand.) + FreeBSD, too. + + Add linux_enable="YES" in /etc/rc.conf + You need the following packages: + pkg_info | grep linu + linux_base-* The base set of packages needed in Linux mode + linux_devtools-* Packages needed for doing development in Linux mode +(4) The document generation requires + latex, platex, tex, ptex, dvips, latex2html, texi2html, nkf */ /*&jp -日本語版の注意. -注意 1. +Q. asir の help message が変. +A. asir で日本語のヘルプを利用するには, PAGER=jless export PAGER などで, 日本語を扱える PAGER を指定する必要があるかもしれません. */ -/*&eg +/*&C -The install is completed. +----------------------------------------------------- */ -/*&jp -以上. - -*/ - /*&jp -★ 文書 - +Q. OpenXM パッケージの文書は？ +A. OpenXM パッケージでもっとも充実しているクライアントは, asir です. asir のつかいかたは @@ -194,11 +278,20 @@ The install is completed. を見て下さい. ps の付くファイルは, ghostview で見ることができます. + Mathematica client については, OpenXM/doc/ox_math を御覧ください. + sm1 client については, OpenXM/doc/kan96xx を御覧ください. + asir は, 多項式処理用のライブラリとしてリンクできます. + これについては, OpenXM/doc/oxlib を御覧ください. + + OpenXM 対応の, サーバ を作成するには, OpenXM/src/ox_toolkit + を見てください. Java のクラスについては + OpenXM/src/OpenMath を見てください. + */ /*&eg -***** DOCUMENTS - - The best OpenXM client in the OpenXM package is now +Q. Where can I find documents of the OpenXM package. +A. + The main OpenXM client in the OpenXM package is now asir. Documents on asir are OpenXM/doc/asir2000/man-eg.dvi @@ -213,133 +306,60 @@ The install is completed. Dvi files can be previewed by xdvi and ps files can be previewed by ghostview. -*/ + As to Mathematica client, see OpenXM/doc/ox_math. + As to sm1 client, see OpenXM/doc/kan96xx. + The asir can be used as a C library for polynomial manupulation. + See OpenXM/doc/oxlib. -/*&jp -注意: -$OpenXM_HOME/bin の下の, fep, phc は, いまのところ -linux 用のバイナリまたはバイナリへのシンボリックリンクです. -Linux 以外の場合はバイナリを入れ換える必要があります. + If you are interested in writing a server for OpenXM in C or Java, + please refer to + OpenXM/src/ox_toolkit and OpenXM/src/OpenMath. - - -★使用例 - -OpenXM は X Window System 上でしか動作しません. - -asir を動作させるには, key が必要です. -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 でグレブナ基底を計算 */ - ---------------- 例 : 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 -で生成されています. - ----------------------------------- -sm1 -(oxasir.sm1) run ; -(x^20-1). fctr pmat ; sm1 より ox_asir を呼び出して因数分解させる. - - - -[著作権表示] -OpenXM/Copyright を御覧ください. */ -/*&C - - +/*&eg +Q. I want to install only Risa/Asir. +A. + If you want to generate only Risa/Asir, type in as follows. */ /*&jp -★ OpenXM パッケージの Make 法 - FreeBSD 2.2.8, FreeBSD 3.3, Linux で動作するものと期待してます. - OpenXM, OpenXM_contrib, OpenXM_contrib2 が必要です. - cvs コミッタの場合次のようにしてソースをとりよせます. +Q. Risa/Asir のみ install したい. +A. + Risa/Asir のみを生成したい場合は, つぎのように入力します. */ -/*&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: -*/ -//&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 + (cd OpenXM/src ; make install-asir) + (cd OpenXM/rc ; make ) */ -/*&jp なお, OpenXM/src/ox_math のコンパイルおよび利用には Mathematica が, -OpenXM/src/OpenMath のコンパイルおよび利用には -には, jdk (java 環境) が必要です. +/*&eg + Copy the shell script "asir" at OpenXM/rc in your search path, e.g., + /usr/local/bin or ~/bin + Or, read OpenXM/rc/dot.bashrc or OpenXM/rc/dot.bashrc by the source + command from your ~/.bashrc or ~/.cshrc. */ -/*&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). -*/ -/*&C - -*/ /*&jp - Solaris でコンパイルするには, /usr/ccs/bin をサーチパスの最初へもっていって - おきます. + OpenXM/rc の下のシェルスクリプト "asir" をサーチパスにコピーして + ください (たとえば, /usr/local/bin or ~/bin へ). + または OpenXM/rc/dot.bashrc か OpenXM/rc/dot.cshrc を + source コマンドで ~/.bashrc か ~/.cshrc より読み込んでください. */ -/*&eg - /usr/ccs/bin must be at the top of the command search path to compile - on Solaris. -*/ /*&jp -[OpenXM についての連絡先] -takayama@math.sci.kobe-u.ac.jp - -[OpenXM_HOME 下のファイルの構成] +Q. OpenXM の下のファイル構成はどうなっていますか? +A. +[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 を利用するのに必要なファイル. @@ -367,25 +387,30 @@ asir が ox_sm1_gnuplot を利用するのに必要なファイル: bin/gnuplot4ox, bin/gnuplot_x11 (gnuplot 本体, src/gnuplot*) ---------------------------------------- -[開発者用メモ] +*/ +/*&jp +Q. debug するとき make install は面倒. (開発者向け) +A. << sm1, ox_sm1, ox, oxlog の debug >> 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 OpenXM/src/kxx/ox, OpenXM/src/kxx/ox_sm1, OpenXM/src/kxx/oxlog へのシンボリックリンクが作成されます. -[CVSコミッタ用メモ] -<< OpenXM ディレクトリ配布版の作成方法 >> +Q. << OpenXM ディレクトリ配布版の作成方法 >> +A. + rcvs export -rHEAD OpenXM rcvs export -rHEAD OpenXM_contrib rcvs export -rHEAD OpenXM_contrib2 +cd OpenXM/src ; make generate-source-distribution して, OpenXM, OpenXM_contrib, OpenXM_contrib2 全体を tar+gzip. */ @@ -393,33 +418,34 @@ rcvs export -rHEAD OpenXM_contrib2 */ /*&jp - -★ Solaris に関する注意. +Q. Solaris でコンパイルがうまくいきません. +A. Solaris ではまだ問題が山積してます. Solaris での make の問題点については, OpenXM/doc/OpenXM-FAQ-jp.txt を見てください. +Solaris でコンパイルするには, 次が最低限必要です. +(1) gcc をインストールする. + http://www.gnu.org より Solaris 用 binary を入手できる. + それから [gnu file util と] bison. +(2) /usr/ccs/bin:/usr/local/bin:/usr/ucb +をサーチパスの最初へもっていっておきます. +C シェルなら +setenv PATH=/usr/ccs/bin:/usr/local/bin:/usr/ucb:$PATH -*/ +これは /usr/ccs/bin/make, /usr/ucb/install を利用する必要があるためです. -/*&C - */ -/*&jp -★ Java に関する注意: -注意 1. -OpenMath 用の OMproxy には現在のところ, jdk が必要です. -bash を利用している場合, .bashrc で -PATH=/usr/local/jdk1.1.8/bin:$PATH -export PATH -などとして, jdk の javac をサーチパスの先のほうへもっていくようにして -ください. -*/ /*&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 -set path=(/usr/local/jdk1.1.8/bin $path) +Q. I cannot make on Solaris. +A. + There are a lot of troubles on Solaris for now. + At least, the following two things are prerequisite. +(1) Installation of gcc (http://www.gnu.org), [gnu file util] and bison. +(2) /usr/ccs/bin:/usr/ucb must be at the top of the command search path + to compile on Solaris. In case of C shell, type in + setenv PATH=/usr/ccs/bin:/usr/local/bin:/usr/ucb:$PATH + This is because our making procedure requires + /usr/ccs/bin/make, /usr/ucb/install */ + +