=================================================================== RCS file: /home/cvs/OpenXM/doc/install.oxweave,v retrieving revision 1.3 retrieving revision 1.52 diff -u -p -r1.3 -r1.52 --- OpenXM/doc/install.oxweave 2000/01/07 22:23:04 1.3 +++ OpenXM/doc/install.oxweave 2009/02/22 17:30:02 1.52 @@ -1,185 +1,395 @@ -%% $OpenXM: OpenXM/doc/install.oxweave,v 1.2 1999/12/15 05:53:04 takayama Exp $ +%% $OpenXM: OpenXM/doc/install.oxweave,v 1.51 2008/06/03 00:24:49 takayama Exp $ OpenXM/doc/install.oxweave +/*&C + +OpenXM URL : http://www.math.kobe-u.ac.jp/OpenXM + http://www.openxm.org + +*/ + /*&jp -★ OpenXM パッケージの Make 法 - FreeBSD 2.2.8, FreeBSD 3.3, Linux で動作するものと期待してます. - OpenXM, OpenXM_contrib, OpenXM_contrib2 が必要です. - cvs コミッタの場合次のようにしてソースをとりよせます. + +------------ ソースからコンパイルしてインストールする方法 ---- + +(cd OpenXM/src ; make install) + バイナリとライブラリとドキュメント類は + OpenXM/bin, OpenXM/lib, OpenXM/doc + にインストールされます. +(cd OpenXM/rc ; make install) + "asir", "sm1", ... などのシェルスクリプトが生成されて + /usr/local/bin + にコピーされます. + この部分は root で実行してください. + + +たとえば openxm asir と入力して, asir がスタートすればインストール +はうまくいっていると思われます. + +なお一部のソースは ftp://ftp.math.kobe-u.ac.jp/pub/OpenXM/misc より +OpenXM_dist に make 中に wget コマンドでダウンロードされます. +したがって, make するときは +インターネットに接続されている必要があります. + +ファイアウオール内でもし passive ftp が使えない場合は, +環境変数 ftp_proxy を正しく設定すればうまくいく場合があるかもしれません. +詳しくは wget のマニュアルを見てください. +ダウンロードしたライブラリのソースは +OpenXM_dist ( OpenXM と並列した場所です ) に格納されます. +ここに手動で必要なライブラリのソースをおいとけば, offline でも +コンパイル可能です. + */ + /*&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: + +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. + +Please try + openxm asir +If asir starts, then your installation seems to be successful. + + +Some sources are downloaded from ftp://ftp.math.kobe-u.ac.jp/pub/OpenXM/misc +to OpenXM_dist during the make by the wget command. +So, your machine must be accessible to the internet. + +If you are in a firewall and cannot use even the passive +ftp, the environmental variable ftp_proxy may help you. +See the document of wget. All necessary library sources are downloaded in +OpenXM_dist at the same level of OpenXM. If you are offline, please put +all library sources necessary in this directory by hand. + */ -//&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 + + +------- 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 + +------- 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 + + +----------- 幾つか解説 ------------------ + +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 クライアントを起動するための + シエルスクリプトです. たとえば openxm asir と入力すれば OpenXM 環境で + asir が動作します. + これらを /usr/local/bin にインストールするには + 次のように入力します. + +*/ +/*&eg + +----------- 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. + For example, if you input + openxm asir + then asir starts in the OpenXM enviroment. + If you want to install these shell scripts to /usr/local/bin, + type in as follows. + +*/ /*&C - cd OpenXM/src - make configure - make + cd OpenXM/rc + make install */ -/*&jp なお, OpenXM/src/ox_math の利用には Mathematica が, OpenXM/src/OpenMath -には, jdk (java 環境) が必要です. +/*&jp + + /usr/local/bin でなく, home directory の bin にインストールしたい + ときは, 次のように入力してください. + */ -/*&eg In order to use OpenXM/src/ox_math, you need Mathematica. -In order to use OpenXM/src/OpenMath, you need jdk (java environment). +/*&eg + + If you want to install them under the bin of your home directory, + type in as follows. + */ /*&C + cd OpenXM/rc + make install PREFIX=$HOME/bin + */ +/*&C + + [Note] If you are Solaris user, you might have to type in like + /usr/ccs/bin/make install PREFIX=$HOME/bin + +*/ /*&jp -★ OpenXM パッケージの利用方法 -OpenXM をホームの直下に展開した場合, 次のようにします. + +Q. OpenXM/bin の下のファイルを直接実行できるようにしたい. +A. +OpenXM/bin の下のファイルを直接実行したい場合は, 以下の設定が必要です. + + # csh を利用してる場合, 次の行を ~/.cshrc の最後に加えます. + */ /*&eg -* How to use the OpenXM package? -If you have OpenXM under your home directory, do as follows. + +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 - cp OpenXM/rc/asirrc ~/.asirrc - source OpenXM/rc/bashrc (in case of bash) - source OpenXM/rc/cshrc (in case of csh) + source OpenXM/rc/dot.cshrc */ /*&jp -OpenXM をホームの直下に展開してない場合は OpenXM/rc/bashrc, OpenXM/rc/cshrc を -適当に変更して使用してください. + # bash を利用してる場合, 次の行それぞれを ~/.bashrc および ~/.bash_profile +の最後に加えます. + */ /*&eg -If you have OpenXM in a different place, edit OpenXM/rc/bashrc or -OpenXM/rc/cshrc properly. + # Append the following lines to the end of ~/.bashrc and ~/.bash_profile + respectively when you are using bash as your shell. + */ -//&C -//&jp asir の利用には key が必要です. 以下のファイルを御覧ください. -//&eg You need key to use asir. See the following file: -//&C OpenXM/lib/asir/asir_key -//&C +/*&C + + source OpenXM/rc/dot.bashrc (.bashrc) + + source ~/.bashrc (.bash_profile) + +*/ + + /*&jp -注意 1. +Q. ox_asir を icon でスタートするには? +A. 次の行を, .Xdefaults または, xrdb で読み込むファイルに書いておきます. +*/ +/*&eg +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 + + ox_xterm*iconic: on + +*/ + +/*&jp + +Q. Make は無事終了しますが, 途中でエラーがでます. +A. +OS の標準添付の環境以外が必要なコンポーネントのコンパイルエラーは +無視されます. +次の modules は, OS の標準 distribution 以外に, さらに下に記したソフトを +必要とします. +*/ +/*&eg + +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/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/OpenMath : JDK + + Asir client functions om_* + sm1 client functions om_* +(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. + + 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 +Q. asir の help message が変. +A. asir で日本語のヘルプを利用するには, PAGER=jless export PAGER などで, 日本語を扱える PAGER を指定する必要があるかもしれません. -注意 2. -FreeBSD 3.3 などには, /usr/local/bin/javac がついています. -この javac では, OpenXM/src/OpenMath 以下のファイルがコンパイルできません. -PATH=/usr/local/jdk1.1.8/bin:$PATH -export PATH -などとして, jdk の javac をサーチパスの先のほうへもっていくようにして -ください. */ -/*&jp -以上. 以下の使用例へ進んで下さい. +/*&C -★(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) - とします. +----------------------------------------------------- -注意: -$OpenXM_HOME/bin の下の, fep, phc は, いまのところ -linux 用のバイナリまたはバイナリへのシンボリックリンクです. -Linux 以外の場合はバイナリを入れ換える必要があります. +*/ -Solaris での make の問題点については, OpenXM/doc/OpenXM-FAQ-jp.txt -を見てください. +/*&jp +Q. OpenXM パッケージの文書は? +A. + OpenXM パッケージでもっとも充実しているクライアントは, + asir です. + asir のつかいかたは + OpenXM/doc/asir2000/man-ja.pdf + または OpenXM/doc/asir2000/html-ja の HTML ファイルを見て下さい. + asir 用 OpenXM クライアントライブラリのつかい方は, + OpenXM/doc/asir-contrib/cman-ja.pdf + を見て下さい. dvi の付くファイルは xdvi で見ることができます. ---------------- インストール完了 --------------------------- + OpenXM の設計の概要については, + OpenXM/doc/issac2000/issac2000.ps + を見て下さい. + ps の付くファイルは, ghostview で見ることができます. -★使用例 + Mathematica client については, OpenXM/doc/ox_math を御覧ください. + sm1 client については, OpenXM/doc/kan96xx を御覧ください. + asir は, 多項式処理用のライブラリとしてリンクできます. + これについては, OpenXM/doc/oxlib を御覧ください. -OpenXM は X Window System 上でしか動作しません. + OpenXM 対応の, サーバ を作成するには, OpenXM/src/ox_toolkit + を見てください. Java のクラスについては + OpenXM/src/OpenMath を見てください. -asir を動作させるには, key が必要です. -OpenXM/lib/asir/asir_key のコメントをみて, key を E-mail で -とりよせて下さい. +*/ +/*&eg +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-en.pdf + OpenXM/doc/asir2000/html-en (HTML) ----------------- Asir クライアントの使いかた. ----------------- 例 : asir に kan/sm1 を組み込む. -asir -load("xm"); -P=sm1_start(); /* P はプロセス番号 */ -load("katsura"); -sm1_pgb(P,[katsura(4),[u0,u1,u2,u3,u4]]); /* sm1 でグレブナ基底を計算 */ + The file + OpenXM/doc/asir-contrib/cman-en.pdf + is a document on OpenXM client libraries for asir. ---------------- 例 : asir より gnuplot を呼び出す. -asir -load("xm"); -P=gnuplot_start(); -gnuplot(P,"plot tan(x); "); -gnuplot(P,"splot sin(x)*cos(x); "); + The design outline is described in + OpenXM/doc/issac2000/issac2000.ps ---------------- 例 : 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 -で生成されています. + Dvi files can be previewed by xdvi and + ps files can be previewed by ghostview. ----------------------------------- -sm1 -(oxasir.sm1) run ; -(x^20-1). fctr pmat ; sm1 より ox_asir を呼び出して因数分解させる. + 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. + 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. +*/ -[著作権表示] (現在テスト版のため情報が完備してません) -このソフトウエアは動作およびその結果につき, 一切の保証をしません. -ライセンス形態については現在検討中であります. 法務committer を -募集中. +/*&eg +Q. I want to install only Risa/Asir. +A. + If you want to generate only Risa/Asir, type in as follows. +*/ +/*&jp +Q. Risa/Asir のみ install したい. +A. + Risa/Asir のみを生成したい場合は, つぎのように入力します. +*/ +/*&C -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, - ライセンス形態 GPL?? -asir : 作者 url - ライセンス形態 ?? -gnuplot : 作者 url - ライセンス形態 GPL? -phc : 作者 Jan Verschelde, url - ライセンス形態 ?? -tigers : 作者 Birk Hubert, url - ライセンス形態 ?? + (cd OpenXM/src ; make install-asir) + (cd OpenXM/rc ; make ) -[OpenXM についての連絡先] -takayama@math.sci.kobe-u.ac.jp +*/ +/*&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. +*/ +/*&jp + OpenXM/rc の下のシェルスクリプト "asir" をサーチパスにコピーして + ください (たとえば, /usr/local/bin or ~/bin へ). + または OpenXM/rc/dot.bashrc か OpenXM/rc/dot.cshrc を + source コマンドで ~/.bashrc か ~/.cshrc より読み込んでください. +*/ -[OpenXM_HOME 下のファイルの構成] +/*&jp +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 を利用するのに必要なファイル. @@ -199,35 +409,73 @@ asir が ox_sm1_forAsir を利用するのに必要なファイル: asir が ox_sm1_gnuplot を利用するのに必要なファイル: lib/asir/ox_launch lib/sm1/bin/ox_sm1_gnuplot (ox_sm1 へのリンク, ox_sm1_gnuplot は fork して - gnuplot_forox を実行します.) + gnuplot4ox を実行します.) lib/asir/xm lib/sm1/callsm1.sm1, lib/sm1/gnuplot.sm1 (ox_sm1_gnuplot の定義ファイル, src/kxx/oxserver00.c ox_sm1 が ox_sm1_gnuplot という名前で呼ばれるとこれらのファイルをロード.) - bin/gnuplot_forox, bin/gnuplot_x11 (gnuplot 本体, src/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. */ +/*&C + +*/ +/*&jp +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 を利用する必要があるためです. + +*/ +/*&eg +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 +*/