documentation for "isabelle jedit_client";
authorwenzelm
Thu Dec 31 20:40:28 2015 +0100 (2015-12-31)
changeset 62014446fcbadc6bf
parent 62013 92a2372a226b
child 62015 db9c2af6ce72
documentation for "isabelle jedit_client";
NEWS
src/Doc/JEdit/JEdit.thy
     1.1 --- a/NEWS	Thu Dec 31 19:53:19 2015 +0100
     1.2 +++ b/NEWS	Thu Dec 31 20:40:28 2015 +0100
     1.3 @@ -87,7 +87,7 @@
     1.4  * Action "isabelle-reset" now uses keyboard shortcut C+e BACK_SPACE,
     1.5  instead of former C+e LEFT.
     1.6  
     1.7 -* New command-line tool "isabelle jedit_client" allows to connect to
     1.8 +* New command-line tool "isabelle jedit_client" allows to connect to an
     1.9  already running Isabelle/jEdit process. This achieves the effect of
    1.10  single-instance applications seen on common GUI desktops.
    1.11  
     2.1 --- a/src/Doc/JEdit/JEdit.thy	Thu Dec 31 19:53:19 2015 +0100
     2.2 +++ b/src/Doc/JEdit/JEdit.thy	Thu Dec 31 20:40:28 2015 +0100
     2.3 @@ -218,7 +218,10 @@
     2.4    platform-specific executable wrappers for Linux, Windows, Mac OS X.
     2.5    Nonetheless it is occasionally useful to invoke the Prover IDE on the
     2.6    command-line, with some extra options and environment settings as explained
     2.7 -  below. The command-line usage of @{tool_def jedit} is as follows:
     2.8 +  below.
     2.9 +
    2.10 +  \<^medskip>
    2.11 +  The command-line usage of @{tool_def jedit} is as follows:
    2.12    @{verbatim [display]
    2.13  \<open>Usage: isabelle jedit [OPTIONS] [FILES ...]
    2.14  
    2.15 @@ -261,7 +264,34 @@
    2.16    Isabelle/jEdit. This is only relevant for building from sources, which also
    2.17    requires an auxiliary \<^verbatim>\<open>jedit_build\<close> component from @{url
    2.18    "http://isabelle.in.tum.de/components"}. The official Isabelle release
    2.19 -  already includes a pre-built version of Isabelle/jEdit. \<close>
    2.20 +  already includes a pre-built version of Isabelle/jEdit.
    2.21 +
    2.22 +  \<^medskip>
    2.23 +  It is also possible to connect to an already running Isabelle/jEdit process
    2.24 +  via @{tool_def jedit_client}:
    2.25 +  @{verbatim [display]
    2.26 +\<open>Usage: isabelle jedit_client [OPTIONS] [FILES ...]
    2.27 +
    2.28 +  Options are:
    2.29 +    -c           only check presence of server
    2.30 +    -n           only report server name
    2.31 +    -s NAME      server name (default Isabelle)
    2.32 +
    2.33 +  Connect to already running Isabelle/jEdit instance and open FILES\<close>}
    2.34 +
    2.35 +  The \<^verbatim>\<open>-c\<close> option merely checks the presence of the server, producing a
    2.36 +  process return code.
    2.37 +
    2.38 +  The \<^verbatim>\<open>-n\<close> option reports the server name, and the \<^verbatim>\<open>-s\<close> option provides a
    2.39 +  different server name. The default server name is the official distribution
    2.40 +  name (e.g.\ \<^verbatim>\<open>Isabelle2016\<close>). Thus @{tool jedit_client} can connect to the
    2.41 +  main Isabelle application without further options.
    2.42 +
    2.43 +  The regular jEdit command line option \<^verbatim>\<open>-server\<close> allows to provide a
    2.44 +  different name, e.g.\ \<^verbatim>\<open>isabelle jedit -j-server=\<close>\<open>name\<close>. To connect to such
    2.45 +  an alternative server process with @{tool jedit_client} requires a
    2.46 +  corresponding option \<^verbatim>\<open>-s\<close>~\<open>name\<close>.
    2.47 +\<close>
    2.48  
    2.49  
    2.50  chapter \<open>Augmented jEdit functionality\<close>