u-boot/doc/usage/cmd/coninfo.rst
Heinrich Schuchardt 5eed4a1ed7 doc: coninfo man-page
Provide a man-page for the coninfo command.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-04-08 07:44:33 +02:00

55 lines
1 KiB
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0+:
coninfo command
===============
Synopsis
--------
::
coninfo
Description
-----------
The coninfo command provides a list of available console input and output
devices and their assignment as stdin, stdout, stderr console devices.
If CONFIG_SYS_CONSOLE_IS_IN_ENV=y, the assignment is controlled by the
environment variables stdin, stdout, stderr which contain a comma separated
list of device names.
Example
--------
.. code-block:: console
=> coninfo
List of available devices
|-- pl011@9000000 (IO)
| |-- stdin
| |-- stdout
| |-- stderr
|-- serial (IO)
|-- usbkbd (I)
=> setenv stdin pl011@9000000,usbkbd
=> coninfo
List of available devices
|-- pl011@9000000 (IO)
| |-- stdin
| |-- stdout
| |-- stderr
|-- serial (IO)
|-- usbkbd (I)
| |-- stdin
Configuration
-------------
The coninfo command is only available if CONFIG_CMD_CONSOLE=y.
Return value
------------
The return value $? is always 0 (true).