doc-src/System/Thy/Basics.thy
author wenzelm
Tue Aug 04 15:59:57 2009 +0200 (2009-08-04)
changeset 32323 8185d3bfcbf1
parent 32088 2110fcd86efb
child 32324 a99e58e043ee
permissions -rw-r--r--
tuned "Bootstrapping the environment";
added "Additional components";
wenzelm@28215
     1
theory Basics
wenzelm@28215
     2
imports Pure
wenzelm@28215
     3
begin
wenzelm@28215
     4
wenzelm@28215
     5
chapter {* The Isabelle system environment *}
wenzelm@28215
     6
wenzelm@28215
     7
text {*
wenzelm@28215
     8
  This manual describes Isabelle together with related tools and user
wenzelm@28916
     9
  interfaces as seen from a system oriented view.  See also the
wenzelm@28916
    10
  \emph{Isabelle/Isar Reference Manual}~\cite{isabelle-isar-ref} for
wenzelm@28916
    11
  the actual Isabelle input language and related concepts.
wenzelm@28215
    12
wenzelm@28916
    13
  \medskip The Isabelle system environment provides the following
wenzelm@28916
    14
  basic infrastructure to integrate tools smoothly.
wenzelm@28215
    15
wenzelm@28238
    16
  \begin{enumerate}
wenzelm@28215
    17
wenzelm@28916
    18
  \item The \emph{Isabelle settings} mechanism provides process
wenzelm@28916
    19
  environment variables to all Isabelle executables (including tools
wenzelm@28916
    20
  and user interfaces).
wenzelm@28215
    21
wenzelm@28504
    22
  \item The \emph{raw Isabelle process} (@{executable_ref
wenzelm@28504
    23
  "isabelle-process"}) runs logic sessions either interactively or in
wenzelm@28504
    24
  batch mode.  In particular, this view abstracts over the invocation
wenzelm@28504
    25
  of the actual ML system to be used.  Regular users rarely need to
wenzelm@28504
    26
  care about the low-level process.
wenzelm@28215
    27
wenzelm@28504
    28
  \item The \emph{Isabelle tools wrapper} (@{executable_ref isabelle})
wenzelm@28238
    29
  provides a generic startup environment Isabelle related utilities,
wenzelm@28238
    30
  user interfaces etc.  Such tools automatically benefit from the
wenzelm@28238
    31
  settings mechanism.
wenzelm@28215
    32
wenzelm@28238
    33
  \end{enumerate}
wenzelm@28215
    34
*}
wenzelm@28215
    35
wenzelm@28215
    36
wenzelm@28215
    37
section {* Isabelle settings \label{sec:settings} *}
wenzelm@28215
    38
wenzelm@28215
    39
text {*
wenzelm@28215
    40
  The Isabelle system heavily depends on the \emph{settings
wenzelm@28215
    41
  mechanism}\indexbold{settings}.  Essentially, this is a statically
wenzelm@28215
    42
  scoped collection of environment variables, such as @{setting
wenzelm@28215
    43
  ISABELLE_HOME}, @{setting ML_SYSTEM}, @{setting ML_HOME}.  These
wenzelm@28215
    44
  variables are \emph{not} intended to be set directly from the shell,
wenzelm@28215
    45
  though.  Isabelle employs a somewhat more sophisticated scheme of
wenzelm@28215
    46
  \emph{settings files} --- one for site-wide defaults, another for
wenzelm@28215
    47
  additional user-specific modifications.  With all configuration
wenzelm@28215
    48
  variables in at most two places, this scheme is more maintainable
wenzelm@28215
    49
  and user-friendly than global shell environment variables.
wenzelm@28215
    50
wenzelm@28215
    51
  In particular, we avoid the typical situation where prospective
wenzelm@28215
    52
  users of a software package are told to put several things into
wenzelm@28215
    53
  their shell startup scripts, before being able to actually run the
wenzelm@28215
    54
  program. Isabelle requires none such administrative chores of its
wenzelm@28215
    55
  end-users --- the executables can be invoked straight away.
wenzelm@28238
    56
  Occasionally, users would still want to put the @{"file"
wenzelm@28238
    57
  "$ISABELLE_HOME/bin"} directory into their shell's search path, but
wenzelm@28238
    58
  this is not required.
wenzelm@28215
    59
*}
wenzelm@28215
    60
wenzelm@28215
    61
wenzelm@32323
    62
subsection {* Bootstrapping the environment \label{sec:boot} *}
wenzelm@28215
    63
wenzelm@32323
    64
text {* Isabelle executables need to be run within a proper settings
wenzelm@32323
    65
  environment.  This is bootstrapped as described below, on the first
wenzelm@32323
    66
  invocation of one of the outer wrapper scripts (such as
wenzelm@32323
    67
  @{executable_ref isabelle}).  This happens only once for each
wenzelm@32323
    68
  process tree, i.e.\ the environment is passed to subprocesses
wenzelm@32323
    69
  according to regular Unix conventions.
wenzelm@28215
    70
wenzelm@28215
    71
  \begin{enumerate}
wenzelm@28215
    72
wenzelm@28215
    73
  \item The special variable @{setting_def ISABELLE_HOME} is
wenzelm@28215
    74
  determined automatically from the location of the binary that has
wenzelm@28215
    75
  been run.
wenzelm@28215
    76
  
wenzelm@28215
    77
  You should not try to set @{setting ISABELLE_HOME} manually. Also
wenzelm@28215
    78
  note that the Isabelle executables either have to be run from their
wenzelm@28215
    79
  original location in the distribution directory, or via the
wenzelm@28238
    80
  executable objects created by the @{tool install} utility.  Symbolic
wenzelm@28238
    81
  links are admissible, but a plain copy of the @{"file"
wenzelm@28238
    82
  "$ISABELLE_HOME/bin"} files will not work!
wenzelm@28238
    83
wenzelm@28238
    84
  \item The file @{"file" "$ISABELLE_HOME/etc/settings"} ist run as a
wenzelm@28238
    85
  @{executable_ref bash} shell script with the auto-export option for
wenzelm@28238
    86
  variables enabled.
wenzelm@28215
    87
  
wenzelm@28215
    88
  This file holds a rather long list of shell variable assigments,
wenzelm@28215
    89
  thus providing the site-wide default settings.  The Isabelle
wenzelm@28215
    90
  distribution already contains a global settings file with sensible
wenzelm@28215
    91
  defaults for most variables.  When installing the system, only a few
wenzelm@28215
    92
  of these may have to be adapted (probably @{setting ML_SYSTEM}
wenzelm@28215
    93
  etc.).
wenzelm@28215
    94
  
wenzelm@28285
    95
  \item The file @{verbatim "$ISABELLE_HOME_USER/etc/settings"} (if it
wenzelm@28215
    96
  exists) is run in the same way as the site default settings. Note
wenzelm@28215
    97
  that the variable @{setting ISABELLE_HOME_USER} has already been set
wenzelm@28914
    98
  before --- usually to @{verbatim "~/.isabelle"}.
wenzelm@28215
    99
  
wenzelm@28215
   100
  Thus individual users may override the site-wide defaults.  See also
wenzelm@28238
   101
  file @{"file" "$ISABELLE_HOME/etc/user-settings.sample"} in the
wenzelm@28238
   102
  distribution.  Typically, a user settings file would contain only a
wenzelm@28238
   103
  few lines, just the assigments that are really changed.  One should
wenzelm@28238
   104
  definitely \emph{not} start with a full copy the basic @{"file"
wenzelm@28215
   105
  "$ISABELLE_HOME/etc/settings"}. This could cause very annoying
wenzelm@28215
   106
  maintainance problems later, when the Isabelle installation is
wenzelm@28215
   107
  updated or changed otherwise.
wenzelm@28215
   108
  
wenzelm@28215
   109
  \end{enumerate}
wenzelm@28215
   110
wenzelm@28238
   111
  Since settings files are regular GNU @{executable_def bash} scripts,
wenzelm@28238
   112
  one may use complex shell commands, such as @{verbatim "if"} or
wenzelm@28215
   113
  @{verbatim "case"} statements to set variables depending on the
wenzelm@28215
   114
  system architecture or other environment variables.  Such advanced
wenzelm@28215
   115
  features should be added only with great care, though. In
wenzelm@28215
   116
  particular, external environment references should be kept at a
wenzelm@28215
   117
  minimum.
wenzelm@28215
   118
wenzelm@28215
   119
  \medskip A few variables are somewhat special:
wenzelm@28215
   120
wenzelm@28215
   121
  \begin{itemize}
wenzelm@28215
   122
wenzelm@28502
   123
  \item @{setting_def ISABELLE_PROCESS} and @{setting_def ISABELLE_TOOL} are set
wenzelm@28215
   124
  automatically to the absolute path names of the @{executable
wenzelm@28504
   125
  "isabelle-process"} and @{executable isabelle} executables,
wenzelm@28215
   126
  respectively.
wenzelm@28215
   127
  
wenzelm@28238
   128
  \item @{setting_ref ISABELLE_OUTPUT} will have the identifiers of
wenzelm@28215
   129
  the Isabelle distribution (cf.\ @{setting ISABELLE_IDENTIFIER}) and
wenzelm@28215
   130
  the ML system (cf.\ @{setting ML_IDENTIFIER}) appended automatically
wenzelm@28215
   131
  to its value.
wenzelm@28215
   132
wenzelm@28215
   133
  \end{itemize}
wenzelm@28215
   134
wenzelm@28238
   135
  \medskip Note that the settings environment may be inspected with
wenzelm@28238
   136
  the Isabelle tool @{tool getenv}.  This might help to figure out the
wenzelm@28238
   137
  effect of complex settings scripts.
wenzelm@28215
   138
*}
wenzelm@28215
   139
wenzelm@28215
   140
wenzelm@28215
   141
subsection{* Common variables *}
wenzelm@28215
   142
wenzelm@28215
   143
text {*
wenzelm@28215
   144
  This is a reference of common Isabelle settings variables. Note that
wenzelm@28215
   145
  the list is somewhat open-ended. Third-party utilities or interfaces
wenzelm@28215
   146
  may add their own selection. Variables that are special in some
wenzelm@28215
   147
  sense are marked with @{text "\<^sup>*"}.
wenzelm@28215
   148
wenzelm@28215
   149
  \begin{description}
wenzelm@28215
   150
wenzelm@28215
   151
  \item[@{setting_def ISABELLE_HOME}@{text "\<^sup>*"}] is the
wenzelm@28215
   152
  location of the top-level Isabelle distribution directory. This is
wenzelm@28215
   153
  automatically determined from the Isabelle executable that has been
wenzelm@28215
   154
  invoked.  Do not attempt to set @{setting ISABELLE_HOME} yourself
wenzelm@28238
   155
  from the shell!
wenzelm@28215
   156
  
wenzelm@28215
   157
  \item[@{setting_def ISABELLE_HOME_USER}] is the user-specific
wenzelm@28215
   158
  counterpart of @{setting ISABELLE_HOME}. The default value is
wenzelm@28914
   159
  @{verbatim "~/.isabelle"}, under rare circumstances this may be
wenzelm@28215
   160
  changed in the global setting file.  Typically, the @{setting
wenzelm@28215
   161
  ISABELLE_HOME_USER} directory mimics @{setting ISABELLE_HOME} to
wenzelm@28215
   162
  some extend. In particular, site-wide defaults may be overridden by
wenzelm@28285
   163
  a private @{verbatim "$ISABELLE_HOME_USER/etc/settings"}.
wenzelm@28215
   164
  
wenzelm@28502
   165
  \item[@{setting_def ISABELLE_PROCESS}@{text "\<^sup>*"}, @{setting
wenzelm@28500
   166
  ISABELLE_TOOL}@{text "\<^sup>*"}] are automatically set to the full path
wenzelm@28215
   167
  names of the @{executable "isabelle-process"} and @{executable
wenzelm@28504
   168
  isabelle} executables, respectively.  Thus other tools and scripts
wenzelm@28238
   169
  need not assume that the @{"file" "$ISABELLE_HOME/bin"} directory is
wenzelm@28238
   170
  on the current search path of the shell.
wenzelm@28215
   171
  
wenzelm@28215
   172
  \item[@{setting_def ISABELLE_IDENTIFIER}@{text "\<^sup>*"}] refers
wenzelm@28215
   173
  to the name of this Isabelle distribution, e.g.\ ``@{verbatim
wenzelm@28215
   174
  Isabelle2008}''.
wenzelm@28215
   175
wenzelm@28215
   176
  \item[@{setting_def ML_SYSTEM}, @{setting_def ML_HOME},
wenzelm@28215
   177
  @{setting_def ML_OPTIONS}, @{setting_def ML_PLATFORM}, @{setting_def
wenzelm@28215
   178
  ML_IDENTIFIER}@{text "\<^sup>*"}] specify the underlying ML system
wenzelm@28215
   179
  to be used for Isabelle.  There is only a fixed set of admissable
wenzelm@28238
   180
  @{setting ML_SYSTEM} names (see the @{"file"
wenzelm@28238
   181
  "$ISABELLE_HOME/etc/settings"} file of the distribution).
wenzelm@28215
   182
  
wenzelm@28215
   183
  The actual compiler binary will be run from the directory @{setting
wenzelm@28215
   184
  ML_HOME}, with @{setting ML_OPTIONS} as first arguments on the
wenzelm@28215
   185
  command line.  The optional @{setting ML_PLATFORM} may specify the
wenzelm@28215
   186
  binary format of ML heap images, which is useful for cross-platform
wenzelm@28215
   187
  installations.  The value of @{setting ML_IDENTIFIER} is
wenzelm@28215
   188
  automatically obtained by composing the values of @{setting
wenzelm@28215
   189
  ML_SYSTEM}, @{setting ML_PLATFORM} and the Isabelle version values.
wenzelm@28215
   190
  
wenzelm@28215
   191
  \item[@{setting_def ISABELLE_PATH}] is a list of directories
wenzelm@28215
   192
  (separated by colons) where Isabelle logic images may reside.  When
wenzelm@28215
   193
  looking up heaps files, the value of @{setting ML_IDENTIFIER} is
wenzelm@28215
   194
  appended to each component internally.
wenzelm@28215
   195
  
wenzelm@28215
   196
  \item[@{setting_def ISABELLE_OUTPUT}@{text "\<^sup>*"}] is a
wenzelm@28215
   197
  directory where output heap files should be stored by default. The
wenzelm@28215
   198
  ML system and Isabelle version identifier is appended here, too.
wenzelm@28215
   199
  
wenzelm@28215
   200
  \item[@{setting_def ISABELLE_BROWSER_INFO}] is the directory where
wenzelm@28215
   201
  theory browser information (HTML text, graph data, and printable
wenzelm@28215
   202
  documents) is stored (see also \secref{sec:info}).  The default
wenzelm@28215
   203
  value is @{verbatim "$ISABELLE_HOME_USER/browser_info"}.
wenzelm@28215
   204
  
wenzelm@28215
   205
  \item[@{setting_def ISABELLE_LOGIC}] specifies the default logic to
wenzelm@28215
   206
  load if none is given explicitely by the user.  The default value is
wenzelm@28215
   207
  @{verbatim HOL}.
wenzelm@28215
   208
  
wenzelm@28215
   209
  \item[@{setting_def ISABELLE_LINE_EDITOR}] specifies the default
wenzelm@28238
   210
  line editor for the @{tool_ref tty} interface.
wenzelm@28215
   211
wenzelm@28215
   212
  \item[@{setting_def ISABELLE_USEDIR_OPTIONS}] is implicitly prefixed
wenzelm@28238
   213
  to the command line of any @{tool_ref usedir} invocation. This
wenzelm@28238
   214
  typically contains compilation options for object-logics --- @{tool
wenzelm@28238
   215
  usedir} is the basic utility for managing logic sessions (cf.\ the
wenzelm@28238
   216
  @{verbatim IsaMakefile}s in the distribution).
wenzelm@28215
   217
wenzelm@28215
   218
  \item[@{setting_def ISABELLE_FILE_IDENT}] specifies a shell command
wenzelm@28215
   219
  for producing a source file identification, based on the actual
wenzelm@28215
   220
  content instead of the full physical path and date stamp (which is
wenzelm@28215
   221
  the default). A typical identification would produce a ``digest'' of
wenzelm@28215
   222
  the text, using a cryptographic hash function like SHA-1, for
wenzelm@28215
   223
  example.
wenzelm@28215
   224
  
wenzelm@28215
   225
  \item[@{setting_def ISABELLE_LATEX}, @{setting_def
wenzelm@28215
   226
  ISABELLE_PDFLATEX}, @{setting_def ISABELLE_BIBTEX}, @{setting_def
wenzelm@28215
   227
  ISABELLE_DVIPS}] refer to {\LaTeX} related tools for Isabelle
wenzelm@28215
   228
  document preparation (see also \secref{sec:tool-latex}).
wenzelm@28215
   229
  
wenzelm@28215
   230
  \item[@{setting_def ISABELLE_TOOLS}] is a colon separated list of
wenzelm@28504
   231
  directories that are scanned by @{executable isabelle} for external
wenzelm@28504
   232
  utility programs (see also \secref{sec:isabelle-tool}).
wenzelm@28215
   233
  
wenzelm@28215
   234
  \item[@{setting_def ISABELLE_DOCS}] is a colon separated list of
wenzelm@28215
   235
  directories with documentation files.
wenzelm@28215
   236
  
wenzelm@28215
   237
  \item[@{setting_def ISABELLE_DOC_FORMAT}] specifies the preferred
wenzelm@28215
   238
  document format, typically @{verbatim dvi} or @{verbatim pdf}.
wenzelm@28215
   239
  
wenzelm@28215
   240
  \item[@{setting_def DVI_VIEWER}] specifies the command to be used
wenzelm@28215
   241
  for displaying @{verbatim dvi} files.
wenzelm@28215
   242
  
wenzelm@28215
   243
  \item[@{setting_def PDF_VIEWER}] specifies the command to be used
wenzelm@28215
   244
  for displaying @{verbatim pdf} files.
wenzelm@28215
   245
  
wenzelm@28215
   246
  \item[@{setting_def PRINT_COMMAND}] specifies the standard printer
wenzelm@28215
   247
  spool command, which is expected to accept @{verbatim ps} files.
wenzelm@28215
   248
  
wenzelm@28215
   249
  \item[@{setting_def ISABELLE_TMP_PREFIX}@{text "\<^sup>*"}] is the
wenzelm@28238
   250
  prefix from which any running @{executable "isabelle-process"}
wenzelm@28238
   251
  derives an individual directory for temporary files.  The default is
wenzelm@28215
   252
  somewhere in @{verbatim "/tmp"}.
wenzelm@28215
   253
  
wenzelm@28215
   254
  \end{description}
wenzelm@28215
   255
*}
wenzelm@28215
   256
wenzelm@28215
   257
wenzelm@32323
   258
subsection {* Additional components \label{sec:components} *}
wenzelm@32323
   259
wenzelm@32323
   260
text {* Any directory may be registered as an explicit \emph{Isabelle
wenzelm@32323
   261
  component}.  The general layout conventions are that of the main
wenzelm@32323
   262
  Isabelle distribution itself, and the following two files (both
wenzelm@32323
   263
  optional) have a special meaning:
wenzelm@32323
   264
wenzelm@32323
   265
  \begin{itemize}
wenzelm@32323
   266
wenzelm@32323
   267
  \item @{verbatim "etc/settings"} holds additional settings that are
wenzelm@32323
   268
  initialized when bootstrapping the overall Isabelle environment,
wenzelm@32323
   269
  cf.\ \secref{sec:boot}.  As usual, the content is interpreted as a
wenzelm@32323
   270
  @{verbatim bash} script.  It may refer to the component's enclosing
wenzelm@32323
   271
  directory via the @{verbatim "COMPONENT"} shell variable.
wenzelm@32323
   272
wenzelm@32323
   273
  For example, the following setting allows to refer to files within
wenzelm@32323
   274
  the component later on, without having to hardwire absolute paths:
wenzelm@32323
   275
wenzelm@32323
   276
  \begin{ttbox}
wenzelm@32323
   277
  MY_COMPONENT_HOME="$COMPONENT"
wenzelm@32323
   278
  \end{ttbox}
wenzelm@32323
   279
wenzelm@32323
   280
  Components can also add to existing Isabelle settings such as
wenzelm@32323
   281
  @{setting_def ISABELLE_TOOLS}, in order to provide
wenzelm@32323
   282
  component-specific tools that can be invoked by end-users.  For
wenzelm@32323
   283
  example:
wenzelm@32323
   284
wenzelm@32323
   285
  \begin{ttbox}
wenzelm@32323
   286
  ISABELLE_TOOLS="$ISABELLE_TOOLS:$COMPONENT/lib/Tools"
wenzelm@32323
   287
  \end{ttbox}
wenzelm@32323
   288
wenzelm@32323
   289
  \item @{verbatim "etc/components"} holds a list of further
wenzelm@32323
   290
  sub-components of the same structure.  The directory specifications
wenzelm@32323
   291
  given here can be either absolute (with leading @{verbatim "/"}) or
wenzelm@32323
   292
  relative to the component's main directory.
wenzelm@32323
   293
wenzelm@32323
   294
  \end{itemize}
wenzelm@32323
   295
wenzelm@32323
   296
  The root of component initialization is @{setting ISABELLE_HOME}
wenzelm@32323
   297
  itself.  After initializing all of its sub-components recursively,
wenzelm@32323
   298
  @{setting ISABELLE_HOME_USER} is included in the same manner (if
wenzelm@32323
   299
  that directory exists).  Thus users can easily add private
wenzelm@32323
   300
  components to @{verbatim "$ISABELLE_HOME_USER/etc/components"}.
wenzelm@32323
   301
*}
wenzelm@32323
   302
wenzelm@32323
   303
wenzelm@28215
   304
section {* The raw Isabelle process *}
wenzelm@28215
   305
wenzelm@28215
   306
text {*
wenzelm@28504
   307
  The @{executable_def "isabelle-process"} executable runs bare-bones
wenzelm@28504
   308
  Isabelle logic sessions --- either interactively or in batch mode.
wenzelm@28504
   309
  It provides an abstraction over the underlying ML system, and over
wenzelm@28504
   310
  the actual heap file locations.  Its usage is:
wenzelm@28215
   311
wenzelm@28215
   312
\begin{ttbox}
wenzelm@28238
   313
Usage: isabelle-process [OPTIONS] [INPUT] [OUTPUT]
wenzelm@28215
   314
wenzelm@28215
   315
  Options are:
wenzelm@28215
   316
    -I           startup Isar interaction mode
wenzelm@28215
   317
    -P           startup Proof General interaction mode
wenzelm@28215
   318
    -S           secure mode -- disallow critical operations
wenzelm@28215
   319
    -W OUTPUT    startup process wrapper, with messages going to OUTPUT stream
wenzelm@28215
   320
    -X           startup PGIP interaction mode
wenzelm@28215
   321
    -e MLTEXT    pass MLTEXT to the ML session
wenzelm@28215
   322
    -f           pass 'Session.finish();' to the ML session
wenzelm@28215
   323
    -m MODE      add print mode for output
wenzelm@28215
   324
    -q           non-interactive session
wenzelm@28215
   325
    -r           open heap file read-only
wenzelm@28215
   326
    -u           pass 'use"ROOT.ML";' to the ML session
wenzelm@28215
   327
    -w           reset write permissions on OUTPUT
wenzelm@28215
   328
wenzelm@28215
   329
  INPUT (default "\$ISABELLE_LOGIC") and OUTPUT specify in/out heaps.
wenzelm@28215
   330
  These are either names to be searched in the Isabelle path, or
wenzelm@28215
   331
  actual file names (containing at least one /).
wenzelm@28215
   332
  If INPUT is "RAW_ML_SYSTEM", just start the bare bones ML system.
wenzelm@28215
   333
\end{ttbox}
wenzelm@28215
   334
wenzelm@28215
   335
  Input files without path specifications are looked up in the
wenzelm@28215
   336
  @{setting ISABELLE_PATH} setting, which may consist of multiple
wenzelm@28215
   337
  components separated by colons --- these are tried in the given
wenzelm@28215
   338
  order with the value of @{setting ML_IDENTIFIER} appended
wenzelm@28215
   339
  internally.  In a similar way, base names are relative to the
wenzelm@28215
   340
  directory specified by @{setting ISABELLE_OUTPUT}.  In any case,
wenzelm@28215
   341
  actual file locations may also be given by including at least one
wenzelm@28215
   342
  slash (@{verbatim "/"}) in the name (hint: use @{verbatim "./"} to
wenzelm@28215
   343
  refer to the current directory).
wenzelm@28215
   344
*}
wenzelm@28215
   345
wenzelm@28215
   346
wenzelm@28223
   347
subsubsection {* Options *}
wenzelm@28215
   348
wenzelm@28215
   349
text {*
wenzelm@28215
   350
  If the input heap file does not have write permission bits set, or
wenzelm@28215
   351
  the @{verbatim "-r"} option is given explicitely, then the session
wenzelm@28215
   352
  started will be read-only.  That is, the ML world cannot be
wenzelm@28215
   353
  committed back into the image file.  Otherwise, a writable session
wenzelm@28215
   354
  enables commits into either the input file, or into another output
wenzelm@28215
   355
  heap file (if that is given as the second argument on the command
wenzelm@28215
   356
  line).
wenzelm@28215
   357
wenzelm@28215
   358
  The read-write state of sessions is determined at startup only, it
wenzelm@28215
   359
  cannot be changed intermediately. Also note that heap images may
wenzelm@28215
   360
  require considerable amounts of disk space (approximately
wenzelm@28215
   361
  50--200~MB). Users are responsible for themselves to dispose their
wenzelm@28215
   362
  heap files when they are no longer needed.
wenzelm@28215
   363
wenzelm@28215
   364
  \medskip The @{verbatim "-w"} option makes the output heap file
wenzelm@28215
   365
  read-only after terminating.  Thus subsequent invocations cause the
wenzelm@28215
   366
  logic image to be read-only automatically.
wenzelm@28215
   367
wenzelm@28215
   368
  \medskip Using the @{verbatim "-e"} option, arbitrary ML code may be
wenzelm@28215
   369
  passed to the Isabelle session from the command line. Multiple
wenzelm@28215
   370
  @{verbatim "-e"}'s are evaluated in the given order. Strange things
wenzelm@28215
   371
  may happen when errorneous ML code is provided. Also make sure that
wenzelm@28215
   372
  the ML commands are terminated properly by semicolon.
wenzelm@28215
   373
wenzelm@28215
   374
  \medskip The @{verbatim "-u"} option is a shortcut for @{verbatim
wenzelm@28215
   375
  "-e"} passing ``@{verbatim "use \"ROOT.ML\";"}'' to the ML session.
wenzelm@28223
   376
  The @{verbatim "-f"} option passes ``@{verbatim
wenzelm@28223
   377
  "Session.finish();"}'', which is intended mainly for administrative
wenzelm@28223
   378
  purposes.
wenzelm@28215
   379
wenzelm@28215
   380
  \medskip The @{verbatim "-m"} option adds identifiers of print modes
wenzelm@28215
   381
  to be made active for this session. Typically, this is used by some
wenzelm@28215
   382
  user interface, e.g.\ to enable output of proper mathematical
wenzelm@28215
   383
  symbols.
wenzelm@28215
   384
wenzelm@28215
   385
  \medskip Isabelle normally enters an interactive top-level loop
wenzelm@28215
   386
  (after processing the @{verbatim "-e"} texts). The @{verbatim "-q"}
wenzelm@28215
   387
  option inhibits interaction, thus providing a pure batch mode
wenzelm@28215
   388
  facility.
wenzelm@28215
   389
wenzelm@28215
   390
  \medskip The @{verbatim "-I"} option makes Isabelle enter Isar
wenzelm@28215
   391
  interaction mode on startup, instead of the primitive ML top-level.
wenzelm@28215
   392
  The @{verbatim "-P"} option configures the top-level loop for
wenzelm@28215
   393
  interaction with the Proof General user interface, and the
wenzelm@28215
   394
  @{verbatim "-X"} option enables XML-based PGIP communication.  The
wenzelm@28215
   395
  @{verbatim "-W"} option makes Isabelle enter a special process
wenzelm@28215
   396
  wrapper for interaction via an external program; the protocol is a
wenzelm@28238
   397
  stripped-down version of Proof General the interaction mode, see
wenzelm@30195
   398
  also @{"file" "~~/src/Pure/System/isabelle_process.ML"} and @{"file"
wenzelm@30195
   399
  "~~/src/Pure/System/isabelle_process.scala"}.
wenzelm@28215
   400
wenzelm@28215
   401
  \medskip The @{verbatim "-S"} option makes the Isabelle process more
wenzelm@28215
   402
  secure by disabling some critical operations, notably runtime
wenzelm@28215
   403
  compilation and evaluation of ML source code.
wenzelm@28215
   404
*}
wenzelm@28215
   405
wenzelm@28215
   406
wenzelm@28223
   407
subsubsection {* Examples *}
wenzelm@28215
   408
wenzelm@28215
   409
text {*
wenzelm@28215
   410
  Run an interactive session of the default object-logic (as specified
wenzelm@28215
   411
  by the @{setting ISABELLE_LOGIC} setting) like this:
wenzelm@28215
   412
\begin{ttbox}
wenzelm@28238
   413
isabelle-process
wenzelm@28215
   414
\end{ttbox}
wenzelm@28215
   415
wenzelm@28215
   416
  Usually @{setting ISABELLE_LOGIC} refers to one of the standard
wenzelm@28215
   417
  logic images, which are read-only by default.  A writable session
wenzelm@28215
   418
  --- based on @{verbatim FOL}, but output to @{verbatim Foo} (in the
wenzelm@28238
   419
  directory specified by the @{setting ISABELLE_OUTPUT} setting) ---
wenzelm@28215
   420
  may be invoked as follows:
wenzelm@28215
   421
\begin{ttbox}
wenzelm@28238
   422
isabelle-process FOL Foo
wenzelm@28215
   423
\end{ttbox}
wenzelm@28215
   424
  Ending this session normally (e.g.\ by typing control-D) dumps the
wenzelm@28215
   425
  whole ML system state into @{verbatim Foo}. Be prepared for several
wenzelm@28215
   426
  tens of megabytes.
wenzelm@28215
   427
wenzelm@28215
   428
  The @{verbatim Foo} session may be continued later (still in
wenzelm@28215
   429
  writable state) by:
wenzelm@28215
   430
\begin{ttbox}
wenzelm@28238
   431
isabelle-process Foo
wenzelm@28215
   432
\end{ttbox}
wenzelm@28215
   433
  A read-only @{verbatim Foo} session may be started by:
wenzelm@28215
   434
\begin{ttbox}
wenzelm@28238
   435
isabelle-process -r Foo
wenzelm@28215
   436
\end{ttbox}
wenzelm@28215
   437
wenzelm@28215
   438
  \medskip Note that manual session management like this does
wenzelm@28215
   439
  \emph{not} provide proper setup for theory presentation.  This would
wenzelm@28238
   440
  require the @{tool usedir} utility.
wenzelm@28215
   441
wenzelm@28238
   442
  \bigskip The next example demonstrates batch execution of Isabelle.
wenzelm@28238
   443
  We retrieve the @{verbatim FOL} theory value from the theory loader
wenzelm@28238
   444
  within ML:
wenzelm@28215
   445
\begin{ttbox}
wenzelm@28238
   446
isabelle-process -e 'theory "FOL";' -q -r FOL
wenzelm@28215
   447
\end{ttbox}
wenzelm@28215
   448
  Note that the output text will be interspersed with additional junk
wenzelm@28238
   449
  messages by the ML runtime environment.  The @{verbatim "-W"} option
wenzelm@28238
   450
  allows to communicate with the Isabelle process via an external
wenzelm@28238
   451
  program in a more robust fashion.
wenzelm@28238
   452
*}
wenzelm@28238
   453
wenzelm@28238
   454
wenzelm@28504
   455
section {* The Isabelle tools wrapper \label{sec:isabelle-tool} *}
wenzelm@28238
   456
wenzelm@28238
   457
text {*
wenzelm@28238
   458
  All Isabelle related tools and interfaces are called via a common
wenzelm@28504
   459
  wrapper --- @{executable isabelle}:
wenzelm@28238
   460
wenzelm@28238
   461
\begin{ttbox}
wenzelm@28504
   462
Usage: isabelle TOOL [ARGS ...]
wenzelm@28238
   463
wenzelm@28506
   464
  Start Isabelle tool NAME with ARGS; pass "-?" for tool specific help.
wenzelm@28238
   465
wenzelm@28238
   466
  Available tools are:
wenzelm@28238
   467
wenzelm@28238
   468
    browser - Isabelle graph browser
wenzelm@28238
   469
    \dots
wenzelm@28238
   470
\end{ttbox}
wenzelm@28238
   471
wenzelm@28238
   472
  In principle, Isabelle tools are ordinary executable scripts that
wenzelm@28238
   473
  are run within the Isabelle settings environment, see
wenzelm@28238
   474
  \secref{sec:settings}.  The set of available tools is collected by
wenzelm@28504
   475
  @{executable isabelle} from the directories listed in the @{setting
wenzelm@28238
   476
  ISABELLE_TOOLS} setting.  Do not try to call the scripts directly
wenzelm@28238
   477
  from the shell.  Neither should you add the tool directories to your
wenzelm@28238
   478
  shell's search path!
wenzelm@28238
   479
*}
wenzelm@28238
   480
wenzelm@28238
   481
wenzelm@28238
   482
subsubsection {* Examples *}
wenzelm@28238
   483
wenzelm@28238
   484
text {*
wenzelm@28238
   485
  Show the list of available documentation of the current Isabelle
wenzelm@28238
   486
  installation like this:
wenzelm@28238
   487
wenzelm@28238
   488
\begin{ttbox}
wenzelm@28504
   489
  isabelle doc
wenzelm@28238
   490
\end{ttbox}
wenzelm@28238
   491
wenzelm@28238
   492
  View a certain document as follows:
wenzelm@28238
   493
\begin{ttbox}
wenzelm@28504
   494
  isabelle doc isar-ref
wenzelm@28238
   495
\end{ttbox}
wenzelm@28238
   496
wenzelm@28238
   497
  Create an Isabelle session derived from HOL (see also
wenzelm@28238
   498
  \secref{sec:tool-mkdir} and \secref{sec:tool-make}):
wenzelm@28238
   499
\begin{ttbox}
wenzelm@28504
   500
  isabelle mkdir HOL Test && isabelle make
wenzelm@28238
   501
\end{ttbox}
wenzelm@28504
   502
  Note that @{verbatim "isabelle mkdir"} is usually only invoked once;
wenzelm@28238
   503
  existing sessions (including document output etc.) are then updated
wenzelm@28504
   504
  by @{verbatim "isabelle make"} alone.
wenzelm@28215
   505
*}
wenzelm@28215
   506
wenzelm@28223
   507
end