Document Conventions

This section contains information on the documentation conventions that are followed throughout this guide.

Monospaced Font

Monospaced font is used for any text that appears on the computer screen or text that you should type. It is also used for file names, distinguished names, functions, and examples.

Bold Monospaced Font

Bold monospaced font is used to represent text within a code example that you should type. For example, you might see something like this:

./installer

In this example, ./installer is what you would type at the command line.

Italicized Font

Italicized font is used to represent text that you enter using information that is unique to your installation (for example, variables). It is used for server paths, names.

For example, throughout this document you will see path references of the form:

msg_svr_base/...

The Messaging Server Base (msg_svr_base) represents the directory path in which you install the server. The default value of the msg_svr_base is /opt/SUNWmsgsr.

Italicized font is also used for variables within the synopsis of a command line utility. For example, the synopsis for the commadmin admin remove command is:

commadmin admin remove -D login -l userid -n domain -w password [-d domain] [-h] [-i inputfile] [-p port] [-X host] [-s] [-v]

In the above example, the italicized words are arguments for their associated option. For example, in the -w password option, you would substitute the Administrator’s password for password when you enter the commadmin admin remove command.

Square or Straight Brackets

Square (or straight) brackets [] are used to enclose optional parameters. For example, in the installation guide you will see the usage for the installer command described as follows:

./installer [options] [arguments]

It is possible to run the installer command by itself as follows to start the Messaging Server installation:

./installer

However, the presence of [options] and [arguments] indicate that there are additional optional parameters that may be added to the installer command. For example, you could use installer command with the -b option to specify the msg_svr_base prior to running the installation program:

./installer -b /opt/SUNWmsgsr

Command-Line Prompts

Command-line prompts (for example, % for a C-Shell, or $ for a Korn or Bourne shell) are not displayed in the examples. Depending on which operating system environment you are using, you will see a variety of different command-line prompts. However, you should enter the command as it appears in the document unless specifically noted otherwise.

Platform-specific Syntax