.. _`Preface`:


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


About The RnR Manager User Guide
********************************

The *Vortex OpenSplice Record and Replay Manager (RnR Manager) User Guide* is
intended to provide a complete reference on how to use this tool to manage the
Vortex OpenSplice Record and Replay Service (*RnR Service*).

This *User Guide* is intended to be used after the Vortex OpenSplice software
including the RnR Service has been installed on the network and configured
according to the instructions in the Vortex OpenSplice *Getting Started Guide*.


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

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


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

The *User Guide* is organised as follows:

The :ref:`Introduction <Introduction>` gives an overview of the 
purpose and design of RnR Manager, together with general descriptions 
of its features.

:ref:`Installation <Installation>` describes how to install RnR Manager 
and its license file.

:ref:`Using the Record and Replay Manager <Using the Record and Replay Manager>`
gives detailed descriptions of all of the functions and features 
of RnR Manager.


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

The icons shown below are used in 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

         
