.. _`Preface`:

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

.. TO BE REFINED... 

***************************************************
About the Vortex OpenSplice Node Monitor User Guide
***************************************************

The *Vortex OpenSplice Node Monitor User Guide* provides the 
information needed by anyone who wants to monitor the 
statistics about the performance of a system.

*This Guide contains:*

+ a list of supported platforms

+ instructions for starting and stopping the Node Monitor

+ descriptions of the Node Monitor configuration options

+ a categorized list of the types of data that can be
  accessed with the Node Monitor




***********
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 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

         
