u-boot/doc/usage/cmd/cli.rst
Heinrich Schuchardt 60971e63e6 doc: create index entries for commands
Add the description of CLI commands to the generated index.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-01-17 08:40:19 +01:00

77 lines
1.3 KiB
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0+
.. index::
single: cli (command)
cli command
===========
Synopis
-------
::
cli get
cli set cli_flavor
Description
-----------
The cli command permits getting and changing the current parser at runtime.
cli get
~~~~~~~
It shows the current value of the parser used by the CLI.
cli set
~~~~~~~
It permits setting the value of the parser used by the CLI.
Possible values are old and modern.
Note that, to use a specific parser its code should have been compiled, that
is to say you need to enable the corresponding CONFIG_HUSH*.
Otherwise, an error message is printed.
Examples
--------
Get the current parser::
=> cli get
old
Change the current parser::
=> cli get
old
=> cli set modern
=> cli get
modern
=> cli set old
=> cli get
old
Trying to set the current parser to an unknown value::
=> cli set foo
Bad value for parser name: foo
cli - cli
Usage:
cli get - print current cli
set - set the current cli, possible values are: old, modern
Trying to set the current parser to a correct value but its code was not
compiled::
=> cli get
modern
=> cli set old
Want to set current parser to old, but its code was not compiled!
Return value
------------
The return value $? indicates whether the command succeeded.