u-boot/doc/usage/cmd/font.rst
Heinrich Schuchardt f4ece689db doc: update font man-page
* add return values
* move configuration to separate section to match other man-pages
* fix typo

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
2023-01-27 18:31:59 +01:00

57 lines
936 B
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0+:
font command
============
Synopis
-------
::
font list
font select <name> [<size>]
font size <size>
Description
-----------
The *font* command allows selection of the font to use on the video console.
This is available when the TrueType console is in use.
font list
~~~~~~~~~
This lists the available fonts, using the name of the font file in the build.
font select
~~~~~~~~~~~
This selects a new font and optionally changes the size.
font size
~~~~~~~~~
This changes the font size only.
Examples
--------
::
=> font list
nimbus_sans_l_regular
cantoraone_regular
=> font size 40
=> font select cantoraone_regular 20
=>
Configuration
-------------
The command is only available if CONFIG_CONSOLE_TRUETYPE=y.
Return value
------------
The return value $? is 0 (true) if the command completes.
The return value is 1 (false) if the command fails.