INSTALL
author wenzelm
Mon Sep 11 20:41:44 2000 +0200 (2000-09-11)
changeset 9927 7a9652294fe0
parent 8809 85539b33be03
child 10029 b889474af53f
permissions -rw-r--r--
tuned;
wenzelm@2759
     1
wenzelm@8809
     2
Isabelle installation and compilation notes
wenzelm@6486
     3
===========================================
wenzelm@2759
     4
wenzelm@8809
     5
1) User installation
wenzelm@8809
     6
--------------------
wenzelm@8809
     7
wenzelm@8809
     8
Here we assume that Isabelle has already been installed at your site.
wenzelm@8809
     9
Otherwise see 2) below of how to get the Isabelle system installed in
wenzelm@8809
    10
the first place.
wenzelm@8809
    11
wenzelm@8809
    12
wenzelm@8809
    13
1a) Running the Isabelle binaries
wenzelm@8809
    14
---------------------------------
wenzelm@8809
    15
wenzelm@8809
    16
The Isabelle binaries (isatool, isabelle, Isabelle) may be invoked
wenzelm@8809
    17
directly from their location within the distribution directory
wenzelm@8809
    18
[ISABELLE_HOME] like this:
wenzelm@8809
    19
wenzelm@8809
    20
  [ISABELLE_HOME]/bin/isabelle HOL
wenzelm@8809
    21
wenzelm@8809
    22
This starts an interactive Isabelle session within your current text
wenzelm@8809
    23
terminal.  You may want to put [ISABELLE_HOME]/bin into your shell's
wenzelm@8809
    24
search PATH, but this is not strictly necessary.
wenzelm@8809
    25
wenzelm@8809
    26
wenzelm@8809
    27
Please do *not* copy (or link) the Isabelle scripts anywhere else ---
wenzelm@8809
    28
they just won't work!  If you really want to install independent
wenzelm@8809
    29
Isabelle binaries somewhere else then do it like this:
wenzelm@8809
    30
wenzelm@8809
    31
  [ISABELLE_HOME]/bin/isatool install -p ~/bin
wenzelm@2759
    32
wenzelm@8809
    33
Your site-wide Isabelle installation may already provide Isabelle
wenzelm@8809
    34
executables in some global bin directory (such as /usr/bin).
wenzelm@8809
    35
wenzelm@8809
    36
wenzelm@8809
    37
1b) Isabelle as KDE application
wenzelm@8809
    38
-------------------------------
wenzelm@8809
    39
wenzelm@8809
    40
Isabelle may be installed as application icon on the KDE desktop like
wenzelm@8809
    41
this:
wenzelm@8809
    42
wenzelm@8809
    43
  [ISABELLE_HOME]/bin/isatool install -k
wenzelm@2759
    44
wenzelm@8809
    45
Clicking on that icon will invoke the interface wrapper script
wenzelm@8809
    46
(capital Isabelle), which may be configured to run your favorite
wenzelm@8809
    47
Isabelle user interface via the ISABELLE_INTERFACE setting.
wenzelm@8809
    48
Additional options may be passed by editing the application's command
wenzelm@8809
    49
line (by using the standard KDE desktop functionality).
wenzelm@8809
    50
wenzelm@8809
    51
wenzelm@8809
    52
2) System installation
wenzelm@8809
    53
----------------------
wenzelm@8809
    54
wenzelm@8809
    55
The Isabelle distribution is available both as traditional source-only
wenzelm@8809
    56
tar.gz archives, and as binary packages (currently only RPM for
wenzelm@8809
    57
Linux/x86).  In any case, the resulting Isabelle installation always
wenzelm@8809
    58
contains the full sources, thus any part of the system be recompiled
wenzelm@8809
    59
later, too.
wenzelm@2759
    60
wenzelm@2759
    61
wenzelm@8809
    62
2a) Binary installation
wenzelm@8809
    63
----------------------
wenzelm@8809
    64
wenzelm@8809
    65
Ready-to-go RPM packages are provided for the ML compiler and runtime
wenzelm@8809
    66
system, the Isabelle sources, and some major object-logics.  These
wenzelm@8809
    67
packages should work on any major RPM-based Linux/x86 platform (such
wenzelm@8809
    68
as SuSE, RedHat etc.).  A typical installation procedure would be like
wenzelm@8809
    69
this (executed as root):
wenzelm@8809
    70
wenzelm@9927
    71
  rpm -i --prefix /usr/share polyml.i386.rpm
wenzelm@8809
    72
  rpm -i --prefix /usr/share isabelle.rpm
wenzelm@8809
    73
  rpm -i --prefix /usr/share isabelle-HOL.i386.rpm
wenzelm@8809
    74
wenzelm@8809
    75
The install prefix may be changed as indicated.  By default the ML
wenzelm@8809
    76
system is expected to be at the same directory level as Isabelle
wenzelm@9927
    77
itself; see [ISABELLE_HOME]/etc/settings of how to change this.
wenzelm@8809
    78
wenzelm@8809
    79
Note that isabelle.rpm and isabelle-pdfdocs.rpm already contain all of
wenzelm@8809
    80
Isabelle as platform independent sources.  Precompiled object-logics
wenzelm@8809
    81
are provided for convenience.
wenzelm@8809
    82
wenzelm@8809
    83
wenzelm@8809
    84
Recompiling logics
wenzelm@3263
    85
------------------
wenzelm@2759
    86
wenzelm@8809
    87
Some people prefer to be able to reconstruct the full system from the
wenzelm@8809
    88
sources, rather than installing RPM packages blindly.  We do not
wenzelm@8809
    89
provide source RPMs, yet any parts of Isabelle may be recompiled after
wenzelm@8809
    90
installation of the main isabelle.rpm package (which contains only
wenzelm@8809
    91
sources anyway).
wenzelm@8809
    92
wenzelm@8809
    93
Assuming proper configuration of the underlying ML system, Isabelle
wenzelm@8809
    94
object-logics may be recompiled like this:
wenzelm@8809
    95
wenzelm@8809
    96
  [ISABELLE_HOME]/build HOL FOL
wenzelm@8809
    97
wenzelm@8809
    98
wenzelm@8809
    99
Source installation
wenzelm@8809
   100
-------------------
wenzelm@8809
   101
wenzelm@8809
   102
Traditional tar.gz archives are provided for the full Isabelle sources
wenzelm@8809
   103
and documentation as well.  Make sure your ML system (SML/NJ, Poly/ML
wenzelm@8809
   104
etc.) has already been installed properly; then proceed as follows.
wenzelm@8809
   105
wenzelm@8809
   106
* Unpacking the archives.  After unpacking the Isabelle distribution
wenzelm@8809
   107
archives (using tar and gzip) you are left with some directory
wenzelm@8809
   108
IsabelleYY-X.  Basically, this may be installed anywhere --- just note
wenzelm@8809
   109
that ~/isabelle would be a really bad idea, though.  The place where
wenzelm@8809
   110
you put the contents of IsabelleYY-X will be referred to as
wenzelm@8809
   111
[ISABELLE_HOME] subsequently.
wenzelm@8809
   112
wenzelm@8809
   113
* Auto configuration.  There are some minor adaptions to be made of
wenzelm@8809
   114
the Isabelle distribution to your system environment (mostly locations
wenzelm@8809
   115
of bash and perl).  Simply do it like this:
wenzelm@2759
   116
wenzelm@2759
   117
  cd [ISABELLE_HOME]
wenzelm@2759
   118
  ./configure
wenzelm@2759
   119
wenzelm@8809
   120
Note that this does not store any references to [ISABELLE_HOME].  You
wenzelm@8809
   121
may safely move the system later, without having to run ./configure
wenzelm@8809
   122
again.
wenzelm@6258
   123
wenzelm@8809
   124
* ML system settings and compilation.  Before actual compilation you
wenzelm@8809
   125
have to tell Isabelle about your Standard ML system.  These settings
wenzelm@8809
   126
reside in ./etc/settings, which may be also overridden by
wenzelm@8809
   127
~/isabelle/etc/settings. There are already various sample
wenzelm@8809
   128
configurations in ./etc/settings commented out.
wenzelm@2759
   129
wenzelm@3117
   130
To build the core Isabelle/Pure and the default object-logic, just
wenzelm@8809
   131
type
wenzelm@2759
   132
wenzelm@2759
   133
  ./build
wenzelm@2759
   134
wenzelm@8809
   135
More object-logics can be made in a similar fashion:
wenzelm@2759
   136
wenzelm@2759
   137
  ./build FOL HOL
wenzelm@2759
   138
wenzelm@9927
   139
Explicit make targets may be given as follows:
wenzelm@9927
   140
wenzelm@9927
   141
  ./build -m HOL-Real HOL
wenzelm@9927
   142
wenzelm@8809
   143
After successful compilation you are ready to run the system, see 1)
wenzelm@8809
   144
above for more information.
wenzelm@2759
   145
wenzelm@2759
   146
wenzelm@2759
   147
$Id$