=================================================================== RCS file: /home/cvs/OpenXM/doc/install.oxweave,v retrieving revision 1.7 retrieving revision 1.34 diff -u -p -r1.7 -r1.34 --- OpenXM/doc/install.oxweave 2000/01/20 03:14:07 1.7 +++ OpenXM/doc/install.oxweave 2000/09/05 11:57:04 1.34 @@ -1,19 +1,24 @@ -%% $OpenXM: OpenXM/doc/install.oxweave,v 1.6 2000/01/19 12:57:39 takayama Exp $ +%% $OpenXM: OpenXM/doc/install.oxweave,v 1.33 2000/09/05 08:24:34 takayama Exp $ OpenXM/doc/install.oxweave /*&C OpenXM URL : http://www.math.kobe-u.ac.jp/OpenXM + http://www.openxm.org +Consult firstly the ERRATA section for your release on this web cite +for troubles. OpenXM package : Getting started. +This document is for OpenXM version 1.1.3. (Draft) + */ /*&jp -★ OpenXM パッケージの利用方法 +★ OpenXM GENERIC パッケージの利用方法 この節では, OpenXM package binary distribution のインストール法を説明します. インストールに必要なシステムの仕様については, 動作環境を御覧ください. */ /*&eg -***** HOW TO USE OpenXM PACKAGE? +***** HOW TO INSTALL OpenXM GENERIC PACKAGE? In this section, we will explain how to install OpenXM package binary distribution. As to the required environment, see the section "System Requirement" @@ -21,16 +26,22 @@ As to the required environment, see the section "Syste /*&jp (1) Tar ボールより次のようにしてディレクトリ OpenXM を取り出します. - 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-shared.tgz tar xzvf OpenXM-binary-OPERATING_SYSTEM_CPU_TYPE.tgz */ @@ -45,30 +56,66 @@ by /xxx/yyy/OpenXM. */ /*&jp -(2) 次のように入力して OpenXM/rc/dot.cshrc, OpenXM/rc/dot.bashrc - ファイルを自動生成します. - これらのファイルには, OpenXM/bin のファイルを実行するための - 環境変数が定義されています. +(2) 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 -(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. +(2) Generate 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 - cd /xxx/yyy/OpenXM - make + cd /xxx/yyy/OpenXM/rc + make install */ /*&jp + + /usr/local/bin でなく, home directory の bin にインストールしたい + ときは, 次のように入力してください. + +*/ +/*&eg + + If you want to install them under the bin of your home directory, + type in as follows. + +*/ +/*&C + + cd /xxx/yyy/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/bin の下のファイルを直接実行したい場合は, 以下の設定が必要です. +OpenXM clients を実行するだけの場合は, (3), (3') は skip してください. + (3) csh を利用してる場合, 次の行を ~/.cshrc の最後に加えます. */ /*&eg + +If you want to execute binaries under OpenXM/bin, you need to perform +(3) and (3'). +If you use only OpenXM clients, skip (3) and (3'). + (3) Append the following line to the end of ~/.cshrc when you are using csh as your shell. @@ -89,30 +136,234 @@ by /xxx/yyy/OpenXM. */ /*&C - source /xxx/yyy/OpenXM/rc/dot.bash + source /xxx/yyy/OpenXM/rc/dot.bashrc */ -//&C -//&jp (4) asir の利用には key が必要です. 以下のファイルを御覧ください. -//&eg (5) You need key to use asir. See the following file: -//&C OpenXM/lib/asir/asir_key -//&C +/*&jp + (3) または (3') を終了したら, いったん logout して login しなおすか + または, source コマンドで, dot.bashrc または dot.csh を読み込んで下さい. + +*/ +/*&eg + + After finishing the step (3) or (3'), logout and login again, + or read dot.bashrc or dot.cshrc file by the source command. + +*/ + + /*&C -QUALITY: - the following functions have still experimental qualities: + + FAQ + +*/ +/*&jp +Q. OpenXM の asir OpenXM client を icon でスタートするには? +A. 次の行を, .Xdefaults または, xrdb で読み込むファイルに書いておきます. +*/ +/*&eg +Q. How to start asir OpenXM clients in the iconic mode? +A. Add the following line to .Xdefaults or a file you read by xrdb. +*/ +/*&C + + ox_xterm*iconic: on + +*/ +/*&jp + +★ OpenXM FreeBSD binary パッケージのインストール方法 + openxm-version.tgz + を ftp サイトより copy して, + root になって, + pkg_add openxm-version.tgz + OpenXM は /usr/local/OpenXM にインストールされます. + あとは, 上の (4) へ. + ここで version は OpenXM の version 番号で, たとえば, + 2000, 3/20(Mon) 版は 1.1.2 + + java および linux emulation が実行に必要です. + java が, サーチパスのなかにある必要がありますので, + たとえば, + set path=(/usr/local/jdk1.1.8 $path) + rehash + してから, pkg_add して下さい. + インストール終了後のメッセージにしたがい, 必要な設定を + おこなって下さい. + + jdk は /usr/ports/lang/jdk よりインストールできます. + Linux emulation を有効にするには, + /etc/rc.conf に + linux_enable="YES" + と書き, + /usr/ports/emulators/linux_base を用いて, linux 用の共有ライブラリ等を + インストールしておきます. + (FreeBSD 3.x, 4.x) + + + /usr/local にインストールしなかった場合は, + (2) を実行して下さい. + +*/ +/*&eg + +***** HOW TO INSTALL OpenXM FreeBSD binary package + Copy + openxm-version.tgz + from our ftp cite. + Become the super user and type + pkg_add openxm-version.tgz + OpenXM will be installed to /usr/local/OpenXM + Go to (4) above. + Here, version is the version number of OpenXM. + For example, the version number of the OpenXM of May 20 (Mon), 2000 + is 1.1.2 + + java and linux emulation are required to run OpenXM packages. + Java needs to be in the search path. So, for example, execute pkg_add + after + set path=(/usr/local/jdk1.1.8 $path) + rehash + Following the message of pkg_add after the installation, + set path. + + jdk can be installed by /usr/ports/lang/jdk. + Add the line + linux_enable="YES" + to /etc/rc.conf and install shared libraries for linux + by /usr/ports/emulators/linux_base. + Then, you can emulate linux. + + If you do not install under /usr/local, + goto (2). + +*/ +/*&jp + +★ OpenXM Redhat Package manager (Linux) + binary パッケージのインストール方法 + openxm-shared-version-suffix.noarch.rpm + openxm-binary-version-suffix.i386.rpm + を ftp サイトより copy して, + root になって, + rpm -i openxm-shared-version-suffix.noarch.rpm + rpm -i openxm-binary-version-suffix.i386.rpm + OpenXM は /usr/local/OpenXM にインストールされます. + あとは, 上の (4) へ. + ここで version は OpenXM の version 番号で, たとえば, + 2000, 3/20(Mon) 版は 1.1.2 + suffix は, RPM 版の minor version number. + + Debian を利用している場合, コマンド alien で, rpm 形式を deb 形式に + 変換できます. + + /usr/local の下へインストールしなかった場合は, (2) を実行して下さい. + +*/ +/*&eg + +***** HOW TO INSTALL OpenXM by the redhat Package manager (Linux) + Copy + openxm-shared-version-suffix.noarch.rpm + openxm-binary-version-suffix.i386.rpm + from our ftp cite. + Become the super user and type + rpm -i openxm-shared-version-suffix.noarch.rpm + rpm -i openxm-binary-version-suffix.i386.rpm + OpenXM will be installed to /usr/local/OpenXM + Go to (4) above. + Here, version is the version number of OpenXM. + For example, the version number of the OpenXM of May 20 (Mon), 2000 + is 1.1.2 + suffix is the minor version number of the package. + + If you are using debian, please use the command alien to translate + rpm to deb. + + If you do not install under /usr/local, goto (2). + + +*/ + +/*&C + +***** OpenXM client programs under OpenXM/bin or /usr/local/bin: + asir + oxmath + openxm sm1 + +***** OpenXM server programs: + OpenXM/bin/ox_asir + OpenXM/bin/ox_sm1 + OpenXM/bin/ox_math + OpenXM/lib/sm1/bin/ox_sm1_gnuplot + OpenXM/lib/sm1/bin/ox_sm1_phc + OpenXM/lib/sm1/bin/ox_sm1_tigers + OpenXM/lib/java-support/OMproxy.class + +***** QUALITY: + Experimental: 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/lib/java-support/ * + 70% + OpenXM/bin/ox_math, OpenXM/bin/math2ox + OpenXM/bin/sm1, ox_sm1 on Linux libc6. */ /*&C +*/ +/*&jp +★ Java に関する注意: +注意 1. +OpenMath 用の OMproxy には現在のところ, jdk が必要です. +たとえば bash を利用している場合, .bashrc で +PATH=/usr/local/jdk1.1.8/bin:$PATH +export PATH +などとして, jdk の java, javac をサーチパスの先のほうへもっていくようにして +ください. +csh を利用している場合, .cshrc で +set path=(/usr/local/jdk1.1.8/bin $path) +として, jdk の java, javac をサーチパスにいれます. +jdk の入手先: FreeBSD --- /usr/ports/java/jdk を見てください. + Linux --- +注意: +なお, 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 + + +Where can I get jdk? : FreeBSD --- see /usr/ports/java/jdk + Linux --- + +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 ★ 動作環境 @@ -123,17 +374,18 @@ QUALITY: */ /*&C -OS: FreeBSD 3.3, - Linux systems (Plamo Linux on Linux 2.0.33, glibc5, ) +OS: FreeBSD 3.3, 3.4, 4.x (Intel CPU), + Linux systems (Intel CPU): + Most Linux with libc5 and with libc6 (glibc 2.x). 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. + FreeBSD 3.x and Linux, but we have not yet tested. */ /*&jp -次の module は, OS の標準 distribution 以外に, さらに下に記したソフトを +次の modules は, OS の標準 distribution 以外に, さらに下に記したソフトを 必要とします. */ /*&eg @@ -142,17 +394,24 @@ 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?? + [ 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 on Free BSD, they run on - FreeBSD, too. (In this case, generate OpenXM/bin/phc by hand.) + 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 */ @@ -168,7 +427,7 @@ export PAGER /*&eg -The install is completed. +The installation is completed. */ /*&jp @@ -194,6 +453,15 @@ 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 @@ -213,84 +481,118 @@ 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. + + If you are interested in writing a server for OpenXM, please refer to + OpenXM/src/ox_toolkit and OpenXM/src/OpenMath. + */ -/*&jp -注意: -$OpenXM_HOME/bin の下の, fep, phc は, いまのところ -linux 用のバイナリまたはバイナリへのシンボリックリンクです. -Linux 以外の場合はバイナリを入れ換える必要があります. +/*&eg +***** A QUICK TOUR OF OPENXM BY ASIR -★使用例 +*/ +/*&jp -OpenXM は X Window System 上でしか動作しません. +★ 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. +*/ -/*&C +/*&eg + +***** 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 してコンパイルする必要がありしたが, + 一部のソースを + -D_BSD_SOURCE option をつけて gcc でコンパイルするように変えてます + (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, we needed to define + #define __FAVOR_BSD 1 + in /usr/include/features.h, + but now we are compiling some sources with -D_BSD_SOURCE + (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: */ @@ -309,37 +611,42 @@ OpenXM/Copyright を御覧ください. /*&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 - Solaris でコンパイルするには, /usr/ccs/bin をサーチパスの最初へもっていって - おきます. -*/ -/*&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 下のファイルの構成] +[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 を利用するのに必要なファイル. @@ -373,8 +680,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 @@ -386,6 +693,7 @@ OpenXM/src/kxx/ox, OpenXM/src/kxx/ox_sm1, OpenXM/src/k 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. */ @@ -398,28 +706,32 @@ rcvs export -rHEAD OpenXM_contrib2 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. +*/ +/*&jp -/*&C +★ Redhat Linux 6.1 上でのコンパイル +m4-1.4 と autoconf-2.13 が必要. +(あらかじめはいっている, autoconf は 2.12 でありこれは + gnuplot の make で不具合を生じます.) */ -/*&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) +***** COMPILE ON Redhat Linux 6.1 +m4-1.4 and autoconf-2.13 are required. +(Preinstalled autoconf is version 2.12. It causes a trouble when + you build gnuplot.) +*/ + +/*&C + */