Framesoc in command lines

This wiki page describes how to use Framesoc in command lines. Command lines are supported in Framesoc since version 1.0.11.

#Setup

To use Framesoc in command lines, you must launch an Eclipse with Framesoc already installed with the following command:

./eclipse -application fr.inria.soctrace.framesoc.headless.framesocHeadless -nosplash <COMMAND> [OPTION]

The -application parameter specifies which application to run (in our case the headless version of Framesoc) and the -nosplash option tells Eclipse not to display the launching image. <COMMAND> is the Framesoc tool that is called. If no command is provided, the output should return an error and display the list of available commands. The available commands depend on the installed plugins, since they are discovered at runtime through extension points.

Database setup

The first time Framesoc is launched, if the database has not been correctly specified, then you will be prompted with a choice of operations that will let you set up the database.

Supported command lines

The following subsections describe the usage of the supported commands. The help for each command can be accessed directly in Framesoc with the --help (or -h) option:

./eclipse -application fr.inria.soctrace.framesoc.headless.framesocHeadless -nosplash <COMMAND> --help

pjdump_exporter

  usage: pjdump_exporter [OPTION] TRACE_ID -d OUTPUT_DIRECTORY
  PJDump Exporter allows to export a trace designated by its TRACE_ID into
  	                   pjdump format in the OUTPUT_DIRECTORY.
   -d,--output-directory <arg>   Output directory
   -e,--ending-date <arg>        Ending time of the trace
   -h,--help                     Print this help
   -o,--output-file <arg>        Output file
   -s,--starting-date <arg>      Starting time of the trace

pjdump_importer

  usage: pjdump_importer [OPTION] FILE
  PJDump Importer imports a pjdump FILE into the database.
   -d,--double-precision        Use double precision (long is used as
  	                          default)
   -f,--flatten-imbrication     Flatten imbricated overlapping states in
  	                          separate states
   -h,--help                    Print this help
   -t,--timestamp-shift <arg>   Specify the shift in the timestamp decimal precision

print_traces

  usage: print_traces [OPTION]
  Print details about the traces contained in the database.
   -h,--help   Print this help