Oracle7 Administrator's Reference for UNIX

Contents Index Home Previous Next

Document Conventions

Conventions used in this document differ somewhat from those used in other Oracle documentation. Because UNIX is case-sensitive, commands and filenames are shown in boldface type, rather than uppercase letters.

Type Conventions

Following are the type conventions:

bold Boldface type indicates UNIX commands, directory names, pathnames, and filenames (for example, the prefs.ora file).
brackets [ ] Words enclosed in brackets indicate key names (for example, Press [Return]).
italics Italic type indicates a variable and is used for emphasis. It also indicates variable portions of filenames (for example, sgadefx.dbf).
UPPERCASE Uppercase letters indicate Oracle commands and environment variables (for example, ORACLE_HOME).

Command Syntax

Commands appear in monospace font. Enter information precisely as it appears. Following are the syntax conventions for commands:

backslash \ A backslash indicates a command line that is too long to fit on the printed page. Either enter the line as printed (with a backslash) or enter it as a single line without a backslash.
dd if=/dev/rdsk/c0t1d0s6 of=/dev/rst0 \ bs=10b count=10000
braces { } Braces indicate required items.
.DEFINE {macro1}
brackets [ ] Brackets indicate optional items.
cvtcrt termname [outfile]
ellipsis ... An ellipsis indicates an arbitrary number of similar items.
CHKVAL fieldname value1 value2 ... valueN
italics Italic type indicates a variable. Substitute a value for the variable.
library_name
vertical line | A vertical line indicates a choice within braces or brackets.
SIZE filesize [K|M]

Icons

The following icons appear in printed documentation. Icons do not appear in online documentation.

Attention: The attention icon indicates important additional information.

For Parallel Server: The OPS icon indicates information specific to the Oracle Parallel Server.

See Also: The book icon indicates a reference to another document, published either by Oracle Corporation or another organization. (The words "See Also" without an accompanying icon indicate a reference to another section of this document.)

Suggestion: The suggestion icon indicates recommendations or hints.

Warning: The warning icon indicates an action that could damage the system.

Other Conventions

The term "Oracle7 Server" refers to the database server product from Oracle Corporation.

The term "oracle" refers to an executable or account by that name.

The term "oracle" refers to the owner of the Oracle software.

Unless otherwise stated, examples use the Bourne shell (sh(1)) syntax.


Contents Index Home Previous Next