.. include:: vars.rst

.. _section-installation:

Installation
************

Installing |TSS_HEADING| 
========================

The |TSS| package is provided in a zip archive, 
``rti_connext_tss_4.1.0-EAR.zip``. The package is available for download
in the `RTI Customer Portal <https://support.rti.com>`_; if you do not 
have access, contact `RTI Customer Support <mailto:support.rti.com>`_.

To install |TSS|, unzip the archive:

.. code-block:: bash

  unzip rti_connext_tss-4.1.0-EAR.zip

The |TSS| libraries are shipped as source code. After installing, 
you must :ref:`build the libraries <section-build>` before using 
|TSS| with a FACE application.

.. note::

   The root directory where the archive is extracted is the |TSS| 
   installation directory, which is referred to as ``<RTITSSHOME>``.
   See :ref:`section-Introduction-Paths` for a complete list of paths 
   noted in this manual.
   

|TSS_HEADING| Package Contents
==============================

.. list-table:: 
    :name: TableFACETSSPackageContents
    :widths: 20 80
    :header-rows: 1

    * - Folder or File
      - Description 

    * - **bin/**
      - Includes a version of *RTI Code Generator*, referred to as 
        *rtiddsgen*. Modified specifically for |TSS|, this tool is used 
        to generate TSS-specific header and plug-in source files.

    * - **doc/**
      - Includes the complete |TSS| user's manual and API documentation 
        in html format.

    * - **code/C/include/**
      - Header files for |TSS| C implementation.

    * - **code/C/src/**
      - Source files for |TSS| C implementation.

    * - **code/C++/include/**
      - Header files for |TSS| C++ wrapper of C implementation.

    * - **code/C++/src/**
      - Source files for |TSS| C++ wrapper of C implementation.

    * - **examples/**
      - An example FACE application that makes use of the |TSS| library.

    * - **resource/**
      - Includes CMake and *rtiddsgen* support files.

    * - **CMakeLists.txt**
      - A CMake script for generating the build environment for |TSS| 
        libraries.

    * - **README.html**
      - Links to the |TSS| user's manual provided in the ``doc`` folder.