diff options
| author | Heinrich Schuchardt | 2023-01-21 17:18:14 +0100 |
|---|---|---|
| committer | Heinrich Schuchardt | 2023-01-27 18:31:59 +0100 |
| commit | f4ece689dbc4dc8f07122e1420969b9db1d219d5 (patch) | |
| tree | 11dbe508aab968e7d59ed90f9af897c36a7cce29 /doc/usage/cmd | |
| parent | ebeb8d950559fbbc3660bd767d28e979ee6dc04b (diff) | |
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>
Diffstat (limited to 'doc/usage/cmd')
| -rw-r--r-- | doc/usage/cmd/font.rst | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/doc/usage/cmd/font.rst b/doc/usage/cmd/font.rst index 6fb08232703..8ba149d7599 100644 --- a/doc/usage/cmd/font.rst +++ b/doc/usage/cmd/font.rst @@ -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. |