Trace Facility Guide


About This Book

This document is for authorized service representatives and Tivoli Storage Manager development. The information contained in this document has not been submitted to any formal IBM test and is distributed AS IS. This document is not for customer use. The customer is responsible for using this information as it applies to their operational environment. IBM might review each item for accuracy in a specific situation. There is no guarantee that you will obtain simular results. Customers attempting to adapt these techniques to their own environments do so at their own risk.

If you run the trace facility on your system, you may receive output messages that are automatically generated by the process. You can ignore the output. The output is in a readable format so authorized users and service representatives can isolate problems.


Conventions Used in This Book

This book uses the following typographical conventions:

Figure 1. Typographical Conventions

Example Description
autoexec.ncf A series of lowercase letters with an extension indicates TSM program file names.
archive Boldface type indicates a command that you type at a workstation, such as a command you type on a command line.
dateformat Boldface italic type indicates a TSM option. The bold type is used to introduce the option, or in an example. All other times in the text it appears as regular font.

Occasionally, file names are entered in boldface italic for emphasis.

filespec Italicized type indicates either the name of a parameter, a new term, or a placeholder for information that you provide.

Italics are also used for emphasis in the text.

maxcmdretries Monospaced type represents fragments of a program or information as it would appear on a display screen.
plus sign (+) A plus sign between two keys indicates you should press both keys at the same time.

Reading Syntax Diagrams

This section describes how to read the syntax diagrams used in this book. 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--'
 


Related Publications

Included here is a list of the publications that are referred to in this manual.

Figure 2. TSM Client Publications

Short Title Publication Title Order Number
TSM Messages Tivoli Storage Manager Messages GC35-0382
TSM Installing the Clients Tivoli Storage Manager Installing the Clients SH26-4102
TSM for Microsoft Windows Using the Backup-Archive Clients Tivoli Storage Manager for Microsoft Windows Using the Backup-Archive Clients SH26-4101
TSM for Novell NetWare Using the Backup-Archive Client Tivoli Storage Manager for Novell NetWare Using the Backup-Archive Client SH26-4100
TSM for UNIX Using the Backup-Archive Clients Tivoli Storage Manager for UNIX Using the Backup-Archive Clients SH26-4105
Using the UNIX HSM Clients ADSTAR Distributed Storage Manager Using the UNIX Hierarchical Storage Management Clients SH26-4083
TSM AFS/DFS Backup Clients Tivoli Storage Manager AFS/DFS Backup Clients SH26-4106
Using the API Tivoli Storage Manager Using the Application Programming Interface SH26-4107
TSM Reference Cards for the Backup-Archive Clients Tivoli Storage Manager Reference Cards for the Backup-Archive Clients SX26-6021
TSM Trace Facility Guide Tivoli Storage Manager Trace Facility Guide SH26-4104
TSM for AIX Quick Start Tivoli Storage Manager for AIX Quick Start GC35-0367
TSM for AS/400 Quick Start Tivoli Storage Manager for AS/400 Quick Start GC35-0317
TSM for HP-UX Quick Start Tivoli Storage Manager for HP-UX Quick Start GC35-0370
TSM for MVS and OS/390 Quick Start Tivoli Storage Manager for MVS and OS/390 Quick Start GC35-0376
TSM for Sun Solaris Quick Start Tivoli Storage Manager for Sun Solaris Quick Start GC35-0373
TSM for Windows NT Quick Start Tivoli Storage Manager for Windows NT Quick Start GC35-0379

TSM publications are available in softcopy on the following CD-ROMs:

TSM publications are available in softcopy on the TSM Web site at the following URL:

http://www.tivoli.com/tsm

The IBM International Technical Support Center redbooks are available in softcopy on the IBM Redbooks Web site at the following URL:

http://www.redbooks.ibm.com

You can order hardcopies of all our publications from the IBM Direct Publications Catalog Web site at the following URL:

http://www.elink.ibmlink.ibm.com/pbl/pbl

Follow these links in the order given, making the appropriate choices when prompted:

  1. Select Country selection to choose your country.

  2. Select Language selection to choose your language.

  3. Select Search & index.

  4. Enter your search criteria. You can enter search words such as adsm or adstar to get a listing of all TSM manuals. You can also enter the order number or product number for the manuals in which you are interested.

  5. Select How to order.


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