[Contents] [Index] [Next] [Previous]

Typographic and Keying Conventions


This document uses the following typographic conventions:

Text like this
indicates system element names such as menu selections, buttons and function names. This text style is also used to indicate the first use of a term included in the glossary.
Text like this
indicates words or characters representing variable values that you must supply.
Text like this
indicates system elements you must use literally, such as pathnames, commands and flags.
[ ]
Brackets enclose optional items in format and syntax descriptions.
{ }
Braces enclose a list from which you must choose an item in format and syntax descriptions.
|
A vertical bar separates items in a list of choices.
,
Buttons like this refer to standard keys on the OSF/Motif model keyboard.
< >
Angle brackets enclose the name of additional keys on the OSF/Motif model keyboard.
...
Horizontal ellipsis points indicate that you can repeat the preceding item one or more times.

This document uses the following keying conventions:

x or
x
A control character sequence. For example, c means that you hold down the control key while pressing c.
The key on your terminal or workstation that is labeled with the word Return or Enter, or with a left arrow.

Entering commands

When instructed to enter a command, type the command name and then press . For example, the instruction "Enter the ls command" means that you type the ls command and then press .

Componenents of the OSF/Motif user interface are represented by capital letters on each major word of the component, such as PushButton.

Keyboard Conventions

Since not all keyboards are the same, it is difficult to give style guidelines that are correct for every manufacturer's keyboard. To solve this problem, this guide describes keys using a model keyboard mechanism. Wherever keyboard input is specified, the keys are indicated by the engraving they have on the OSF/Motif model keyboard. The model keyboard does not correspond directly to any existing keyboard, rather it assumes a keyboard with an ideal set of keys.

In addition to the standard letter, number, and character keys, the OSF/Motif model keyboard is composed of the following special keys:

The OSF/Motif model keyboard also contains the following optional keys, which, although useful, are either not necessary or can be created by combinations of other keys:

Throughout this guide, behavior is described in terms of model keyboard keys. When a behavior takes advantage of an optional key from the model keyboard, it is also described in terms of the required special keys. Each of the keys described on the OSF/Motif model keyboard is available either as specified or by using other keys or key combinations if the specified key is unavailable. A few of the more important alternatives are described here for your convenience.

Mouse Conventions

On most systems, the mouse has either 2 buttons or 3 buttons. This guide assumes a 3-button mouse. Button 1 refers to the leftmost button. Button 2 refers to the middle button. Button 3 refers to the rightmost button. In general, you use Button 1 for selecting an item, Button 2 for data transfer, and Button 3 for popup menus. The functions associated with mouse buttons, however, can be reassigned. Check with your system administrator if you find that the mouse button actions do not correspond to the actions described in this guide.