mirror of
https://github.com/u-boot/u-boot.git
synced 2025-04-28 08:35:38 +00:00
doc: coninfo man-page
Provide a man-page for the coninfo command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
This commit is contained in:
parent
dc3e41ec59
commit
5eed4a1ed7
2 changed files with 56 additions and 0 deletions
55
doc/usage/cmd/coninfo.rst
Normal file
55
doc/usage/cmd/coninfo.rst
Normal file
|
@ -0,0 +1,55 @@
|
||||||
|
.. 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).
|
|
@ -39,6 +39,7 @@ Shell commands
|
||||||
cmd/cbsysinfo
|
cmd/cbsysinfo
|
||||||
cmd/cls
|
cmd/cls
|
||||||
cmd/cmp
|
cmd/cmp
|
||||||
|
cmd/coninfo
|
||||||
cmd/conitrace
|
cmd/conitrace
|
||||||
cmd/cyclic
|
cmd/cyclic
|
||||||
cmd/dm
|
cmd/dm
|
||||||
|
|
Loading…
Add table
Reference in a new issue