Difuse/u-boot
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

doc: update font man-page

Browse source 
* 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>
This commit is contained in:
Heinrich Schuchardt 2023-01-21 17:18:14 +01:00
parent ebeb8d9505
commit f4ece689db
1 changed files with 12 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
doc/usage/cmd/font.rst
View file

@ -12,33 +12,27 @@ Synopis
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. This is the case when
`CONFIG_CONSOLE_TRUETYPE` is enabled.
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
--------
@ -50,3 +44,14 @@ Examples
=> 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.