Introduction
============

This document describes the calling interface ("driver") to guitone which can
be used to script guitone's dialog system.

The general calling convention is the following:

    $ <binary> exec <path> <function> [<args>]

where

    <binary>    is the path to the guitone binary (on Mac OS X the binary inside
                the application bundle, in guitone.app/Contents/MacOS)

    <path>      is the database file or workspace path you want guitone operate
                on (use "-" to denote that you want to call a dialog without a
                database / workspace affinity, f.e. the preferences dialog)

    <function>  is the name of the function you like to call (see below)

    <args>      are optional arguments to this function

There is a calling hierarchy which makes it possible to call all dialogs without
path affinity from a call with database affinity and likewise all dialogs with
database affinity from a call with workspace affinity. So the following three
calls lead to the same results, i.e. the preferences dialog is displayed,
(though for the latter two the given database file or workspace path must be
valid):

    $ guitone exec - showPreferences
    $ guitone exec database.mtn showPreferences
    $ guitone exec ~/workspace showPreferences


Function Reference
==================

TODO, please check the sources, particularily

    src/view/dialogs/(Database|Workspace|)DialogManager.h

for a list of callable public slots in the meantime.


Known Bugs
==========

* Please note that there is currently no way of getting data from these calls in
  a defined way. If you need such a thing, drop me a mail and I'm sure we find
  a solution.