This section describes various conventions used in Message Queue documentation.
Table P–2 shows the typographic conventions used inMessage Queue documentation.
Table P–2 Typographic Conventions
Typeface |
Meaning |
Example |
---|---|---|
AaBbCc123 |
Names of commands, files, and directories, and onscreen computer output |
Edit your .login file. Use ls -a to list all files. machine_name% you have mail. |
AaBbCc123 |
What you type, contrasted with onscreen computer output |
machine_name% su Password: |
AaBbCc123 |
Placeholder: replace with a real name or value |
The command to remove a file is rm fileName. |
AaBbCc123 |
Book titles, new terms, and emphasized words |
Read Chapter 6 in the User’s Guide. A cache is a copy that is stored locally. Do not save the file. Note – Some emphasized items appear online in boldface. |
Table P–3 shows symbol conventions used inMessage Queue documentation.
Table P–3 Symbol Conventions
Symbol |
Description |
Example |
Meaning |
---|---|---|---|
[ ] |
Encloses optional arguments and command options |
ls [-l] |
The -l option is optional. |
{ | } |
Encloses a set of choices for a required command option |
-d {y|n} |
The -d option requires that you use either the y argument or the n argument. |
${ } |
Indicates a variable reference |
${com.sun.javaRoot} |
References the value of the variable com.sun.javaRoot. |
- |
Joins simultaneous multiple keystrokes |
Ctrl-A |
Hold down the Control key while pressing the A key. |
+ |
Joins consecutive multiple keystrokes |
Ctrl+A+N |
Press the Control key, release it, and then press the subsequent keys. |
-> |
Indicates hierarchical menu selection in a graphical user interface |
File -> New -> Templates |
From the File menu, choose New; from the New submenu, choose Templates. |
Message Queue makes use of three directory variables; how they are set varies from platform to platform. Table P–4 describes these variables and how they are used on the Solaris, Linux, and Windows platforms.
In this manual, these directory variables are shown without platform-specific environment variable notation or syntax (such as $IMQ_HOME on UNIX). Non-platform-specific pathnames use UNIX directory separator (/) notation.