2. Paths Mentioned in Documentation
This documentation refers to the following directories, depending on your operating system:
$NDDSHOMEThis refers to the installation directory for Connext.The default installation paths are:
Non-root user:
/home/<your user name>/rti_connext_dds-<version>Root user:
/opt/rti_connext_dds-<version>
$NDDSHOMEis an environment variable set to the installation path.
<path to examples>By default, examples are copied into your home directory the first time you run RTI Launcher or any script in$NDDSHOME/bin. This document refers to the location of the copied examples as<path to examples>.Wherever you see
<path to examples>, replace it with the appropriate path.Default path to the examples:
/home/<your user name>/rti_workspace/<version>/examples
$NDDSHOMEThis refers to the installation directory for Connext.The default installation path is:
/Applications/rti_connext_dds-<version>
$NDDSHOMEis an environment variable set to the installation path.
<path to examples>By default, examples are copied into your home directory the first time you run RTI Launcher or any script in$NDDSHOME/bin. This document refers to the location of the copied examples as<path to examples>.Wherever you see
<path to examples>, replace it with the appropriate path.Default path to the examples:
/Users/<your user name>/rti_workspace/<version>/examples
%NDDSHOME%This refers to the installation directory for Connext.The default installation paths are:
User without Administrator privileges:
<your home directory>\rti_connext_dds-<version>User with Administrator privileges:
"C:\Program Files\rti_connext_dds-<version>"
%NDDSHOME%is an environment variable set to the installation path.Note
When using a command prompt to enter a command that includes the path
C:\Program Files(or any directory name that has a space), enclose the path in quotation marks. For example:“C:\Program Files\rti_connext_dds-<version>\bin\rtilauncher.bat”. Or if you have defined theNDDSHOMEenvironment variable:"%NDDSHOME%\bin\rtilauncher.bat".<path to examples>By default, examples are copied into your home directory the first time you run RTI Launcher or any script in%NDDSHOME%/bin. This document refers to the location of the copied examples as<path to examples>.Wherever you see
<path to examples>, replace it with the appropriate path.Default path to the examples:
<your Windows documents folder>\rti_workspace\<version>\examplesWhere
'your Windows documents folder'depends on your version of Windows. For example, on Windows 10 systems, the folder isC:\Users\<your user name>\Documents.
Sometimes this documentation uses <NDDSHOME> to refer to the installation path.
Whenever you see <NDDSHOME> used in a path, replace it with $NDDSHOME for Linux or
macOS, with %NDDSHOME% for Windows, or with your installation path.
You can specify a different location for rti_workspace.
You can also specify that you do not want the examples copied to the workspace.
For details, see Controlling Location for RTI Workspace and Copying of Examples
in the Connext Installation Guide.
2.1. API Reference HTML Documentation
The default path to the API Reference HTML documentation for each programming
language is <NDDSHOME>/doc/api/connext_dds/api_<language>.