doc-src/System/Thy/document/Sessions.tex
changeset 48683 eeb4480b5877
parent 48650 47330b712f8f
child 48684 9170e10c651e
equal deleted inserted replaced
48682:162579d4ba15 48683:eeb4480b5877
   400 isabelle build -a -n -c
   400 isabelle build -a -n -c
   401 \end{ttbox}%
   401 \end{ttbox}%
   402 \end{isamarkuptext}%
   402 \end{isamarkuptext}%
   403 \isamarkuptrue%
   403 \isamarkuptrue%
   404 %
   404 %
       
   405 \isamarkupsection{Preparing session root directories \label{sec:tool-mkroot}%
       
   406 }
       
   407 \isamarkuptrue%
       
   408 %
       
   409 \begin{isamarkuptext}%
       
   410 The \indexdef{}{tool}{mkroot}\hypertarget{tool.mkroot}{\hyperlink{tool.mkroot}{\mbox{\isa{\isatool{mkroot}}}}} tool prepares Isabelle session source
       
   411   directories, including some \verb|ROOT| entry, an example
       
   412   theory file, and some initial configuration for document preparation
       
   413   (see also \chref{ch:present}).  The usage of \hyperlink{tool.mkroot}{\mbox{\isa{\isatool{mkroot}}}} is:
       
   414 
       
   415 \begin{ttbox}
       
   416 Usage: isabelle mkroot NAME
       
   417 
       
   418   Prepare session root directory, adding session NAME with
       
   419   built-in document preparation.
       
   420 \end{ttbox}
       
   421 
       
   422   All session-specific files are placed into a separate sub-directory
       
   423   given as \verb|NAME| above.  The \verb|ROOT| file is in
       
   424   the parent position relative to that --- it could refer to several
       
   425   such sessions.  The \hyperlink{tool.mkroot}{\mbox{\isa{\isatool{mkroot}}}} tool is conservative in the sense
       
   426   that does not overwrite an existing session sub-directory; an
       
   427   already existing \verb|ROOT| file is extended.
       
   428 
       
   429   The implicit Isabelle settings variable \hyperlink{setting.ISABELLE-LOGIC}{\mbox{\isa{\isatt{ISABELLE{\isaliteral{5F}{\isacharunderscore}}LOGIC}}}}
       
   430   specifies the parent session, and \hyperlink{setting.ISABELLE-DOCUMENT-FORMAT}{\mbox{\isa{\isatt{ISABELLE{\isaliteral{5F}{\isacharunderscore}}DOCUMENT{\isaliteral{5F}{\isacharunderscore}}FORMAT}}}} the document format to be filled filled
       
   431   into the generated \verb|ROOT| file.%
       
   432 \end{isamarkuptext}%
       
   433 \isamarkuptrue%
       
   434 %
       
   435 \isamarkupsubsubsection{Examples%
       
   436 }
       
   437 \isamarkuptrue%
       
   438 %
       
   439 \begin{isamarkuptext}%
       
   440 The following produces an example session, relatively to the
       
   441   \verb|ROOT| in the current directory:
       
   442 \begin{ttbox}
       
   443 isabelle mkroot Test && isabelle build -v -d. Test
       
   444 \end{ttbox}
       
   445 
       
   446   Option \verb|-v| is not required, but useful to reveal the
       
   447   the location of generated documents.%
       
   448 \end{isamarkuptext}%
       
   449 \isamarkuptrue%
       
   450 %
   405 \isadelimtheory
   451 \isadelimtheory
   406 %
   452 %
   407 \endisadelimtheory
   453 \endisadelimtheory
   408 %
   454 %
   409 \isatagtheory
   455 \isatagtheory