Tutorial: RT-Druid Command Line

From ErikaWiki

(Difference between revisions)
Jump to: navigation, search
Line 40: Line 40:
! Task Name !! Description
! Task Name !! Description
|-
|-
-
| style="width: 30%; background-color: #eeeeee;"| rtdruid.Convert  
+
| style="width: 30%; background-color: #eeeeee;"| [[rtdruid.Convert]]
| style="width: 70%; background-color: #eeeeee;"| If needed, converts and merges one or more input files into a single new RT-Druid file
| style="width: 70%; background-color: #eeeeee;"| If needed, converts and merges one or more input files into a single new RT-Druid file
|-
|-
-
| style="width: 30%; background-color: #eeeeee;"| rtdruid.Oil.Configurator
+
| style="width: 30%; background-color: #eeeeee;"| [[rtdruid.Oil.Configurator]]
| style="width: 70%; background-color: #eeeeee;"| Generates the Erika Enterprise configuration files  
| style="width: 70%; background-color: #eeeeee;"| Generates the Erika Enterprise configuration files  
|-
|-
-
| style="width: 30%; background-color: #eeeeee;"| rtdruid.Oil.Example
+
| style="width: 30%; background-color: #eeeeee;"| [[rtdruid.Oil.Example]]
| style="width: 70%; background-color: #eeeeee;"| Instantiates a single example
| style="width: 70%; background-color: #eeeeee;"| Instantiates a single example
|-
|-
-
| style="width: 30%; background-color: #eeeeee;"| rtdruid.Oil.Examples
+
| style="width: 30%; background-color: #eeeeee;"| [[rtdruid.Oil.Examples]]
| style="width: 70%; background-color: #eeeeee;"| Instantiates all examples managed by RT-Druid
| style="width: 70%; background-color: #eeeeee;"| Instantiates all examples managed by RT-Druid
|}
|}
 +
 +
[http://ant.apache.org/ Here] you can find info abouts ant.
 +
 +
== RT-Druid scripts ==
 +
 +
Here is the list of available scripts:
 +
 +
{| border="1" style="color: black; background-color: #cccccc;" width="85%"
 +
|+
 +
! Task Name !! Description
 +
|-
 +
| style="width: 30%; background-color: #eeeeee;"| [[RT-Druid_scripts | generate_code]]
 +
| style="width: 70%; background-color: #eeeeee;"| Generates all configuration files for Erika Enterprise
 +
|-
 +
| style="width: 30%; background-color: #eeeeee;"| [[instantiate_template]]
 +
| style="width: 70%; background-color: #eeeeee;"| Instantiates a template
 +
|-
 +
| style="width: 30%; background-color: #eeeeee;"| [[start_ant]]
 +
| style="width: 70%; background-color: #eeeeee;"| Executes an ant script using ant libraries provided with eclipse
 +
|}
 +
 +
Each script is available in for windows (with .bat suffix) and for cygwin/linux (with .sh suffix).
 +
  Please note that current version of generate_code.sh requires bash to work

Revision as of 11:28, 27 March 2012

Contents

Introduction

It is possible to execute few RT-Druid's tasks without using a GUI. These tasks are invoked through ant scripts or using directly RT-Druid scripts.

 Please, note that RT-Druid is based on eclipse framework even in the CLI form. This means that 
 - ant scripts with RT-Druid tasks should be run using ant embedded in eclipse
 - direct invocation of RT-Druid scripts result in execution of an eclipse environment

Packaging

RT-Druid is distributed in several packagings:

  • Update site: it contains only RT-Druid and Erika Enterprise plugins and can be used to update an existing installation of RT-Druid, or to add RT-Druid functionalities to a generic (and standard) installation of eclipse
  • GUI: it contains RT-Druid and Erika Enterprise plugins, eclipse framework and c/c++ support. There are several versions, depending on Os (es. Windows, Linux). It contains also RT-Druid scripts.
  • CLI: it contains RT-Druid and Erika Enterprise plugins and the minimum set of eclipse plugins required by RT-Druid. It contains also RT-Druid scripts. There are three versions
    • RT-Druid: contains only RT-Druid and can be invoked only with RT-Druid scripts
    • EE_RT-Druid: contains Erika Enterprise (sources and examples) and RT-Druid. Can be invoked only with RT-Druid scripts
    • EE_RT-Druid_ant: contains Erika Enterprise (sources and examples) and RT-Druid. Can be invoked both with RT-Druid scripts and ant scripts

Advantages

Both GUI and CLI packages can be used without a graphical interface but the CLI ones are smaller, than you can save space:

  • GUI packages requires around 180MByte
  • CLI with Erika Enterprise, RT-Druid and ant support requires around 71MByte
  • CLI with Erika Enterprise, RT-Druid requires around 55MByte
  • CLI with RT-Druid requires around 7MByte

moreover the package with only RT-Druid is the best one if you are using Erika Enterprise from svn and compiling everything in an automated system.

Disadvantages

On the other side, all CLI versions cannot be automatically updated and the only way to "update" them is to download a new one.


Ant Tasks

Here is the list of available RT-Druid ant tasks:

Task Name Description
rtdruid.Convert If needed, converts and merges one or more input files into a single new RT-Druid file
rtdruid.Oil.Configurator Generates the Erika Enterprise configuration files
rtdruid.Oil.Example Instantiates a single example
rtdruid.Oil.Examples Instantiates all examples managed by RT-Druid

Here you can find info abouts ant.

RT-Druid scripts

Here is the list of available scripts:

Task Name Description
generate_code Generates all configuration files for Erika Enterprise
instantiate_template Instantiates a template
start_ant Executes an ant script using ant libraries provided with eclipse

Each script is available in for windows (with .bat suffix) and for cygwin/linux (with .sh suffix).

 Please note that current version of generate_code.sh requires bash to work
Personal tools