TTool configuration: Windows, UNIX

This step is optional. It consists in configuring various directories used by TTool, and various profiles / optins of TTool. Directories can be configured in an xml file, and options can be configured with comman line options.

Starting TTool: interesting Java options

Basically, TTool is started by running the ttool.jar archive. In Windows and UNIX, assuming you are located in the bin subdirectory of TTool, TTool can be started as follows:
$ java -jar ttool.jar

You may also start TTool from a different location. Example, under Windows:
C:\>java -jar C:\TTool\bin\ttool.jar
Under UNIX:
$java -Xmx2048m -jar /packages/ttool/bin/ttool.jar

You may also precise the amount of memory that the Java environment is allowed to use for TTool: Indeed, the default value might be too low, espcially if you intend to manipulate large models or reachability graphs. Example to allow the use of 2GB of memory:
$java -Xmx2048m -jar /packages/ttool/bin/ttool.jar


Command line options

The following options can be provided on the command line:
  • -config: must be followed with a reference to a configutation file, e.g., config.xml
  • The structure of the configuration file is explained in the configuration file section.

  • -launcher (default option), -nolauncher
  • Activate the possibility to start external application locally, or deactivate that option.

In both cases, you may wish to change the socket number used by the launcher (default number: 8375) to communicate with TTool. To do so, add for example the following line in the TTool configuration file:
<LauncherPort data="8274" />

Setting the configuration file

Basically, when ttool starts, it can read a configuration file in xml format, using the -config option on the command line.
The file is structured as follows:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<TURTLECONFIGURATION>

configuration lines ...

</TURTLECONFIGURATION>

with each configuration line being of the form:
<IDCONFIG data="..."/>
IDCONFIG is sometimes of the form "xxxHOST". In that case, it refers to the machine (i.e., the host) on which you intend to run the thrid-party software related to that configuration. There are two possibilities:
  • Either you intend to run the third party software on the same machine as the one on which you start TTool. In that case, you need to start TTool with the -launcher option, and you also need to set xxxHOST to localhost as follows:
  • <xxxHOST data="localhost"/>
    

  • Or you intend to run the third party software on another machine. In that case, you need to start the launcher on the other machine as follows:
  • [on the remote machine]
    $ cd TTool/bin
    $java -jar launcher.jar
    
    You also need to configure xxxHOST as follows (with remotemachine begin the name of the remote machine):
    <xxxHOST data="remotemachine"/>
    

Custom commands

Using the TTool configuration file, you can customize two TTool commands, called ExternalCommand1 and ExternalCommand2, respectively: those two commands are accessible using the two top most right icons in the main toolbar. For example, to start gtkwave from the localhost, and from the custom icon #1, you may use the following configuration (assuming gtkwave is installed in /usr/local/bin, and that the vcd file you wish to open is located in /homes/mylogin/TTool/simulators/c++2 ):
<ExternalCommand1Host data="localhost"/>
<ExternalCommand1 data="/usr/local/bin/gtkwave /homes/mylogin/TTool/simulators/c++2/vcddump.vcd"/>