15.00 - HELP - Teradata Database

Teradata Database Utilities

Product
Teradata Database
Release Number
15.00
Content Type
Configuration
Publication ID
B035-1102-015K
Language
English (United States)
Last Update
2018-09-25

HELP

Purpose  

Provides general help for DBS Control or detailed help if an option is specified.

Syntax  

 

Syntax element…

Specifies…

ALL

a composite of the other options and is used to display the entire DBS Control help text.

keyword

either a command name or a group name. A command name entry indicates which user-level command the HELP command is directed towards.

A group name entry indicates which group (GENERAL, FILESYS, PERFORMANCE, CHECKSUM, COMPRESSION, or STORAGE) the HELP command is directed towards.

You can type the first one or two characters of each keyword rather than the entire word.

Usage Notes  

If the options are omitted (that is, only HELP is specified), a brief introduction to DBS Control is displayed. If a keyword is specified, a detailed help display is provided.

Example  

The following example shows basic help:

Enter a command, HELP, or QUIT:
HELP
 
The DBS Control utility program provides a means to display and modify the fields of the DBS Control Record which is stored on the system as a Globally Distributed Object (GDO). The general command syntax is:
 
     <Command> [ <GroupName> ]
 
That is, a command followed by a group name (if any).
 
Valid commands are:
 
     DISPLAY, MODIFY, WRITE, HELP, and QUIT
 
Valid group names are:
 
     GENERAL, FILESYS, PERFORMANCE, and CHECKSUM
 
Note that all commands and groups may be abbreviated to their first unique character.
 
Enter "HELP <Command>" or "HELP <GroupName>" for detailed information on each command or group, respectively. Enter "HELP ALL" for the help text in its entirety.

Example  

The following example shows detailed help using the DISPLAY command:

Enter a command, HELP, or QUIT:
HELP DISPLAY
 
DISPLAY [ <GroupName> ]
 
o This command will display the values of the DBS Control Record fields. If a GroupName is provided, only the fields associated with the specified group will be   displayed. If GroupName is omitted, the values of all   fields will be displayed.
 
o Valid GroupNames are GENERAL, FILESYS, PERFORMANCE, and CHECKSUM. Enter "HELP <GroupName>" for additional information.