.. _`Preface`:


#######
Preface
#######


About The Vortex OpenSplice Tuner Guide
************************************

The *Tuner Guide* describes the Vortex OpenSplice Tuner features and how they
should be used. The Vortex OpenSplice Tuner is included with the OpenSplice
product.

The Vortex OpenSplice Tuner provides facilities for monitoring and controlling
OpenSplice and the applications that use Vortex OpenSplice for the distribution 
of data.


Intended Audience
*****************

The *Tuner Guide* is intended to be used by all Vortex OpenSplice users, 
including programmers, testers, system designers and system integrators.

Organisation
************

This *Guide* is organised in two parts.

The :ref:`Introduction <Introduction>` provides a brief, high-level 
description of the OpenSplice Tuner.

The main section, :ref:`Using the OpenSplice Tuner <Using the OpenSplice Tuner>`,
describes how to use the OpenSplice Tuner.

Conventions
***********

The icons shown below are used in the Vortex product documentation 
to help readers to quickly identify information relevant to their 
specific use of Vortex OpenSplice.


 ========= ================================================================== 
 *Icon*    *Meaning*  
 ========= ================================================================== 
 |caution| Item of special significance or where caution needs to be taken.  
 |info|    Item contains helpful hint or special information.                
 |windows| Information applies to Windows (*e.g.* XP, 2003, Windows 7) only. 
 |unix|    Information applies to Unix-based systems (*e.g.* Solaris) only.  
 |linux|   Information applies to Linux-based systems (*e.g.* Ubuntu) only.  
 |c|       C language specific.                                              
 |cpp|     C++ language specific.                                            
 |csharp|  C# language specific.                                             
 |java|    Java language specific.                                           
 ========= ================================================================== 




.. |caution| image:: ./images/icon-caution.*
            :height: 6mm
.. |info|   image:: ./images/icon-info.*
            :height: 6mm
.. |windows| image:: ./images/icon-windows.*
            :height: 6mm
.. |unix| image:: ./images/icon-unix.*
            :height: 6mm
.. |linux| image:: ./images/icon-linux.*
            :height: 6mm
.. |c| image:: ./images/icon-c.*
            :height: 6mm
.. |cpp| image:: ./images/icon-cpp.*
            :height: 6mm
.. |csharp| image:: ./images/icon-csharp.*
            :height: 6mm
.. |java| image:: ./images/icon-java.*
            :height: 6mm

         