archive/README.orig

   1 README file for maxima
   2
   3 MAXIMA is a fairly complete computer algebra system.
   4
   5 This system MAXIMA is a COMMON LISP implementation due to William F.
   6 Schelter, and is based on the original implementation of Macsyma at
   7 MIT, as distributed by the Department of Energy.  I now have
   8 permission from DOE to make derivative copies, and in particular to
   9 distribute it under the GNU public license.  See the file COPYING
  10 included in the distribution.   Thus these files may now be redistributed
  11 under the terms of GNU public license.
  12
  13 The known shortfalls of being completely within the common lisp
  14 standard, are several calls to errset.  This can be circumvented but
  15 not completely eliminated.  Also there are some special variables
  16 which need to be proclaimed and then unproclaimed special later.
  17
  18 On most common lisp systems, all necessary files are in the src directory.
  19 Basically one loads the file sysdef.lisp, after having set the directory
  20 paths in that file, and then does a (make :maxima :compile t).  Before
  21 dumping it one does (make :maxima ).   If you are using clisp, then
  22 you can do  (cd src ; make test-clisp), since the requisite files are in the
  23 file compile-clisp.lisp and the makefile will load them.
  24
  25 BUILDING:
  26 ========
  27
  28 If building with GCL (GNU Common Lisp) version 2.0 or later,
  29 edit the file maxima-x.x/configure putting the correct
  30 pathnames in it.  It presupposes your having the .o files from
  31 the GCL build available, since a  link will be done to produce a new
  32 image containing maxima.
  33
  34 In the main maxima directory,
  35
  36 % ./configure
  37 % make
  38
  39 This should produce eventually a file maxima/src/saved_maxima
  40
  41 TESTING
  42 =======
  43 To test the system, in the main maxima directory do
  44
  45 % make test
  46
  47 If this completes successfully, then you may wish to eliminate those .o
  48 files no longer needed:
  49
  50 % (cd src ; make clean)
  51
  52 If you wish to eliminate the source to save space and just keep the
  53 necessary .o files, and autoloading .lisp and .mac files, as well as
  54 the documentation, you may
  55
  56 % (cd src ; make eliminate-source)
  57
  58 The maxima/info directory contains a first draft of a manual for maxima.
  59 The make in that directory can produce a .dvi file for printing and
  60 maxima.info for examination in the info system of emacs.   We would MOST
  61 welcome some tutorial and beginner information for this manual.
  62
  63 INSTALLING
  64 ==========
  65
  66 After building and possibly removing source and .o files as above,
  67 do
  68
  69 % cd maxima
  70 % make install
  71 to put things in /usr/local (recommended default).
  72
  73 To put things under /public/bin and /public/lib/maxima-5.x.x
  74 you should edit the file 'configure' in the main directory of
  75 the distribution to set up the directories.   Then after doing
  76 configure you can do:
  77
  78 % make install PREFIX_DIR=/public
  79
  80 The MAXIMA_DIRECTORY environment variable will be set to the
  81 maxima library directory, by the executable shell script 'maxima'
  82 which invokes maxima.
  83
  84 Additional information is available at
  85 http://www.ma.utexas.edu/maxima.html
  86
  87 There is now an alternative to the command line version,
  88 which is called xmaxima.   That version runs under MS windows
  89 as well, and has a tcl/tk interface.
  90
  91 If you install in PREFIX_DIR=/public then /public/bin/xmaxima
  92 should get the tcl/tk interface version.
  93
  94
  95 W. Schelter, the University of Texas, and other parties provide this
  96 program on an "as is" basis without warranty of any kind, either
  97 expressed or implied, including, but not limited to, the implied
  98 warranties of merchantability and fitness for a particular purpose.
  99