.. _xxx:

xxx
==============================

ToDo: Describe in a one liner what the tool is doing.


Synopsis
--------

ToDo: Desribe in detail what the tool is doing, what it takes on input and
what it produces on output. Please do not write more than 80 characters per
line since this file is also used to produce a help text for the terminal.


General parameters
------------------

ToDo: Add here your parameters.


Standard parameters
-------------------

``(chatter = 2) [integer]``
    Verbosity of the executable:
     ``chatter = 0``: no information will be logged

     ``chatter = 1``: only errors will be logged

     ``chatter = 2``: errors and actions will be logged

     ``chatter = 3``: report about the task execution

     ``chatter = 4``: detailed report about the task execution

``(clobber = yes) [boolean]``
    Specifies whether an existing output file should be overwritten.

``(debug = no) [boolean]``
    Enables debug mode. In debug mode the executable will dump any log file output to the console.

``(mode = ql) [string]``
    Mode of automatic parameters (default is ``ql``, i.e. "query and learn").

``(logfile = xxx.log) [string]``
    Name of log file.


Related tools or scripts
------------------------

None