Background documentationhelp Locate this document in the navigation structure

 

With this command you can display a list of all DBM commands. By specifying options, you can limit the list displayed.

Information is displayed on the required syntax, the optional and/or required DBM options, and whether a database or service session is required for executing the command.

For obsolete commands, references to the new names of the commands are given.

Reply lines with more than 80 characters are split.

Prerequisites

You do not need to log on to Database Manager to execute this DBM command.

Structure

help [<option>]

<option>::= <string> | <fuzzy_option> | <obsolete_option>

<fuzzy_option>:: = -k <string>

<obsolete_option>:: = -obsolete [<string>]

Options

Option

Description

<string>

Character string

Only the current DBM commands that start with the specified character string are displayed.

-k <string>

Error-tolerant search for a character string in the DBM command

-obsolete [<string>]

Only obsolete DBM commands are displayed

The system also displays the current name for each of these commands.

If you specify a character string, the display is limited to those obsolete DBM commands that contain this character string.

If you do not specify a character string, all obsolete DBM commands are displayed.

Result

OK

<dbm_command> <description>

<dbm_command> <description>

...

Values for the Reply Fields

Value

Description

<dbm_command>

DBM command

<description>

Description of the DBM command, the possible options, and their use

For obsolete DBM commands, the currently valid command is displayed

Example

Call Database Manager CLI, display all valid DBM commands:

>dbmcli help

OK

apropos <command_name_part>

archive_stage <medium> <stage> [verify|noverify] [remove|keep]

[FileNumberList <list>]

archive_stage_repeat <medium> [verify|noverify] [remove|keep]

auto_extend <mode> [<percentage>]

autolog_cancel

autolog_off

autolog_on [<medium>]

autolog_show

autorecover [LOG] [UNTIL <date> <time>] [ ( KEY <key> LABEL

<label> ) | ( IBID <internal_backup_ID> ) ]

auto_update_statistics <mode>

backup_cancel (needs backup session)

backup_ext_ids_forget

...

...

Call the Database Manager CLI, display all the DBM commands that contain the character string shm:

>dbmcli help –k shm

OK

dbm_shm_info

dbm_shm_reset

dbm_shm_unlock

Call Database Manager CLI, display all obsolete DBM commands that contain the character string recover:

>dbmcli help –obsolete recover

OK

recover_devspace (obsolete version of recover_volume)