Documentation Conventions

This manual is an introduction to the 60East Technologies AMPS product. It assumes that you have a working knowledge of Linux and uses the following conventions.

Construct

Usage

Text

Standard document text

Code

Inline code fragment

Variable

Variables within commands or configuration

Parameter (required)

Required parameters in parameter tables

Optional

Optional parameters in parameter tables

The AMPS documentation also includes the following types of notes:

Inside boxes with this icon, you will find usage tips or extra information.

Inside boxes with this icon, you will find information that's important to keep in mind when working with AMPS. These are typically recommendations that should generally be followed, but may not be applicable in special cases.

Inside boxes with this icon, you will find important information and guidelines that require special consideration or caution when using AMPS to ensure the proper functioning of the system and to avoid any potential issues or risks.

Inside boxes with this icon, you will find usage warnings or information that is critical for ensuring that AMPS functions correctly.

Documentation Conventions

Additionally, here are the constructs used for displaying content filters, XML, code, command line, and script fragments.

(expr1 = 1) OR (expr2 = 2) OR (expr3 = 3) OR (expr4 = 4) OR (expr5 = 5) OR (expr6 = 6) OR (expr7 = 7) OR (expr8 = 8)

Command lines will be formatted as in the following example:

$ find . -name *.java

Last updated

Copyright 2013-2024 60East Technologies, Inc.