Documentation Conventions

This documentation uses a number of text and style conventions to indicate and differentiate between different types of information, and ways to call out product and version specific content, as explained in the sections below.

Text formatting

• Text in this style is used to show an important element or piece of information. It may be used and combined with other text styles as appropriate to the context.
• Text in this style is used to show a section heading, table heading, or particularly important emphasis of some kind.
• Program or configuration options are formatted using this style.
• Commands, including sub-commands to a command-line tool are formatted using Text in this style. Commands are also automatically linked to their respective documentation page when this is known. For example, tpm links automatically to the corresponding reference page.
• Text in this style indicates literal or character sequence text used to show a specific value.
• Filenames, directories or paths are shown like this /etc/passwd. Filenames and paths are automatically linked to the corresponding reference page if available.

Bulleted lists are used to show lists, or detailed information for a list of items.

Code listings are used to show sample programs, code, configuration files and other elements. These can include both user input and replaceable values:

shell> cd /opt/continuent/software
shell> tar zxvf tungsten-clustering-8.0.4-132.tar.gz

In the above example command-lines to be entered into a shell are prefixed using shell. This shell is typically sh, ksh, or bash on Linux and Unix platforms.

If commands are to be executed using administrator privileges, each line will be prefixed with root-shell, for example:

root-shell> vi /etc/passwd

Lines prefixed with mysql> should be entered within the mysql command-line interface.

Lines prefixed with cctrl> should be entered within the cctrl command-line interface.

Version specific content

Version specific features and tools will be highlighted in a number of different way. Either a callout section like the following:

Version availability

Available in 8.0 and later.

This implies the feature/content was introduced or changed from the version noted, in this example, v8.0.0

In tables showing options, you will see a version column, the value shown refers to the version the option was introduced. If no value is shown, then the option is available in all GA versions, for example, in the table below the --example-option-new was added in version 7.1.0, whereas --example-option is available in all releases:

Option	Description	Version
--example-option	This option will do something specific
--example-option-new	This option will do something specific	7.1.0

Product specific content

If certain content is specific only to a single product, then this will be highlighted in a number of different ways.

If a CLI tool is only available in a certain product, then at the top of the content page, you will see something like the following:

Applies to: Tungsten Clustering for MySQL

This implies the content is only specific to Tungsten Clustering.

If only certain paragraphs of content relate to a specific version, this will be clearly noted in the content itself.

In tables showing options, you will see a Product column, the value shown refers to the product for which the entry is applicable.

The column will show either "CT" and/or "TR" for example, --example-option-new that was added in version 7.1.0 is only applicable to Tungsten Clustering, whereas --example-option is available in all releases and available in both Tungsten Replicator and Tungsten Clustering:

Option	Description	Version	Product
--example-option	This option will do something specific		CTTR
--example-option-new	This option will do something specific	7.1.0	CT

note

If a table does NOT show the product column, then the options are applicable to all products