Conventions used in the documentation
Several conventions are used in the documentation for special terms, actions, commands, paths that are dependent on your operating system, and for platform-specific and product-specific information.
Typeface conventions
The following typeface
conventions are used in the documentation:
- Bold
-
- Lowercase commands, mixed-case commands, parameters, and environment variables that are otherwise difficult to distinguish from the surrounding text
- Interface controls (check boxes, push buttons, radio buttons, spin buttons, fields, folders, icons, list boxes, items inside list boxes, multicolumn lists, containers, menu choices, menu names, tabs, property sheets), labels (such as Tip:)
- Keywords and parameters in text
- Italic
-
- Citations (examples: titles of publications, diskettes, and CDs)
- Words and phrases defined in text (example: a nonswitched line is called a point-to-point line)
- Emphasis of words and letters (example: The LUN address must start with the letter L.)
- New terms in text, except in a definition list (example: a view is a frame in a workspace that contains data.)
- Variables and values you must provide (example: where myname represents…)
- Monospace
-
- Examples and code examples
- File names, directory names, path names, programming keywords, properties, and other elements that are difficult to distinguish from the surrounding text
- Message text and prompts
- Text that you must type
- Values for arguments or command options
- Bold monospace
-
- Command names, and names of macros and utilities that you can type as commands
- Environment variable names in text
- Keywords
- Parameter names in text: API structure parameters, command parameters and arguments, and configuration parameters
- Process names
- Registry variable names in text
- Script names
Operating system-dependent variables and paths
The
direction of the slash for directory paths might vary in the documentation.
Regardless of what you see in the documentation, follow these guidelines:
Use a forward slash (/).
Use a backslash (\).
The names of environment variables are not always the same in Windows and AIX®. For example, %TEMP% in Windows is equivalent to $TMPDIR in AIX or Linux.
For environment variables, follow
these guidelines:
- Use $variable.
- Use %variable%.
If you are using the bash shell on
a Windows system, you can
use the AIX conventions.
Installation directory variable and paths for IBM Performance Management server
install_dir is the installation directory for the IBM® Performance Management server. For Red Hat Enterprise Linux operating systems, /opt/ibm is the default location.
Installation directory variable and paths for agents
install_dir is
the installation directory for the agents. The default location depends
on the operating system:
- C:\IBM\APM
/opt/ibm/apm/agent
/opt/ibm/ccm/agent