`Help`

Print this list OR usage for a specific command

Shortest form: h.

List commands with a one-line description each, or print the built-in usage of the named commands. Also reached as ??, and as ? with arguments. Read-only.

No argument: the commands common to all modes, the commands of the current mode and the commands added at run time, one per line with a short description, then a summary of number formats (0x hex, decimal, leading 0 octal, 0b binary). Aliases and hidden commands are left out.
Command names: the usage text of each. For an alias it first prints Usage (NAME): is an alias for "TARGET". An unknown name prints Usage: Command not found: NAME and the command fails.
print-manual: see below.

help looks a name up among the current mode’s commands before the common ones. Where a mode command has a matching shortest form, you get its usage instead. help set shows setreg, for example; set ? shows the usage of the command that actually runs.

Nothing is printed at all if the configuration variable help_cli_enable is set to 0.

Hardware-validated

drivshell> help
Help: Type help "command" for detailed command usage
Help: Upper case letters signify minimal match

Commands common to all modes:
     ?                   Display list of commands
     ASSert              Assert
     Attach              Attach SOC device(s)
     BackGround          Execute a command in the background.
     break               place to hang a breakpoint
     BroadSync           Manage Time API BroadSync endpoints
     CASE                Execute command based on string match
     CD                  Change current working directory
     cint                Enter the C interpreter
     ClearScreen         Clear terminal output
     CONFig              Configure Management interface
     CONSole             Control console options
     CoPy                Copy a file
     DATE                Set or display current date
     DeBug               Enable/Disable debug output
     DELAY               Put CLI task in a busy-wait loop for some amount of time
     DEVice              Device add/remove
     DISPatch            BCM Dispatch control.
     Echo                Echo command line
     EDK                 Start EDK-Host console
     EXIT                Exit the current shell (and possibly reset)
     EXPR                Evaluate infix expression
     FLASHINIT           Initialize on board flash as a file system
     FLASHSYNC           Sync up on board flash with file system
     FOR                 Execute a series of commands in a loop
     HAL                 Display current HAL resource usage
...

Hardware-validated

drivshell> help rcload
Usage (RCLoad): Parameters: <file> [parameters]
     Load commands from a file until the file is complete or an error
     occurs. If optional parameters are listed after <file> they are
     pushed as local variables for the file processing. For example:
              rcload fred a bc will result in the variables:
                     $1 = a
                     $2 = bc
             during processing of the file.
     For platforms where FTP is used, the user name, password and host
     may be specified as: "user%password@host:" as a prefix to the
     file name

help print-manual

Print the description and full usage of every command, hidden ones included. This runs to several thousand lines; with bcmcmd give it a long -t. The keyword must be spelt out and be the only argument. It is not mentioned in the built-in help.

Hardware-validated

drivshell> help print-manual

Commands common to all modes:

COMMAND: ?        Description: Display list of commands

Parameters: None
  Display a complete list of commands in a concise format.

COMMAND: ??       Description: @help

Parameters: [command] ...
  Display usage information for the listed commands.
  If no parameters given, a list of all commands is printed with
  a short description of the purpose of the command.

COMMAND: ASSert   Description: Assert

Parameters: None

COMMAND: Attach   Description: Attach SOC device(s)

Parameters: [Unit #] ...
  If no parameters are given, a current list of attached devices
  is printed. Otherwise, each parameter is considered a unit # and
  an attempt is made to attached it.

...

Built-in help

Parameters: [command] ...
    Display usage information for the listed commands.
    If no parameters given, a list of all commands is printed with
    a short description of the purpose of the command.

Help

`Help`