Tivoli Header

Tivoli Storage Manager for UNIX Backup-Archive Clients Installation and User's Guide


Reading Syntax Diagrams

This section describes how to read the syntax diagrams used in this manual. To read a syntax diagram, follow the path of the line. Read from left to right, and top to bottom.

Syntax items, such as a keyword or variable, can be:


Syntax Diagram Description Example
Abbreviations:

Uppercase letters denote the shortest acceptable truncation. If an item appears entirely in uppercase letters, it cannot be truncated.

You can type the item in any combination of uppercase or lowercase letters.

In this example, you can enter KEYWO, KEYWORD, or KEYWOrd.

>>-KEYWOrd-----------------------------------------------------><
 
 
Symbols:

Enter these symbols exactly as they appear in the syntax diagram.

*
Asterisk
{ }
Braces
:
Colon
,
Comma
=
Equal Sign
-
Hyphen
()
Parentheses
.
Period
 
Space

Variables:

Italicized lowercase items (var_name) denote variables.

In this example, you can specify a var_name when you enter the KEYWORD command.

>>-KEYWOrd--var_name-------------------------------------------><
 
 
Repetition:

An arrow returning to the left means you can repeat the item.

A character or space within the arrow means you must separate repeated items with that character or space.

A footnote by the arrow references the number of times you can repeat the item.

   .--------.
   V        |
>>---repeat-+--------------------------------------------------><
 
 

   .-,------.
   V        |
>>---repeat-+--------------------------------------------------><
 
 

   .-------------.
   V        (1)  |
>>---repeat------+---------------------------------------------><
 
 

Notes:

  1. Specify repeat as many as 5 times.

Required Choices:

When two or more items are in a stack and one of them is on the line, you must specify one item.

In this example, you must choose A, B, or C.

>>-+-A-+-------------------------------------------------------><
   +-B-+
   '-C-'
 
 
Optional Choice:

When an item is below the line, that item is optional. In the first example, you can choose A or nothing at all.

When two or more items are in a stack below the line, all of them are optional. In the second example, you can choose A, B, C, or nothing at all.

>>-+---+-------------------------------------------------------><
   '-A-'
 
 

>>-+---+-------------------------------------------------------><
   +-A-+
   +-B-+
   '-C-'
 
 
Defaults:

Defaults are above the line. The default is selected unless you override it. You can override the default by including an option from the stack below the line.

In this example, A is the default. You can override A by choosing B or C. You can also specify the default explicitly.

   .-A-.
>>-+---+-------------------------------------------------------><
   +-B-+
   '-C-'
 
 
Repeatable Choices:

A stack of items followed by an arrow returning to the left means you can select more than one item or, in some cases, repeat a single item.

In this example, you can choose any combination of A, B, or C.

   .-------.
   V       |
>>---+-A-+-+---------------------------------------------------><
     +-B-+
     '-C-'
 
 
Syntax Fragments:

Some diagrams, because of their length, must fragment the syntax. The fragment name appears between vertical bars in the diagram. The expanded fragment appears between vertical bars in the diagram after a heading with the same fragment name.

>>-| The fragment name |---------------------------------------><
 
The fragment name
 
   .-A-.
|--+---+--------------------------------------------------------|
   +-B-+
   '-C-'
 
 


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]