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.17 and 1.46

-version 1.17, 2000/01/25 06:48:49
+version 1.46, 2003/02/14 03:32:44
 Line 1
 Line 1
 Line 1
- %% $OpenXM: OpenXM/doc/install.oxweave,v 1.16 2000/01/21 13:49:52 takayama Exp $
+ %% $OpenXM: OpenXM/doc/install.oxweave,v 1.45 2002/03/02 01:00:23 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
+               http://www.openxm.org
- for troubles.
- OpenXM package : Getting started.
  */
  /*&jp
- ★ OpenXM パッケージの利用方法
- この節では, OpenXM package binary distribution のインストール法を説明します.
- インストールに必要なシステムの仕様については, 動作環境を御覧ください.
- */
- /*&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"
- */
- /*&jp
- (1)  Tar ボールより次のようにしてディレクトリ OpenXM を取り出します.
+ ------------ ソースからコンパイルしてインストールする方法 ----
-      OpenXM はどこにおいてもかまいません. ルートになってインストール
+ (cd OpenXM/src ; make configure ; make install)
-      する必要もありません.
+              バイナリとライブラリとドキュメント類は
-      できれば, /usr/local/OpenXM  においてほしいと思います.
+              OpenXM/bin, OpenXM/lib, OpenXM/doc
+              にインストールされます.
+ (cd OpenXM/rc ; make install)
+              "asir", "sm1", ... などのシェルスクリプトが生成されて
+              /usr/local/bin
+              にコピーされます.
+              この部分は root で実行してください.
  */
  /*&eg
- (1)  Extract the directory OpenXM from the tar ball.
+ OpenXM package : Getting started.
-      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-binary-OPERATING_SYSTEM_CPU_TYPE.tgz
- */
+ ----------- An instruction for a quick installation from the source code ---
- /*&jp
+ (cd OpenXM/src ; make configure ; make install)
- 以下 (1) で生成されたディレクトリ OpenXM の絶対パスを /xxx/yyy/OpenXM
+              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.
- */
- /*&eg
- In the sequel, we will denote the absolute path of the directory OpenXM
- by /xxx/yyy/OpenXM.
  */
  /*&jp
- (2) 次のように入力して OpenXM/rc/dot.cshrc, OpenXM/rc/dot.bashrc
-     ファイルを自動生成します.
-     これらのファイルには, OpenXM/bin のファイルを実行するための
-     環境変数が定義されています.
+ ------- 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
- (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.
- */
+ ------- If you need only asir and kan,
- /*&C
+ (cd OpenXM/src ; make install-kan-ox ; make install-asir-contrib)
+              You will get only asir (OpenXM version) and kan/sm1.
+ (cd OpenXM/rc ; make install)
-      cd /xxx/yyy/OpenXM/rc
+ -------------------------------------------
-      make
+ Risa/Asir with asir-contrib is the main client system in the OpenXM project.
+ You can start Risa/Asir by the command "asir".
+ The manual of Risa/Asir and Asir-contrib can be found in the
+ OpenXM/doc directory and http://www.openxm.org
  */
  /*&jp
- (3) csh を利用してる場合, 次の行を ~/.cshrc の最後に加えます.
+ -----------  幾つか解説  ------------------
+ 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
- (3) Append the following line to the end of  ~/.cshrc when you are
-     using csh as your shell.
+ -----------  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
-     source /xxx/yyy/OpenXM/rc/dot.cshrc
+      cd OpenXM/rc
+      make install
  */
  /*&jp
- (3') bash を利用してる場合, 次の行を ~/.bashrc の最後に加えます.
+      /usr/local/bin でなく, home directory の bin にインストールしたい
+      ときは, 次のように入力してください.
  */
  /*&eg
- (3') Append the following line to the end of  ~/.bashrc when you are
-     using bash as your shell.
+     If you want to install them under the bin of your home directory,
+     type in as follows.
  */
  /*&C
-     source /xxx/yyy/OpenXM/rc/dot.bash
+    cd OpenXM/rc
+    make install PREFIX=$HOME/bin
  */
+ /*&C
- /*&jp
+    [Note] If you are Solaris user, you might have to type in like
+      /usr/ccs/bin/make install PREFIX=$HOME/bin
-  (3) または (3') を終了したら, いったん logout して login しなおすか
-  または, source コマンドで, dot.bash または dot.csh を読み込んで下さい.
  */
- /*&eg
+ /*&jp
-    After finishing the step (3) or (3'), logout and login again,
-    or read dot.bash or dot.cshrc file by the source command.
- */
+ Q. OpenXM/bin の下のファイルを直接実行できるようにしたい.
+ A.
+ OpenXM/bin の下のファイルを直接実行したい場合は, 以下の設定が必要です.
+  # csh を利用してる場合, 次の行を ~/.cshrc の最後に加えます.
- //&C
- //&jp (4) asir の利用には  key が必要です.
- //&eg (4) You need a key to use asir.
- //&C
- /*&jp
-     asir の起動時のメッセージまたは OpenXM/lib/asir/asir_key を
-     参照して, 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).
- */
+ 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.
- /*&C
- ***** QUALITY:
+  # Append the following line to the end of  ~/.cshrc when you are
-   the following modules and functions have still experimental qualities:
+     using csh as your shell.
-    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/bin/sm1, ox_sm1 on Linux libc6.
  */
  /*&C
+     source OpenXM/rc/dot.cshrc
  */
  /*&jp
- ★ Java に関する注意:
+  # bash を利用してる場合, 次の行それぞれを ~/.bashrc および ~/.bash_profile
- 注意 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 をサーチパスにいれます.
- 注意:
- なお, Kaffe 1.0.b4 の java は, class BigInteger に method
- toByteArray が含まれてないため, OpenMath モジュールでは使用できません.
  */
  /*&eg
- ***** JAVA
+  # Append the following lines to the end of  ~/.bashrc and ~/.bash_profile
- In order to use OMproxy, asir client om_*,
+      respectively when you are using bash as your shell.
- 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
- 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
+     source OpenXM/rc/dot.bashrc             (.bashrc)
+     source ~/.bashrc                        (.bash_profile)
  */
- /*&jp
- ★ 動作環境
+ /*&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 (Intel CPU),
+        ox_xterm*iconic: on
-      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 3.x and Linux, but we have not yet tested.
  */
  /*&jp
+ 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
-                                 [ see the section on JAVA]
      Asir client functions  om_*
      sm1 client functions   om_*
- (3) PHC pack (OpenXM/bin/phc)  and  asir client functions
+ (3) PHC pack (OpenXM/bin/phc)  and  asir client functions phc_*
-     phc_*  run only on linux (glib5).
+     phc_*  run only on linux.
-     If you install the linux emulation^{note 1} on Free BSD, they run on
+     If you install the linux emulation on Free BSD, they run on
      FreeBSD, too.
      <note 1>
        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_base-*      The base set of packages needed in Linux mode
-       linux_devtools-5.2  Packages needed for doing development 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 が変.
- 注意 1.
+ A.
  asir で日本語のヘルプを利用するには,
  PAGER=jless
  export PAGER
  などで, 日本語を扱える PAGER を指定する必要があるかもしれません.
  */
- /*&eg
+ /*&C
- The installation is completed.
+ -----------------------------------------------------
  */
- /*&jp
- 以上.
- */
  /*&jp
- ★ 文書
+ Q. OpenXM パッケージの文書は？
+ A.
    OpenXM パッケージでもっとも充実しているクライアントは,
    asir です.
    asir のつかいかたは
-Line 273  The installation is completed.
+Line 268  The installation is completed.
 Line 273  The installation is completed.
 Line 268  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
+ Q. Where can I find documents of the OpenXM package.
+ A.
-   The best OpenXM client in the OpenXM package is now
+   The main OpenXM client in the OpenXM package is now
    asir.
    Documents on asir are
      OpenXM/doc/asir2000/man-eg.dvi
-Line 292  The installation is completed.
+Line 296  The installation is completed.
 Line 292  The installation is completed.
 Line 296  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.
- /*&eg
+   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.
- ***** A QUICK TOUR OF OPENXM BY ASIR
  */
- /*&jp
- ★ ASIR による使用例
- asir を動作させるには, key が必要です.
- OpenXM/lib/asir/asir_key のコメントまたは起動時のメッセージをみて,
- key を E-mail でとりよせて下さい.
- */
- /*&C
- ----------------   Call ox_sm1 from asir.
- bash-2.03$ asir
- This is Risa/Asir, Version 20000120.
- Copyright (C) FUJITSU LABORATORIES LIMITED.
--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]
- ---------------    Call gnuplot from asir.
- bash-2.03$ asir
- This is Risa/Asir, Version 20000120.
- Copyright (C) FUJITSU LABORATORIES LIMITED.
--1999. All rights reserved.
- xm Version 20000116. ox_help(0); ox_help("keyword"); for help message
- [269] gnuplot("plot sin(x);");
- [270]
- */
- /*&jp
- ★  sm1 クライアントの利用例
- */
  /*&eg
+ Q. I want to install only Risa/Asir.
- ******  Example of the use of sm1 client
+ A.
+    If you want to generate only Risa/Asir,  type in as follows.
  */
- /*&C
- --------------------------------------  call ox_asir from sm1
- sm1
- (oxasir.sm1) run  ;
- [(x^20-y^20) (x,y)] fctr pmat ;     factorize x^20-y^20 by call ox_asir
- */
  /*&jp
- [著作権表示]
+ Q. Risa/Asir のみ install したい.
- OpenXM/Copyright を御覧ください.
+ A.
+    Risa/Asir のみを生成したい場合は,  つぎのように入力します.
  */
- /*&eg
+ /*&C
- [COPYRIGHT]
- See OpenXM/Copyright.
- */
- /*&eg
+           (cd OpenXM/src ;  make install-asir)
+           (cd OpenXM/rc ; make )
- *****  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 してコンパイルする必要があります.
-   (setjmp と sigsetjmp の問題, dirty trick)
-    OpenXM, OpenXM_contrib, OpenXM_contrib2 が必要です.
-    cvs コミッタの場合次のようにしてソースをとりよせます.
- */
  /*&eg
- * How to make OpenXM package?
+         Copy the shell script "asir" at OpenXM/rc in your search path, e.g.,
-  We have tested the OpenXM package on FreeBSD 2.2.8, FreeBSD 3.3, Linux.
+         /usr/local/bin or ~/bin
-  On Linux glib6, you need to define
+         Or, read OpenXM/rc/dot.bashrc or OpenXM/rc/dot.bashrc by the source
-    #define  __FAVOR_BSD 1
+         command from your ~/.bashrc or ~/.cshrc.
-  in /usr/include/features.h
-  (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:
  */
- //&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
- */
- /*&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
+         OpenXM/rc の下のシェルスクリプト "asir" をサーチパスにコピーして
-   OpenXM_contrib2/asir2000 の配布を受けてない場合 (ソースライセンスを
+         ください (たとえば, /usr/local/bin or ~/bin へ).
-   富士通より受ける必要があります),
+         または OpenXM/rc/dot.bashrc か OpenXM/rc/dot.cshrc を
-   OpenXM/src/Makefile の各モジュール名 たとえば
+         source コマンドで ~/.bashrc か ~/.cshrc より読み込んでください.
-    make all-kan96xx
-   などと各モジュール名を指定してコンパイルして下さい.
  */
- /*&eg
-   If you cannot get a source liscence of OpenXM_contrib2/asir2000
-   from Fujitsu labs,
-   compile each modules independently, e.g.,
-     make all-kan96xx
- */
  /*&jp
+ Q. OpenXM の下のファイル構成はどうなっていますか?
+ A.
  [OpenXM 下のファイルの構成メモ]
  lib/asir には, asir のライブラリ, ox_asir 本体
-Line 490  asir が ox_sm1_gnuplot を利用するのに必要なファイル:
+Line 377  asir が ox_sm1_gnuplot を利用するのに必要なファイル:
 Line 490  asir が ox_sm1_gnuplot を利用するのに必要なファイル:
 Line 377  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 にコピーされますが,
-Line 504  OpenXM/src/kan96xx/Kan/sm1
+Line 394  OpenXM/src/kan96xx/Kan/sm1
 Line 504  OpenXM/src/kan96xx/Kan/sm1
 Line 394  OpenXM/src/kan96xx/Kan/sm1
  OpenXM/src/kxx/ox, OpenXM/src/kxx/ox_sm1, OpenXM/src/kxx/oxlog
  へのシンボリックリンクが作成されます.
- [CVSコミッタ用メモ]
+ Q. <<  OpenXM ディレクトリ配布版の作成方法 >>
- <<  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.
  */
-Line 516  rcvs export -rHEAD OpenXM_contrib2
+Line 408  rcvs export -rHEAD OpenXM_contrib2
 Line 516  rcvs export -rHEAD OpenXM_contrib2
 Line 408  rcvs export -rHEAD OpenXM_contrib2
  */
  /*&jp
+ Q. Solaris でコンパイルがうまくいきません.
- ★ Solaris に関する注意.
+ A.
  Solaris ではまだ問題が山積してます.
  Solaris での make の問題点については, OpenXM/doc/OpenXM-FAQ-jp.txt
  を見てください.
-Line 526  Solaris でコンパイルするには, /usr/ccs/bin をサーチパ�
+Line 418  Solaris でコンパイルするには, /usr/ccs/bin をサーチパ�
 Line 526  Solaris でコンパイルするには, /usr/ccs/bin をサーチパ�
 Line 418  Solaris でコンパイルするには, /usr/ccs/bin をサーチパ�
  */
  /*&eg
- ***** COMPILE ON SOLARIS
+ Q. I cannot make on Solaris.
+ A.
   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
-Line 534  Solaris でコンパイルするには, /usr/ccs/bin をサーチパ�
+Line 427  Solaris でコンパイルするには, /usr/ccs/bin をサーチパ�
 Line 534  Solaris でコンパイルするには, /usr/ccs/bin をサーチパ�
 Line 427  Solaris でコンパイルするには, /usr/ccs/bin をサーチパ�
  */
- /*&C
- */

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