HP 3000 Manuals HP 3000 Manuals
The HELP Command
A HELP command provides a quick reference to SDMAIN commands. You can
use the HELP command to receive the following information:
* A list of all available commands
* A list of valid subcommands for a particular command
* The syntax for a particular command
* The definition of a macro
HELP Command Environments
What you see after you issue the HELP command depends upon the state of
the dictionary when you ask for help. There are three different criteria
that affect the responses to the HELP command:
* The mode in which the dictionary is open
* Whether or not a START command has been issued
* Whether the dictionary is a compiled or master dictionary
Before the Dictionary is Opened. Before the dictionary is opened, you
cannot use any of the dictionary structure, data maintenance, or
reporting commands, but you can use the environment commands such as
DEFINE, CONFIGURE, SHOW, etc.
After the Dictionary is Opened. The dictionary may be opened in any of
five different modes. These modes are:
* Customization
* Exclusive-update
* Shared-update
* Read-only
* Read-allow-read
In addition, a sixth mode is possible if the dictionary is open in either
exclusive update or shared update mode, and a START/SAVE command pair is
active. These modes determine what commands you are able to use within
SDMAIN,and what commands are displayed when you specify the HELP command.
Customization Mode. When the dictionary is open in customization mode,
only environment commands and structure commands are allowed. You have
exclusive access to the dictionary and no one else can use it.
Exclusive-Update Mode. When the dictionary is open in exclusive-update
mode, you may use the data maintenance commands to create and maintain
data occurrences. You can also use the dictionary environment and
dictionary reporting commands. You have exclusive access and no one else
can have the use of the dictionary while you are using it.
Shared-Update Mode. In shared-update mode, you may use the data
maintenance commands to create and maintain data occurrences. You can
also use the dictionary environment and dictionary reporting commands.
As the name implies, others may also share the use of the dictionary.
Read-Only Mode. When the dictionary is open in read-only mode, you may
use the dictionary environment and dictionary reporting commands. The
read-only mode also allows other users to share the use of the
dictionary.
Read-Allow-Read Mode. When the dictionary is open in read-allow-read
mode, you may use the dictionary environment and dictionary reporting
commands. The read-allow-read mode allows other users to access the
dictionary for reading only.
The START/SAVE Reporting Command Pair. When a START/SAVE command pair is
active, you may use only commands involved with building a stored report.
Restrictions on whether other users can access the dictionary depend on
the open mode:
* Exclusive Update--No one else can access the dictionary
* Shared Update--Other users can access the dictionary
Compiled or Master Dictionary. If you are working with a compiled
dictionary, you are not allowed to modify the dictionary. You may use
only the environment and reporting commands.
HELP Examples
In addition to a complete list of available commands, you can also use
the HELP command to get the following types of information:
* A list of valid subcommands for a command. (See Example 1 below.)
* A detailed description of a specific command. (See Example 2 below.)
* A list of a user-defined macro.
You can use abbreviations for both the commands and subcommands. The
examples below show the kinds of information displayed in the first two
cases.
Example 1 - HELP CREATE.
>HELP CREATE
The output of the above command (entered in the shared-update mode) is as
follows:
CREATE - Create a new object
subcommands:
DOMAIN <D > - Create a new domain
ENTITY <E > - Create a new entity
RELATIONSHIP <R > - Create a new relationship
SCOPE <S > - Create a new scope
SYNONYM <SYN> - Create a new synonym
VERSION <V > - Create a new version
Enter 'HELP CREATE subcommand-name' for more information
Example 2 - HELP CREATE ENTITY.
>HELP CREATE ENTITY
The output of the above command (entered in Shared-Update mode) is as
follows:
CREATE ENTITY - Create a new entity
SYNTAX: CREATE<C> ENTITY<E> entity-name
[;INTERNAL<INT> = internal-name]
;ENTITY-TYPE<ET> = entity-type-name
[;ATTRIBUTE-LIST<AL> = ([attribute-name1=[attribute-value1]]
[,attribute-name2=[attribute-value2]]
.
.
.
[,attribute-nameN=[attribute-valueN]])]
[;COMMON<C> = common-entity-name]