======================================================
Macaulay version 3
by
Dave Bayer (Barnard Coll.) Mike Stillman (Cornell Univ.)
Department of Mathematics Department of Mathematics
Columbia University Cornell University
New York, NY 10027 Ithaca, NY 14853
(212)854-2643, 864-4235 (607)255-7240, 257-5320
dab@math.columbia.edu mike@math.cornell.edu
=======================================================
17 Dec 92
Dear Colleagues,
This file (README) describes briefly the contents of the Macaulay Unix
distribution. Versions of Macaulay for the Amiga, Macintosh, NeXT,
and 386, 486 PC's are also available. These versions will be placed
on zariski.harvard.edu hopefully within the next month.
The Unix distribution is the file "M3.tar". After unpacking this file
you will have a directory tree with the top node named "Macaulay".
The files that you should read in order to obtain and install
Macaulay are:
README this file, which describes the Unix distribution, installing
Macaulay, and testing the installation.
OBTAINING how to obtain the distribution (e-mail to one of us to
ask for this file. Alternatively, if you are
familiar with the internet, you may use anonymous ftp
to zariski.harvard.edu to obtain the Macaulay distribution:
cd Macaulay, binary, mget README M3.tar).
The other files and directories are:
biblioreference.tex
This file contains a sample LaTeX biblio reference
that you may use. If you use Macaulay in your work, we ask
that you reference it in your publications.
bin/ This directory contains the Macaulay script that you
use to invoke Macaulay, as well as the file used for
Macaulay's on-line help facility. After installation,
it also includes Macaulay.bin, the actual program.
doc/ This directory contains two lists of the Macualay
commands and scripts: one alphabetized, and one
organized by subject. It also contains the Macaulay
Tutorial in binhex form: The tutorial was written on
a Macintosh using Microsoft Word 5.0. To unpack this
file on a Macintosh, you need the shareware product
Stuffit. For more information on printing the tutorial,
see the README file in this directory.
man/ The LaTeX source for the Macaulay manual. To reconstruct
the manual, see the README file in this directory. You
may also ftp the postscript form of the manual directly.
src/ This directory contains the source code for Macaulay.
scripts/ This directory contains three subdirectories of scripts
maintained by David Eisenbud, Michael Johnson, and Mike
Stillman.
=================================
Unix Installation
=================================
Steps:
1. Set up the correct makefile
Start off in the directory "Macaulay". This directory should have
subdirectories "src", "bin", and others.
Change to the subdirectory containing the Macaulay source code:
cd src
If you are using a Sparcstation, the makefile is already correctly set up.
If you are using a Decstation, use makefile.dec instead:
cp makefile.dec makefile
If you are on a different Unix machine, try using the default makefile.
If that doesn't work, contact one of us. If you succeed in getting
Macaulay to run on other machines (or if you have troubles doing so!), we
would like to know about it.
2. Compile Macaulay, and place the executable program into the "bin" directory
make Macaulay.bin
This will take a few minutes. At this point, a new file named
Macaulay.bin has been created. Now move this file into the "bin"
directory.
mv Macaulay.bin ../bin
3. Set the Macaulay shell script correctly
The point of this step is to inform Macaulay where the help file and the
supplied Macaulay scripts reside. The Macaulay shell script is in the
bin directory:
cd ../bin
Now edit the file "Macaulay" using a text editor such as "vi", "emacs",
or "textedit". Change the line
set macdir=/usr/local/Macaulay
to change the directory "/usr/local/Macaulay" to the full pathname of the
Macaulay directory.
4. Move this shell file to a standard location
The usual place to install Macaulay is in /usr/local/bin, although any
directory that your system searches for programs will do. Have your system
administrator place this file there:
cp Macaulay /usr/local/bin
rehash
5. Test the installation
Change to any directory not related to the Macaulay tree above, such as
your home directory, and then start Macaulay:
Macaulay
The capital M is important! If Macaulay does not start up, then either
you edited the Macaulay script incorrectly, or your "path" variable
isn't set to look at the directory where you did put it.
Next run the file TEST (run this is inside of Macaulay. Don't forget
the beginning "<").
</usr/local/Macaulay/TEST
If you placed the Macaulay directory somewhere else, use that directory
instead. This Macaulay script file exits Macaulay after it is done, and
writes a file called mytest.log.
Compare this file with what it should be:
diff mytest.log /usr/local/Macaulay/TEST.log
Any differences are displayed. If there are none, then the installation
was successful. If there were differences, look at the file and see
what the problem was. The usual problem is that "macdir" has been set
incorrectly, so that Macaulay cannot find the help file, or the scripts
supplied with Macaulay.
6. Clean up (optional)
If you are low on disk space, you may remove the directories named
"man", "doc", and "src". DO NOT remove "scripts" or "bin".
7. Start using Macaulay. Good luck!
If you have any problems, please contact one of us. We suggest working
through the Macaulay Tutorial if you are new to Macaulay. The tutorial
is included in this distribution, and can be printed on a Macintosh if
you have Microsoft Word 5.0. If not, contact Mike Stillman for a hardcopy.
