Help¶

Shell parses command to find '-h' or '--help' string. If the shell
finds the string, it will automatically print a help message
for a command.

Direct dependencies¶

SHELL_HELP && !SHELL_GETOPT && SHELL

(Includes any dependencies from ifs and menus.)

Default¶

y

Kconfig definition¶

At <Zephyr>/subsys/shell/Kconfig:140

Included via <Zephyr>/Kconfig:8 → <Zephyr>/Kconfig.zephyr:34 → <Zephyr>/subsys/Kconfig:45

Menu path: (Top) → Sub Systems and OS Services → Shell → Enable help message

config SHELL_HELP_OPT_PARSE
    bool "Parse -h and --help options"
    default y
    depends on SHELL_HELP && !SHELL_GETOPT && SHELL
    help
      Shell parses command to find '-h' or '--help' string. If the shell
      finds the string, it will automatically print a help message
      for a command.

(The ‘depends on’ condition includes propagated dependencies from ifs and menus.)