Guardian Disk and Tape Utilities Reference

Nonitalic text. Nonitalic letters, numbers, and punctuation indicate text that is displayed or returned

exactly as shown. For example:

Backup Up.

lowercase italic letters. Lowercase italic letters indicate variable items whose values are displayed

or returned. For example:

p-register

process-name

[ ] Brackets. Brackets enclose items that are sometimes, but not always, displayed. For example:

Event number = number [ Subject = first-subject-value ]

A group of items enclosed in brackets is a list of all possible items that can be displayed, of which

one or none might actually be displayed. The items in the list might be arranged either vertically,

with aligned brackets on each side of the list, or horizontally, enclosed in a pair of brackets and

separated by vertical lines. For example:

proc-name trapped [ in SQL | in SQL file system ]

{ } Braces. A group of items enclosed in braces is a list of all possible items that can be displayed,

of which one is actually displayed. The items in the list might be arranged either vertically, with

aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated

by vertical lines. For example:

obj-type obj-name state changed to state, caused by

{ Object | Operator | Service }

process-name State changed from old-objstate to objstate

{ Operator Request. }

| Vertical Line. A vertical line separates alternatives in a horizontal list that is enclosed in brackets

or braces. For example:

Transfer status: { OK | Failed }

% Percent Sign. A percent sign precedes a number that is not in decimal notation. The % notation

precedes an octal number. The %B notation precedes a binary number. The %H notation precedes

a hexadecimal number. For example:

%005400

%B101111

%H2F

P=%p-register E=%e-register

Notation for Management Programming Interfaces

This list summarizes the notation conventions used in the boxed descriptions of programmatic

commands, event messages, and error lists in this manual.

UPPERCASE LETTERS. Uppercase letters indicate names from definition files; enter these names

exactly as shown. For example:

ZCOM-TKN-SUBJ-SERV

lowercase letters. Words in lowercase letters are words that are part of the notation, including

Data Definition Language (DDL) keywords. For example:

token-type

!r. The !r notation following a token or field name indicates that the token or field is required. For

example:

ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. !r

!o. The !o notation following a token or field name indicates that the token or field is optional. For

example:

ZSPI-TKN-MANAGER token-type ZSPI-TYP-FNAME32. !o