README
author lcp
Fri May 13 11:10:14 1994 +0200 (1994-05-13)
changeset 370 e95e212512d1
parent 196 7646f5b4653c
child 470 6cb6dd05d761
permissions -rw-r--r--
make-all-poly, make-all-nj: restored to main directory as examples
README: modified accordingly
lcp@86
     1
		     ISABELLE-93 DISTRIBUTION DIRECTORY
clasohm@0
     2
clasohm@0
     3
------------------------------------------------------------------------------
lcp@86
     4
ISABELLE-93 IS INCOMPATIBLE WITH EARLIER VERSIONS.  PLEASE CONSULT THE
clasohm@0
     5
DOCUMENTATION.
clasohm@0
     6
------------------------------------------------------------------------------
clasohm@0
     7
clasohm@0
     8
This directory contains the complete Isabelle system.  To build and test the
clasohm@0
     9
entire system, including all object-logics, use the shell script make-all.
clasohm@0
    10
Pure Isabelle and each of the object-logics can be built separately using the
clasohm@0
    11
Makefiles in the respective directories; read them for more information.
clasohm@0
    12
clasohm@0
    13
				THE MAKEFILES
clasohm@0
    14
clasohm@0
    15
The Makefiles can use two different Standard ML compilers: Poly/ML version
lcp@86
    16
2.03 or later (from Abstract Hardware Ltd) and Standard ML of New Jersey
lcp@86
    17
(Version 0.93 or later).  Poly/ML is a commercial product and costs money,
clasohm@0
    18
but it is reliable and its database system is convenient for interactive
lcp@196
    19
work.  SML of New Jersey requires lots of store and disc space, but it is
clasohm@0
    20
free and its code sometimes runs faster.  Both compilers are perfectly
clasohm@0
    21
satisfactory for running Isabelle.
clasohm@0
    22
lcp@370
    23
The Makefiles and make-all use environment variables that you should set
lcp@370
    24
according to your site configuration.  See file make-all-nj for an example
lcp@370
    25
using the Bourne shell, sh.
clasohm@0
    26
clasohm@0
    27
ISABELLEBIN is the directory to hold Poly/ML databases or New Jersey ML
clasohm@0
    28
images.  When using Poly/ML, ISABELLEBIN must be an absolute pathname (one
clasohm@0
    29
starting with "/").
clasohm@0
    30
lcp@196
    31
ML_DBASE is an *absolute* pathname to the initial Poly/ML database (not
clasohm@0
    32
required for New Jersey ML).
clasohm@0
    33
clasohm@0
    34
ISABELLECOMP is the ML compiler, typically "poly -noDisplay" or "sml".  If
clasohm@0
    35
ISABELLECOMP begins with the letters "poly" then the Makefiles assume that
clasohm@0
    36
it is Poly/ML; if it begins with the letters "sml" then they assume
lcp@86
    37
Standard ML of New Jersey.  
lcp@86
    38
lcp@86
    39
If a Poly/ML session fails with the message "Run out of store" then you
lcp@86
    40
have used up the entire heap.  If your tactic is not in a loop, allocating
lcp@86
    41
more heap at startup should correct the problem.  For instance, "poly -h
lcp@86
    42
15000" allocates sufficient heap space to rebuild all Isabelle examples.
clasohm@0
    43
clasohm@0
    44
clasohm@0
    45
			 STRUCTURE OF THIS DIRECTORY
clasohm@0
    46
clasohm@0
    47
The directory Pure containes pure Isabelle, which has no object-logic.
clasohm@0
    48
clasohm@0
    49
Other important files include...
lcp@86
    50
  COPYRIGHT   		Copyright notice and Disclaimer of Warranty
lcp@86
    51
  make-all		shell script for building entire system
lcp@370
    52
  make-all-poly		sample make-all invocation for Poly/ML
lcp@370
    53
  make-all-nj		sample make-all invocation for SML of NJ
lcp@93
    54
  change_simp		shell script to help convert sources to new simplifier
lcp@86
    55
  expandshort		shell script to expand "shortcuts" in files
lcp@86
    56
  prove_goal.el       	Emacs command to change proof format
lcp@86
    57
  xlisten		shell script for running Isabelle under X
lcp@86
    58
  teeinput		shell script to run Isabelle, logging inputs to a file
lcp@86
    59
  Pure			directory of source files for Pure Isabelle
lcp@86
    60
  Provers		directory of generic theorem provers
clasohm@0
    61
clasohm@0
    62
xlisten sets up a window running Isabelle, with a separate small "listener"
clasohm@0
    63
window, which keeps a log of all input lines.  This log is a useful record
clasohm@0
    64
of a session.  If you are not running X windows, teeinput can still be used at
clasohm@0
    65
least to record (if not to display) the log.
clasohm@0
    66
clasohm@0
    67
The following subdirectories contain object-logics:
lcp@86
    68
  FOL 	  Natural deduction First-Order Logic (intuitionistic and classical)
lcp@86
    69
  FOLP 	  First-Order Logic with Proof terms
lcp@86
    70
  ZF	  Zermelo-Fraenkel set theory
lcp@370
    71
  HOL	  Classical Higher-Order Logic
lcp@370
    72
  LCF     Logic for Computable Functions (domain theory) built upon FOL
lcp@370
    73
  HOLCF   A version of LCF built upon HOL
lcp@86
    74
  CTT	  Constructive Type Theory
lcp@86
    75
  LK	  Classical first-order sequent calculus
lcp@86
    76
  Modal	  The modal logics T, S4, S43
lcp@86
    77
  CCL	  Martin Coen's Classical Computational Logic
lcp@86
    78
  Cube	  Barendregt's Lambda Cube
clasohm@0
    79
clasohm@0
    80
Object-logics include examples files in subdirectory ex or file ex.ML.
clasohm@0
    81
These files can be loaded in batch mode.  The commands can also be
clasohm@0
    82
executed interactively, using the windows on your workstation.  This is a
clasohm@0
    83
good way to get started.
clasohm@0
    84
clasohm@0
    85
Each object-logic is built on top of Pure Isabelle, and possibly on top of
lcp@196
    86
another object logic like FOL or LK.  A database or binary called Pure is
clasohm@0
    87
first created, then the object-logic is loaded on top.  Poly/ML extends
clasohm@0
    88
Pure using its "make_database" operation.  Standard ML of New Jersey starts
clasohm@0
    89
with the Pure core image and loads the object-logic's ROOT.ML.
clasohm@0
    90
clasohm@0
    91
		HOW TO GET A STANDARD ML COMPILER
clasohm@0
    92
clasohm@0
    93
To obtain Poly/ML, contact Mike Crawley <mjc@ahl.co.uk> at Abstract
clasohm@0
    94
Hardware Ltd, The Howell Building, Brunel University, Uxbridge UB8 3PH,
clasohm@0
    95
England.
clasohm@0
    96
clasohm@0
    97
To obtain Standard ML of New Jersey, contact David MacQueen
clasohm@0
    98
<dbm@com.att.research> at AT&T Bell Laboratories, 600 Mountain Avenue,
clasohm@0
    99
Murray Hill, NJ 07974, USA.  This compiler is available by FTP.  Connect to
clasohm@0
   100
research.att.com; login as anonymous with your userid as password; set
clasohm@0
   101
binary mode; transfer files from the directory dist/ml.
clasohm@0
   102
clasohm@0
   103
------------------------------------------------------------------------------
clasohm@0
   104
lcp@196
   105
The electronic mailing list isabelle-users@cl.cam.ac.uk provides a forum
lcp@196
   106
for Isabelle users to discuss problems and exchange information.  To join,
lcp@196
   107
send a message to isabelle-users-request@cl.cam.ac.uk.
lcp@196
   108
lcp@196
   109
------------------------------------------------------------------------------
lcp@196
   110
lcp@93
   111
Please report any problems you encounter.  While we shall try to be helpful,
lcp@93
   112
we can accept no responsibility for the deficiences of Isabelle and their
clasohm@0
   113
consequences.
clasohm@0
   114
clasohm@0
   115
Lawrence C Paulson		E-mail: lcp@cl.cam.ac.uk
clasohm@0
   116
Computer Laboratory 		Phone: +44-223-334600
clasohm@0
   117
University of Cambridge 	Fax:   +44-223-334748 
clasohm@0
   118
Pembroke Street 
clasohm@0
   119
Cambridge CB2 3QG 
clasohm@0
   120
England
clasohm@0
   121
clasohm@0
   122
Tobias Nipkow			E-mail: nipkow@informatik.tu-muenchen.de
clasohm@0
   123
Institut fuer Informatik	Phone: +49-89-2105-2690
clasohm@0
   124
T. U. Muenchen			Fax:   +49-89-2105-8183
nipkow@94
   125
D-80290 Muenchen
clasohm@0
   126
Germany
clasohm@0
   127
lcp@370
   128
Last updated 13 May 1994