help
Abstract
Displays “help” information about ODB commands, including descriptions of their purpose and syntax. The information may be a list that covers a specified category of commands, or more detailed information limited to a single specified command.
Syntax
help
help <category>
help <command>
| Argument | Type | Description |
|---|---|---|
<category> |
string | name of a command category A list of command categories is displayed by issuing the help command without arguments; the list of categories also appears below in the Example section. |
<command> |
string | name of an ODB command |
Details
Issuing the help command without arguments displays a list of command categories, which group ODB commands into overlapping lists based on the entities with which the commands are associated. Issuing the help command with a category name displays the category list. The basic category is a list of the most commonly used commands, and the “all” category is a comprehensive list of all ODB commands (note that this list is long, and will scroll the displaying window several times). All category lists are displayed in alphabetic order. There may also be custom categories. All custom categories appear after the standard command categories listed below. Issuing the help command with a command name displays detailed information on the specified command.
- all
- basic
- event
- memory
- misc
- object
- packet
- process
- stop
- trace
Example
ODB> help event
_______________________________________________________
List of event-related ODB commands
continue : continue event execution until breakpoint.
usage: continue
evprint : print specified pending events.
usage: evprint +<n> | all | #<sched_id> | <objref> | <objref> +<n> | @<time>[-<time>]
evstop : set breakpoint for specified event.
usage: evstop <exec_id> | #<sched_id> | +<n>
iciprint_ev : print ICI (if any) associated with current event.
usage: iciprint_ev
next : advance to some next event.
usage: next [<num_steps> | time]
ODB> help evstop
evstop : set breakpoint for specified event.
usage: evstop <exec_id> | #<sched_id> | +<n>
evstop options:
<exec_id> -- set breakpoint for event with specified execution ID
#<sched_id> -- set breakpoint for event with specified schedule ID
+<n> -- set breakpoint for nth next event
You can specify an arbitrary number of breakpoints at once.