Sun GlassFish Message Queue 4.4 Developer's Guide for JMX Clients

Documentation Conventions

This section describes the following conventions used in Message Queue documentation:

Typographic Conventions

The following table describes the typographic conventions that are used in this book.

Table P–2 Typographic Conventions


Typeface	Meaning	Example
`AaBbCc123`	The 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 terms to be emphasized	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 bold online.

Symbol Conventions

The following table explains symbols that might be used in this book.

Table P–3 Symbol Conventions


Symbol	Description	Example	Meaning
`[ ]`	Contains optional arguments and command options.	`ls [-l]`	The `-l` option is not required.
`{ \| }`	Contains 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 `com.sun.javaRoot` variable.
-	Joins simultaneous multiple keystrokes.	Control-A	Press the Control key while you press the A key.
+	Joins consecutive multiple keystrokes.	Ctrl+A+N	Press the Control key, release it, and then press the subsequent keys.
->	Indicates menu item selection in a graphical user interface.	File -> New -> Templates	From the File menu, choose New. From the New submenu, choose Templates.

Shell Prompt Conventions

The following table shows the conventions used in Message Queue documentation for the default UNIX® system prompt and superuser prompt for the C shell, Bourne shell, Korn shell, and for the Windows operating system.

Table P–4 Shell Prompt Conventions


Shell	Prompt
C shell on UNIX, Linux, or AIX	`machine-name%`
C shell superuser on UNIX, Linux, or AIX	`machine-name#`
Bourne shell and Korn shell on UNIX, Linux, or AIX	`$`
Bourne shell and Korn shell superuser on UNIX, Linux, or AIX	`#`
Windows command line	`C:\>`

Directory Variable Conventions

Message Queue documentation makes use of three directory variables; two of which represent environment variables needed by Message Queue. (How you set the environment variables varies from platform to platform.)

The following table describes the directory variables that might be found in this book and how they are used. When installed from the IPS (pkg(5)) image distribution, Message Queue is installed in a directory referred to as mqInstallHome, and some of the directory variables in Table P–5 reference this mqInstallHome directory.

Note –

In this book, directory variables are shown without platform-specific environment variable notation or syntax (such as $IMQ_HOME on UNIX). Non-platform-specific path names use UNIX directory separator (/) notation.

Table P–5 Directory Variable Conventions


Variable	Description
`IMQ_HOME`	Message Queue home directory, if any: For installations from the IPS image distribution on any platform, `IMQ_HOME` denotes the directory `mqInstallHome/mq`, where `mqInstallHome` is specified when you install Message Queue. For installations from Solaris SVR4 packages, `IMQ_HOME` is unused. For installations from Linux RPM packages, `IMQ_HOME` is unused.
`IMQ_VARHOME`	Directory in which Message Queue temporary or dynamically created configuration and data files are stored; `IMQ_VARHOME` can be explicitly set as an environment variable to point to any directory or will default as described below: For installations from the IPS image distribution on any platform, `IMQ_VARHOME` defaults to `mqInstallHome/var/mq`. For installations from Solaris SVR4 packages, `IMQ_VARHOME` defaults to `/var/imq`. For installations from Linux RPM packages, `IMQ_VARHOME` defaults to `/var/opt/sun/mq`.
`IMQ_JAVAHOME`	An environment variable that points to the location of the Java runtime environment (JRE) required by Message Queue executable files: On Solaris, Linux and Windows, Message Queue looks for the latest JDK, but you can optionally set the value of `IMQ_JAVAHOME` to wherever the preferred JRE resides. On AIX, `IMQ_JAVAHOME` is set to point to an existing Java runtime when you perform Message Queue installation.