Typographical Conventions

Copyright © Cloud Software Group, Inc. All rights reserved.

Preface : Typographical Conventions

Typographical Conventions

TIBCO iProcess Engine can be run on both Microsoft Windows and UNIX/Linux platforms. In this manual, the Windows convention of a backslash (\) is used. The equivalent pathname on a UNIX or Linux system is the same, but using the forward slash (/) as a separator character.

UNIX or Linux pathnames are occasionally shown explicitly, using forward slashes as separators, where a UNIX or Linux-specific example or syntax is required.

Any references to UNIX in this manual also apply to Linux unless explicitly stated otherwise.

The following typographical conventions are used in this manual

Table 1 General Typographical Conventions

Convention

Use

SWDIR

TIBCO iProcess Engine installs into a directory. This directory is referenced in documentation as SWDIR. The value of SWDIR depends on the operating system. For example,

•

on a Windows server (on the C: drive)

if SWDIR is set to the C:\swserver\staffw_nod1 directory, then the full path to the swutil command is in the C:\swserver\staffw_nod1\bin\swutil directory.

•

on a UNIX or Linux server

if SWDIR is set to the /swserver/staffw_nod1 directory, then the full path to the swutil command is in the /swserver/staffw_nod1/bin/swutil directory or the $SWDIR/bin/swutil directory.

Note: On a UNIX or Linux system, the environment variable $SWDIR should be set to point to the iProcess system directory for the root and swadmin users.

IPEADMIN

Indicates the operating system account that is used to administer the iProcess Engine node.

IPESERVICE

Indicates the Windows account that is used to run the iProcess Engine node. (Not used on UNIX.)

IPEBAKGROUND

Indicates the UNIX user account that owns most iProcess Engine files and is used to run the iProcess Engine background processes. (Not used on Windows.)

code font

Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example:

Use MyCommand to start the foo process.

bold code font

Bold code font is used in the following ways:

•

In procedures, to indicate what a user types. For example: Type admin.

•

In large code samples, to indicate the parts of the sample that are of particular interest.

•

In command syntax, to indicate the default parameter for a command. For example, if no parameter is specified, MyCommand is enabled:
MyCommand [enable | disable]

italic font

Italic font is used in the following ways:

•

To indicate a document title. For example: See TIBCO ActiveMatrix BusinessWorks Concepts.

•

To introduce new terms. For example: A portal page may contain several portlets. Portlets are mini-applications that run in a portal.

•

To indicate a variable in a command or code syntax that you must replace. For example: MyCommand PathName

Key combinations

Key name separated by a plus sign indicate keys pressed simultaneously. For example: Ctrl+C.

Key names separated by a comma and space indicate keys pressed one after the other. For example: Esc, Ctrl+Q.

The note icon indicates information that is of special interest or importance, for example, an additional action required only in certain circumstances.

The tip icon indicates an idea that could be useful, for example, a way to apply the information provided in the current section to achieve a specific result.

The warning icon indicates the potential for a damaging situation, for example, data loss or corruption if certain steps are taken or not taken.

Table 2 Syntax Typographical Conventions

Convention

Use

[ ]

An optional item in a command or code syntax.

For example:

MyCommand [optional_parameter] required_parameter

|

A logical OR that separates multiple items of which only one may be chosen.

For example, you can select only one of the following parameters:

MyCommand param1 | param2 | param3

{ }

A logical group of items in a command. Other syntax notations may appear within each logical group.

For example, the following command requires two parameters, which can be either the pair param1 and param2, or the pair param3 and param4.

MyCommand {param1 param2} | {param3 param4}

In the next example, the command requires two parameters. The first parameter can be either param1 or param2 and the second can be either param3 or param4:

MyCommand {param1 | param2} {param3 | param4}

In the next example, the command can accept either two or three parameters. The first parameter must be param1. You can optionally include param2 as the second parameter. And the last parameter is either param3 or param4.

MyCommand param1 [param2] {param3 | param4}

Convention	Use
[ ]	An optional item in a command or code syntax. For example: MyCommand [optional_parameter] required_parameter
\|	A logical OR that separates multiple items of which only one may be chosen. For example, you can select only one of the following parameters: MyCommand param1 \| param2 \| param3
{ }	A logical group of items in a command. Other syntax notations may appear within each logical group. For example, the following command requires two parameters, which can be either the pair param1 and param2, or the pair param3 and param4. MyCommand {param1 param2} \| {param3 param4} In the next example, the command requires two parameters. The first parameter can be either param1 or param2 and the second can be either param3 or param4: MyCommand {param1 \| param2} {param3 \| param4} In the next example, the command can accept either two or three parameters. The first parameter must be param1. You can optionally include param2 as the second parameter. And the last parameter is either param3 or param4. MyCommand param1 [param2] {param3 \| param4}