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