:orphan:

.. title:: CONFIG_SHELL_HELP_OPT_PARSE

.. kconfig:: CONFIG_SHELL_HELP_OPT_PARSE

CONFIG_SHELL_HELP_OPT_PARSE
###########################

*Parse -h and --help options*

Type: ``bool``

Help
====

.. code-block:: none

    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
===================

\ :kconfig:`SHELL_HELP <CONFIG_SHELL_HELP>` && !\ :kconfig:`SHELL_GETOPT <CONFIG_SHELL_GETOPT>` && \ :kconfig:`SHELL <CONFIG_SHELL>`

*(Includes any dependencies from ifs and menus.)*

Default
=======

- y

Kconfig definition
==================



At ``<Zephyr Subsystem>/shell/Kconfig:160``

Included via ``Kconfig:8`` → ``Kconfig.zephyr:44`` → ``<Zephyr Subsystem>/Kconfig:45``

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

.. code-block:: kconfig

    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.)*