Conventions Used in This Book

Check that the meaning of the symbols in the following table are accurate for your product or platform. For more information, see “Documenting Multiple Keystrokes” in Chapter 2 of the Sun Editorial Style Guide.

Example

The guide uses typographical conventions to represent types of information presented.

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:

./pssetup

*******************************************************************

Sun Java™ System Portal Server

*******************************************************************

Installation log at

/var/sadm/install/logs/ipsinstall.13343/install.log

This product will run without a license. However, you must either purchase a Binary Code License from, or accept the terms of a Binary Software Evaluation license with, Sun Microsystems, to legally use this product.

Do you accept? yes/[no]

In this example, ./pssetup is what you would type from the command line. The rest is what would appear as a result.

Italicized Font

An 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 and names and account IDs.

Square or Straight Brackets

Square (or straight) brackets [] are used to enclose optional parameters. For example, in Portal Server software documentation, you will see the usage for the dpadmin command described as follows:

dpadmin list|modify|add|remove [command-specific options]

The presence of [command-specific] indicates that optional parameters can be added to the dpadmin command.

Command-Line Prompts

Command-line prompts (for example, % for a C-Shell, or $ for a Korn or Bourne shell) are not displayed in 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.