Documentation Conventions

This section describes the types of conventions used throughout this guide:

• General Conventions

• Conventions Referring to Directories

General Conventions

The following general conventions are used in this guide:

• File and directory paths are given in UNIX^(R) format (with forward slashes separating directory names). For Windows versions, the directory paths are the same, except that backslashes are used to separate directories.

• URLs are given in the format:

  http://server.domain/path/file.html

  In these URLs, server is the server name where applications are run; domain is your Internet domain name; path is the server's directory structure; and file is an individual filename. Italic items in URLs are placeholders.

• Font conventions include:

  • The monospace font is used for sample code and code listings, API and language elements (such as function names and class names), file names, pathnames, directory names, and HTML tags.

  • Italic type is used for code variables.

  • Italic type is also used for book titles, emphasis, variables and placeholders, and words used in the literal sense.

  • Bold type is used as either a paragraph lead-in or to indicate words used in the literal sense.

• Installation root directories for most platforms are indicated by install_dir in this document. Exceptions are noted in "Conventions Referring to Directories" on Conventions Referring to Directories.

  By default, the location of install_dir on most platforms is:

  • Solaris 8 non-package-based Evaluation installations:

    user's home directory/sun/appserver7

  • Solaris unbundled, non-evaluation installations:

    /opt/SUNWappserver7

  • Windows, all installations:

    C:\Sun\AppServer7

  For the platforms listed above, default_config_dir and install_config_dir are identical to install_dir. See Conventions Referring to Directories for exceptions and additional information.

• Instance root directories are indicated by instance_dir in this document, which is an abbreviation for the following:

  default_config_dir/domains/domain/instance
  

• UNIX-specific descriptions throughout this manual apply to the Linux operating system as well, except where Linux is specifically mentioned.

Conventions Referring to Directories

By default, when using the Solaris 8 and 9 package-based installation and the Solaris 9 bundled installation, the application server files are spread across several root directories. These directories are described in this section.

• For Solaris 9 bundled installations, this guide uses the following document conventions to correspond to the various default installation directories provided:

  • install_dir refers to /usr/appserver/, which contains the static portion of the installation image. All utilities, executables, and libraries that make up the application server reside in this location.

  • default_config_dir refers to /var/appserver/domains, which is the default location for any domains that are created.

  • install_config_dir refers to /etc/appserver/config, which contains installation-wide configuration information such as licenses and the master list of administrative domains configured for this installation.

• For Solaris 8 and 9 package-based, non-evaluation, unbundled installations, this guide uses the following document conventions to correspond to the various default installation directories provided:

  • install_dir refers to /opt/SUNWappserver7, which contains the static portion of the installation image. All utilities, executables, and libraries that make up the application server reside in this location.

  • default_config_dir refers to /var/opt/SUNWappserver7/domainswhich is the default location for any domains that are created.

  • install_config_dir refers to /etc/opt/SUNWappserver7/config, which contains installation-wide configuration information such as licenses and the master list of administrative domains configured for this installation.