=================================================================== RCS file: /home/cvs/OpenXM/doc/install.oxweave,v retrieving revision 1.8 retrieving revision 1.40 diff -u -p -r1.8 -r1.40 --- OpenXM/doc/install.oxweave 2000/01/20 07:25:25 1.8 +++ OpenXM/doc/install.oxweave 2000/12/01 02:27:31 1.40 @@ -1,36 +1,59 @@ -%% $OpenXM: OpenXM/doc/install.oxweave,v 1.7 2000/01/20 03:14:07 takayama Exp $ +%% $OpenXM: OpenXM/doc/install.oxweave,v 1.39 2000/11/30 12:45:13 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 のインストール法を説明します. +ソースからインストールする場合は + ★ OpenXM パッケージの Make 法 +を御覧下さい. +RPM, Debian などのパッケージでインストールする場合は + Web ページの説明どうりにパッケージをインストールするだけで + 設定が終了します. + インストールに必要なシステムの仕様については, 動作環境を御覧ください. */ /*&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. +If you build from the source, see the section + * How to make OpenXM package? +If you install openxm by using RPM or Debian package, +install the system following the instruction given on our web page. + As to the required environment, see the section "System Requirement" */ /*&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 +68,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/rc - make + 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. @@ -79,34 +138,208 @@ by /xxx/yyy/OpenXM. */ /*&jp -(3') bash を利用してる場合, 次の行を ~/.bashrc の最後に加えます. +(3') bash を利用してる場合, 次の行それぞれを ~/.bashrc および ~/.bash_profile +の最後に加えます. */ /*&eg -(3') Append the following line to the end of ~/.bashrc when you are - using bash as your shell. +(3') 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 /xxx/yyy/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 +/*&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 + 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 にインストールされます. + + ここで version は OpenXM の version 番号で, たとえば, + 2000, 3/20(Mon) 版は 1.1.2 + pkg_add に失敗した場合は, /var のサイズを大きくしてやりなおして + みて下さい. + + 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 + + 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 + If you fail "pkd_add", increase the size of /var + + 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 にインストールされます. + + ここで version は OpenXM の version 番号で, たとえば, + 2000, 3/20(Mon) 版は 1.1.2 + suffix は, RPM 版の minor version number. + + /usr/local の下へインストールしなかった場合は, (2) を実行して下さい. + + libgd のインストールが必要な場合もあります. + libgd がインストールしてない場合, + http://www.redhat.com/downloads へアクセスし, libgd をインストール + して下さい. + +*/ +/*&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 + + 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 do not install under /usr/local, goto (2). + + + You might need to install libgd. + If it is not installed in your system, access to + http://www.redhat.com/downloads and get libgd. +*/ + +/*&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: - the following modules and functions have still experimental qualities: + 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. + +**** OpenXM server and client programs (under development) + included only in the source distribution + OpenXM/src/Macaulay2 ( M2 server and client ) + OpenXM/src/ruby ( Ruby client) + +**** Utilities + OpenXM/doc/oxlib ( how to link oxservers as libraries ) + */ /*&C @@ -119,8 +352,19 @@ export PATH たとえば 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 をサーチパスにいれます. + +jdk の入手先: FreeBSD --- /usr/ports/java/jdk を見てください. + Linux --- http://java.sun.com/products/jdk/1.2/ja + http://java.sun.com/j2se/1.3/ja + +注意: +なお, Kaffe 1.0.b4 の java は, class BigInteger に method +toByteArray が含まれてないため, OpenMath モジュールでは使用できません. */ /*&eg ***** JAVA @@ -128,8 +372,22 @@ For example, you need to add the following line 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 +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 --- http://java.sun.com/products/jdk/1.2/ja + http://java.sun.com/j2se/1.3/ja + + +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 @@ -148,13 +406,14 @@ set path=(/usr/local/jdk1.1.8/bin $path) */ /*&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, but we have not yet tested. + FreeBSD 3.x and Linux, but we have not yet tested. */ /*&jp @@ -167,7 +426,7 @@ 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_* @@ -226,6 +485,15 @@ The installation 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 @@ -245,6 +513,15 @@ The installation 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. + */ @@ -288,28 +565,18 @@ xm Version 20000116. ox_help(0); ox_help("keyword"); f [270] */ -/*&jp ---------------- 例 : 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 -で生成されています. +/*&jp + +★ sm1 クライアントの利用例 + */ +/*&eg +****** Example of the use of sm1 client + +*/ + /*&C -------------------------------------- call ox_asir from sm1 sm1 @@ -339,23 +606,46 @@ See OpenXM/Copyright. ★ OpenXM パッケージの Make 法 - FreeBSD 2.2.8, FreeBSD 3.3, Linux で動作するものと期待してます. - Linux glib6 では, いまのところ, /usr/include/features.h - で #define __FAVOR_BSD 1 してコンパイルする必要があります. - (setjmp と sigsetjmp の問題, dirty trick) + FreeBSD 3.x, FreeBSD 4.x, 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 が必要です. + ftp.math.kobe-u.ac.jp/OpenXM/1.1.3 より + openxm-1.1.3.tar.gz + を get して展開して下さい. + tar xzvf openxm-1.1.3.tar.gz + + openxm-1.1.3/OpenXM openxm-1.1.3/OpenXM_contrib + openxm-1.1.3/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 + We have tested the OpenXM package on FreeBSD 3.x, FreeBSD 4.x, Linux. + (On Linux glib6, we needed to define #define __FAVOR_BSD 1 - in /usr/include/features.h - (setjmp vs sigsetjmp) + in /usr/include/features.h, + but now we are compiling some sources with -D_BSD_SOURCE + (setjmp vs sigsetjmp). So, you do not need to make this change.) Do you have directories OpenXM, OpenXM_contrib, OpenXM_contrib2? + get + openxm-1.1.3.tar.gz + from ftp.math.kobe-u.ac.jp/OpenXM/1.1.3 + Expand it by + tar xzvf openxm-1.1.3.tar.gz + + Then, you will get + openxm-1.1.3/OpenXM openxm-1.1.3/OpenXM_contrib + openxm-1.1.3/OpenXM_contrib2 + + If you are a CVS committer, then you can get all sources as follows: */ //&C rcvs checkout OpenXM OpenXM_contrib OpenXM_contrib2 @@ -373,15 +663,58 @@ OpenXM/src/OpenMath のコンパイルおよび利用には /*&jp なお, OpenXM/src/ox_math のコンパイルおよび利用には Mathematica が, OpenXM/src/OpenMath のコンパイルおよび利用には には, jdk (java 環境) が必要です. + +Documents を生成するには, tex, ptex (ascii 日本語 tex), dvips, texinfo, +texi2html, nkf, jlatex2html +が必要です. 詳しくは 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, jlatex2html. 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 */ +/*&eg +To run the system, you need to read OpenXM/rc/dot.cshrc or +OpenXM/rc/dot.bashrc by the source +command for setting proper environmental variable values. + +By the commands + cd OpenXM/rc + make +you can generate dot.cshrc and dot.bashrc. +Read these file by the source command in your .cshrc +or .bashrc (or .bash_profile). +*/ +/*&jp +システムを動かすには, OpenXM/rc/dot.cshrc または +OpenXM/rc/dot.bashrc を source コマンドで +よみこみ環境変数の値を適切に設定する必要があります. + +コマンド + cd OpenXM/rc + make +で dot.cshrc および dot.bashrc が生成されます. +これらのファイルを source コマンドで, +.cshrc または .bashrc (または .bash_profile) より読むようにして下さい. +*/ +/*&C + +*/ + /*&jp [OpenXM 下のファイルの構成メモ] @@ -440,6 +773,7 @@ rcvs export -rHEAD OpenXM_contrib2 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. */ @@ -463,7 +797,20 @@ Solaris でコンパイルするには, /usr/ccs/bin をサーチパ� /usr/ccs/bin must be at the top of the command search path to compile on Solaris. */ +/*&jp +★ Redhat Linux 6.1 上でのコンパイル +m4-1.4 と autoconf-2.13 が必要. +(あらかじめはいっている, autoconf は 2.12 でありこれは + gnuplot の make で不具合を生じます.) + +*/ +/*&eg +***** 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