<?xml version="1.0" encoding="UTF-8"?>
<!--
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  - JASMINe
  - Copyright (C) 2011 Bull S.A.S.
  - Contact: jasmine@ow2.org
  -
  - This library is free software; you can redistribute it and/or
  - modify it under the terms of the GNU Lesser General Public
  - License as published by the Free Software Foundation; either
  - version 2.1 of the License, or any later version.
  -
  - This library is distributed in the hope that it will be useful,
  - but WITHOUT ANY WARRANTY; without even the implied warranty of
  - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  - Lesser General Public License for more details.
  -
  - You should have received a copy of the GNU Lesser General Public
  - License along with this library; if not, write to the Free Software
  - Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
  - USA
  -
  -
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  - $Id$
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-->
<sect1 version="5.0" xml:lang="en" xml:id="jasmineprobe.tools_felixshell_cmd" xmlns="http://docbook.org/ns/docbook"
  xmlns:xlink="http://www.w3.org/1999/xlink"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xmlns:svg="http://www.w3.org/2000/svg"
  xmlns:mml="http://www.w3.org/1998/Math/MathML"
  xmlns:html="http://www.w3.org/1999/xhtml"
  xmlns:db="http://docbook.org/ns/docbook">

  <title>Shelbie Commands</title>
  <para>
    After starting the JASMINe Probe Agent with the <emphasis>jasmine-probe</emphasis> shell command and the <emphasis>-tui</emphasis> option,
    you can use the available Shelbie commands. Get the list of all the commands by using the <emphasis>Tab</emphasis> key on your keyboard. The JASMINe Probe commands are prefixed
    by <emphasis>legacy:</emphasis> and are starting by one of the JASMINe Probe artifact names: <emphasis>indicator-</emphasis>, <emphasis>output-</emphasis>,
    <emphasis>probe-</emphasis> and <emphasis>target-</emphasis>
  </para>
  <para>
    <screen>
       $ jasmine-probe.sh start -tui
       ...
       $ indicator-XXX
       ...
       $ outup-XXX
       ...
       $ probe-XXX
       ...
       $ target-XXX
    </screen>
  </para>
  <para>
    If you want to stop the JASMINe Probe Agent, you can use the <emphasis>shutdown</emphasis> command.
  </para>
  <sect2>
    <title>Target management</title>
    <para>The target management commands allow to create, list and remove targets using
      <emphasis>target-create</emphasis>, <emphasis>target-list</emphasis> and <emphasis>target-remove</emphasis>.
    </para>
  </sect2>
  <sect2>
    <title>Indicator management</title>

    <para>
      Additionally to create, remove and list operations, you may change an indicator definition using the <emphasis>indicator-change</emphasis> command.
      Moreover, the <emphasis>indicator-types</emphasis> command allows to list all the indicator types available on the platform.<sbr/>
      In order to determine the properties that must be defined for an indicator of a given type, use <emphasis>indicator-properties</emphasis> command.
      The <emphasis>indicator-info</emphasis> command allows to get detailed description about indicators of a given type.
    </para>
  </sect2>
  <sect2>
    <title>Output management</title>

    <para>
       Similar to indicators management, but use <emphasis>output-</emphasis> prefix.
    </para>
  </sect2>

  <sect2>
    <title>Probe management</title>

    <para>
      Probe management commands' name is prefixed by <emphasis>probe-</emphasis>. Additionally to create, remove, list and change operations, commands are provided to start or stop a probe, or all probes.
    </para>
  </sect2>

  <sect2>
    <title>Configuration management</title>

    <para>
      In order to save all the current artifact definitions, use the <emphasis>probe-config-save</emphasis> command.<sbr/>
      Definitions can be loaded from an updated probe-config.xml file using the <emphasis>probe-config-load</emphasis> command.
    </para>
  </sect2>

</sect1>
