get-simics-search-path – deprecated help-search
Simics Reference Manual  /  3 Commands  /  3.2 Command List  / 

help

Synopsis

help ["topic"]

Description

Prints help information on topic. topic can be a command, a class, an object, an interface, a module, a hap, an attribute or a function or type from the Simics API. Here are some usage examples of the help command:

simics> help print-time
[... print-time command documentation ...]

simics> help cpu0.disassemble
[... <processor>.disassemble command documentation ...]

simics> help <processor>.disassemble
[... <processor>.disassemble command documentation ...]

simics> help cpu0.core[0][0]
[... <x86QSP1> class documentation ...]

simics> help x86QSP1
[... <x86QSP1> class documentation ...]

simics> help processor
[... <processor> interface documentation ...]

simics> help x86QSP1.freq_mhz
[... <x86QSP1>.freq_mhz attribute documentation ...]

simics> help x86QSP1.msr_aperf
[... <x86QSP1>.msr_aperf attribute documentation ...]

simics> help Core_Exception
[... Core_Exception hap documentation ...]

simics> help SIM_get_mem_op_type
[... SIM_get_mem_op_type() function declaration ...]

simics> help script.simics
[... script parameter information from the script file script.simics ...]

To refine your search and improve the tab-completion choices, you may use filters in the topic as shown below:

help topic = command:break

The recognized filters are "api:", "attribute:", "category:", "class:", "command:", "hap:", "interface:", "module:", "notifier:", "object:", "script:", "target:".

By default, the help command does not provided tab-completion on topic for modules and api symbols unless the specific filter is provided.

Provided By

Simics Core

See Also

help-search, api-help, api-search
get-simics-search-path – deprecated help-search