Product SiteDocumentation Site

6. Conventions

The following conventions are used throughout this document:
Convention
Meaning
${PCP_VARIABLE}
A brace-enclosed all-capital-letters syntax indicates a variable that has been sourced from the global /etc/pcp.conf file. These special variables indicate parameters that affect all PCP commands, and are likely to be different between platforms.
command
This fixed-space font denotes literal items such as commands, files, routines, path names, signals, messages, and programming language structures.
variable
Italic typeface denotes variable entries and words or concepts being defined.
user input
This bold, fixed-space font denotes literal items that the user enters in interactive sessions. (Output is shown in nonbold, fixed-space font.)
[ ]
Brackets enclose optional portions of a command or directive line.
...
Ellipses indicate that a preceding element can be repeated.
ALL CAPS
All capital letters denote environment variables, operator names, directives, defined constants, and macros in C programs.
()
Parentheses that follow function names surround function arguments or are empty if the function has no arguments; parentheses that follow commands surround man page section numbers.