Sun Java System Message Queue 4.2 Installation Guide

Documentation Conventions

This section describes various conventions used in Message Queue documentation.

Typographic Conventions

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.

Symbol Conventions

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.

Directory Variable Conventions

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.

Note –

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.

Table P–4 Directory Variable Conventions


Variable	Description
`IMQ_HOME`	Message Queue home directory: Unused on Solaris and Linux; there is no Message Queue home directory. On Windows, denotes the directory `mqInstallHome\mq`, where `mqInstallHome` is the installation home directory you specify when installing the product (by default, `C:\Program Files\Sun\MessageQueue`). Note – The information above applies only to the standalone installation of Message Queue. When Message Queue is installed and run as part of a Sun Java System Application Server installation, `IMQ_HOME` is set to `appServerInstallDir/imq`, where `appServerInstallDir` is the Application Server installation directory.
`IMQ_VARHOME`	Directory in which Message Queue temporary or dynamically created configuration and data files are stored; can be set as an environment variable to point to any directory. On Solaris, defaults to `/var/imq`. On Linux, defaults to `/var/opt/sun/mq`. On Windows, defaults to `IMQ_HOME\var`. Note – The information above applies only to the standalone installation of Message Queue. When Message Queue is installed and run as part of a Sun Java System Application Server installation, `IMQ_VARHOME` is set to `appServerDomainDir/imq`, where `appServerDomainDir` is the domain directory for the domain starting the Message Queue broker.
`IMQ_JAVAHOME`	Location of the Java runtime environment (JRE) used by Message Queue executables.