Return to README CVS log

Up to [local] / OpenXM / src / kan96xx

Annotation of OpenXM/src/kan96xx/README, Revision 1.2

1.2     ! takayama    1: %$OpenXM$
        !             2: README (Updated: 1999/11/08)
1.1       maekawa     3:
                      4: "Kan/sm1" is a system for doing algebraic analysis by computer based on
                      5: computations of Groebner bases.
                      6: It is also useful to teach basic notions such as stack, reccursive call,
                      7: object oriented naming system.
                      8: This material may be freely distributed as is.
                      9: This distribution contains only a few examples in the Doc directory.
                     10: So, if you have questions, please send a mail to
                     11:        kan@math.kobe-u.ac.jp
                     12:
                     13:
                     14: Directories
                     15: -----------
                     16:
                     17: Kan      Source files of the kan-library and kan-virtual-machine (kan/sm1).
                     18: gc       Garbage collector written by Hans-J. Boehm and Alan J. Demers.
                     19:          See the README of this directory for the details.
                     20:          In order to get the newest version of it, ftp from
                     21:                  beta.zerox.com
                     22: gmp      GNU MP package
                     23: Doc      Documents. Type in "make" to get the document ttt.tex, onlinehelp.tex.
                     24:          "ttt.tex" is generated from ex.tex.
                     25:          "onlinehelp.tex" will be generated from the running version of sm1.
                     26:          ttt.tex : introduction, onlinehelp.tex : macro reference manual.
                     27:          Library files.
                     28:          This directory contains many libraries with an easy user interface
                     29:          written by sm1.
                     30:          To load all libraries, type in  (cohom.sm1) run  in sm1.
                     31:          See Section 3 of onlinehelp.tex for details.
                     32: lib      symbolic link to Doc.
                     33: bibreference.tex :  A sample citation of kan/sm1.
                     34: plugin           :  plugin modules for sm1. Open XM support.
                     35: Makefile         :  makefile
                     36:
                     37:
                     38: Installation
                     39: ------------
                     40:
                     41: <<1>>
                     42: The kan/sm1-system is mainly developed and tested
1.2     ! takayama   43: on the Linux operating system with the elf-kernel version 1.2.13
        !            44: and FreeBSD 2.x and 3.x.
1.1       maekawa    45: The system will be run on the machines with ansi C-compilers
                     46: on which the Garbage collector of Boehm and Demers works.
                     47:  If you use the same environment, you need no configuration.
                     48: (On some versions of Linux, you must modify Kan/Makefile following
                     49: the comment in it.)
                     50:
                     51: Set the load path for library files if necessary. ==> see (B) below.
                     52:
                     53: Then, just type:
                     54: % make all
                     55:
                     56: You will have
                     57:    sm1
                     58: in the directory Kan.
                     59: Move this file to a directory on your search path.
                     60: (For example,
                     61:     mv sm1 ~/bin
                     62: or
                     63:     mv sm1 /usr/local
                     64: )
                     65:
                     66: -------------------------------------------------
                     67: (A) No plugin
                     68: If you do not need plugin modules for socket and so on, then
                     69: (1) edit Kan/Makefile and delete all lines begin with PLUGIN.
                     70: (2) Type in  "make all2"
                     71: --------------------------------------------------
                     72: (B) Loading path
                     73: Edit the Kan/stackm.h and change the value
                     74:        #define LOAD_SM1_PATH "/usr/local/lib/sm1/"
                     75: to a directory where you can put all the files *.sm1 in lib directory.
                     76: Do not forget to put / at the tail.
                     77: If you are allowed to use /usr/local/lib/sm1, then
                     78: you do not need to change the value of LOAD_SM1_PATH and type in
                     79:     mkdir /usr/local/lib/sm1
                     80:     cp lib/*.sm1 /usr/local/lib/sm1
                     81: When you try to run a file, the system will try to find it firstly
                     82: in the current directory, secondly in the path defined above, and
                     83: finally, the path specified by the environmental variable
                     84: LOAD_SM1_PATH.
                     85: Example:(csh)   setenv LOAD_SM1_PATH $HOME/lib/sm1/
                     86:         (bash)  LOAD_SM1_PATH=$HOME/lib/sm1/   ; export LOAD_SM1_PATH
1.2     ! takayama   87:
1.1       maekawa    88: January 8, 1994.
                     89: Revised March 15, 1997, November 2, 1998.
                     90: Nobuki Takayama,  Department of Mathematics, Kobe university,
                     91: kan@math.kobe-u.ac.jp
                     92:
                     93: FAQ on the installation -----------------------------------------
                     94: Q. My compilation on solaris 2.x stopped with the message
                     95:    ./if_mach SPARC SUNOS5 as -o mach_dep.o ./sparc_mach_dep.s
                     96:    Couldn't execute: No such file or directory
                     97: A. On Solaris 2.x machines,  /usr/ccs/bin must be in your search path.
                     98:    If your shell is the C-shell, type in
                     99:      set path = ($path /usr/ccs/bin)
                    100:      rehash
                    101:      make
                    102:
1.2     ! takayama  103: Q. I cannot generate onlinehelp.tex
        !           104:    There is a line ERROR(sm): ....
        !           105: A. kan96xx is supposed to be in the OpenXM distribution.
        !           106:    Change directory to OpenXM/src/kxx and type in make install2.
        !           107:    It generates files in Doc/bin. These are necessary to generate
        !           108:    the file onlinehelp.tex
        !           109:
        !           110: -----------------------------------------
        !           111: This software is compliant to GNU General Public License.
        !           112:
        !           113:
1.1       maekawa   114:
                    115: