OpenXM/doc/install.oxweave - diff

Return to install.oxweave CVS log

Up to [local] / OpenXM / doc

Diff for /OpenXM/doc/install.oxweave between version 1.9 and 1.31

-version 1.9, 2000/01/20 08:21:50
+version 1.31, 2000/04/03 05:59:01
 Line 1
 Line 1
 Line 1
- %% $OpenXM: OpenXM/doc/install.oxweave,v 1.8 2000/01/20 07:25:25 takayama Exp $
+ %% $OpenXM: OpenXM/doc/install.oxweave,v 1.30 2000/03/17 03:22:01 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 パッケージの利用方法
+ ★ 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"
-Line 21  As to the required environment, see the section "Syste
+Line 23  As to the required environment, see the section "Syste
 Line 21  As to the required environment, see the section "Syste
 Line 23  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
  */
-Line 45  by /xxx/yyy/OpenXM.
+Line 53  by /xxx/yyy/OpenXM.
 Line 45  by /xxx/yyy/OpenXM.
 Line 53  by /xxx/yyy/OpenXM.
  */
  /*&jp
- (2) 次のように入力して OpenXM/rc/dot.cshrc, OpenXM/rc/dot.bashrc
+ (2) OpenXM/rc/dot.cshrc, OpenXM/rc/dot.bashrc,
-     ファイルを自動生成します.
+     OpenXM/rc/openxm, OpenXM/rc/asir, OpenXM/rc/oxmath, 等の
-     これらのファイルには, OpenXM/bin のファイルを実行するための
+     ファイルを自動生成します.
-     環境変数が定義されています.
+     openxm, asir, oxmath などは OpenXM クライアントを起動するための
+     シエルスクリプトです. これらを /usr/local/bin にインストールするには
+     次のように入力します.
  */
  /*&eg
- (2) Generate  OpenXM/rc/dot.cshrc and OpenXM/rc/dot.bashrc
+ (2) Generate  OpenXM/rc/dot.cshrc, OpenXM/rc/dot.bashrc and
-     by the following command.
+     OpenXM/rc/openxm, OpenXM/rc/asir, OpenXM/rc/oxmath, ...
-     Environmental variables to execute commands in OpenXM/bin
+     The files openxm, asir, oxmath are shell scripts to invoke OpenXM clients.
-     are defined in these files.
+     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.
-Line 89  by /xxx/yyy/OpenXM.
+Line 133  by /xxx/yyy/OpenXM.
 Line 89  by /xxx/yyy/OpenXM.
 Line 133  by /xxx/yyy/OpenXM.
  */
  /*&C
-     source /xxx/yyy/OpenXM/rc/dot.bash
+     source /xxx/yyy/OpenXM/rc/dot.bashrc
  */
+ /*&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
- //&jp (4) asir の利用には  key が必要です.  以下のファイルを御覧ください.
+ //&jp (4) asir の利用には  key が必要です.
- //&eg (5) You need key to use asir.  See the following file:
+ //&eg (4) You need a key to use asir.
- //&C OpenXM/lib/asir/asir_key
  //&C
+ /*&jp
+     asir の起動時のメッセージまたは OpenXM/lib/asir/asir_key を
+     参照して, key を取得して下さい (数秒しかかかりません).
+     Mail の利用ができて, /var/mail の下にメールを着信できれば,
+        /xxx/yyy/OpenXM/rc/fetch_asir_key
+     を実行することにより asir_key を自動で設定できます.
+     FreeBSD の package, Redhat Package manager を利用している
+     場合は, /usr/local/OpenXM/lib/asir/asir_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).
+     If you can get your mails under /var/mail, you can automatically set
+     your key by executing
+        /xxx/yyy/OpenXM/rc/fetch_asir_key
+     If you install the OpenXM package by the pkg_add of FreeBSD or
+     the redhat package manager, the old key file
+     /usr/local/OpenXM/lib/asir/asir_key, if exists,  is saved.
+ */
+ /*&jp
+ ★ OpenXM FreeBSD binary パッケージのインストール方法
+      openxm-version.tgz
+    を ftp サイトより copy して,
+    root になって,
+      pkg_add openxm-version.tgz
+    OpenXM は /usr/local/OpenXM にインストールされます.
+    あとは, 上の (4) へ.
+    ここで version は OpenXM の version 番号で, たとえば,
+, 3/20(Mon) 版は  1.1.2
+    java および linux emulation が実行に必要です.
+    java が, サーチパスのなかにある必要がありますので,
+    たとえば,
+      set path=(/usr/local/jdk1.1.8 $path)
+      rehash
+    してから, pkg_add して下さい.
+    インストール終了後のメッセージにしたがい, 必要な設定を
+    おこなって下さい.
+    /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 asir_key and path.
+    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 番号で, たとえば,
+, 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:
-   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/ *
+%
+    OpenXM/bin/ox_math,  OpenXM/bin/math2ox
+    OpenXM/bin/sm1, ox_sm1 on Linux libc6.
  */
  /*&C
-Line 119  OpenMath 用の OMproxy には現在のところ, jdk が必要です
+Line 315  OpenMath 用の OMproxy には現在のところ, jdk が必要です
 Line 119  OpenMath 用の OMproxy には現在のところ, jdk が必要です
 Line 315  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
-Line 128  In order to use OMproxy, asir client om_*,
+Line 331  In order to use OMproxy, asir client om_*,
 Line 128  In order to use OMproxy, asir client om_*,
 Line 331  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
+ 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
-Line 148  set path=(/usr/local/jdk1.1.8/bin $path)
+Line 359  set path=(/usr/local/jdk1.1.8/bin $path)
 Line 148  set path=(/usr/local/jdk1.1.8/bin $path)
 Line 359  set path=(/usr/local/jdk1.1.8/bin $path)
  */
  /*&C
- OS:  FreeBSD 3.3,
+ OS:  FreeBSD 3.3 (Intel CPU),
-      Linux systems (Plamo Linux on Linux 2.0.33, glibc5,   )
+      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
-Line 167  OS package.
+Line 379  OS package.
 Line 167  OS package.
 Line 379  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_*
-Line 226  The installation is completed.
+Line 438  The installation is completed.
 Line 226  The installation is completed.
 Line 438  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
-Line 245  The installation is completed.
+Line 466  The installation is completed.
 Line 245  The installation is completed.
 Line 466  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.
  */
-Line 288  xm Version 20000116. ox_help(0); ox_help("keyword"); f
+Line 518  xm Version 20000116. ox_help(0); ox_help("keyword"); f
 Line 288  xm Version 20000116. ox_help(0); ox_help("keyword"); f
 Line 518  xm Version 20000116. ox_help(0); ox_help("keyword"); f
  [270]
  */
- /*&jp
- ---------------    例 : asir より tigers を呼び出す.
+ /*&jp
- asir
- load("xm");
+ ★  sm1 クライアントの利用例
- 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
- で生成されています.
  */
+ /*&eg
+ ******  Example of the use of sm1 client
+ */
  /*&C
  --------------------------------------  call ox_asir from sm1
  sm1
-Line 341  See OpenXM/Copyright.
+Line 561  See OpenXM/Copyright.
 Line 341  See OpenXM/Copyright.
 Line 561  See OpenXM/Copyright.
  ★ OpenXM パッケージの Make 法
    FreeBSD 2.2.8, FreeBSD 3.3, Linux で動作するものと期待してます.
    Linux glib6 では, いまのところ, /usr/include/features.h
-   で #define __FAVOR_BSD 1 してコンパイルする必要があります.
+   で #define __FAVOR_BSD 1 してコンパイルする必要がありしたが,
-   (setjmp と sigsetjmp の問題, dirty trick)
+   一部のソースを
+   -D_BSD_SOURCE option をつけて gcc でコンパイルするように変えてます
+   (setjmp と sigsetjmp の問題, dirty trick).
     OpenXM, OpenXM_contrib, OpenXM_contrib2 が必要です.
     cvs コミッタの場合次のようにしてソースをとりよせます.
-Line 350  See OpenXM/Copyright.
+Line 572  See OpenXM/Copyright.
 Line 350  See OpenXM/Copyright.
 Line 572  See OpenXM/Copyright.
  /*&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
+  On Linux glib6, we needed to define
     #define  __FAVOR_BSD 1
-  in /usr/include/features.h
+  in /usr/include/features.h,
-  (setjmp vs sigsetjmp)
+  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:
-Line 373  See OpenXM/Copyright.
+Line 596  See OpenXM/Copyright.
 Line 373  See OpenXM/Copyright.
 Line 596  See 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
-Line 389  you need jdk (java environment).
+Line 627  you need jdk (java environment).
 Line 389  you need jdk (java environment).
 Line 627  you need jdk (java environment).
     make all-kan96xx
    などと各モジュール名を指定してコンパイルして下さい.
+    または
+    OpenXM/src/asir2000 の Makefile を Makefile.forSkip に置き換えて
+    下さい.
  */
  /*&eg
-Line 397  you need jdk (java environment).
+Line 639  you need jdk (java environment).
 Line 397  you need jdk (java environment).
 Line 639  you need jdk (java environment).
    compile each modules independently, e.g.,
      make all-kan96xx
+   Or, replace Makefile by Makefile.forSkip in OpenXM/src/asir2000.
  */
  /*&jp
-Line 457  OpenXM/src/kxx/ox, OpenXM/src/kxx/ox_sm1, OpenXM/src/k
+Line 701  OpenXM/src/kxx/ox, OpenXM/src/kxx/ox_sm1, OpenXM/src/k
 Line 457  OpenXM/src/kxx/ox, OpenXM/src/kxx/ox_sm1, OpenXM/src/k
 Line 701  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.
  */
-Line 480  Solaris でコンパイルするには, /usr/ccs/bin をサーチパ�
+Line 725  Solaris でコンパイルするには, /usr/ccs/bin をサーチパ�
 Line 480  Solaris でコンパイルするには, /usr/ccs/bin をサーチパ�
 Line 725  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

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>