blob: 8ba149d7599b54fc1c0691b690abd515a95ad0cd [file] [log] [blame]
Simon Glass9e972c32022-10-06 08:36:16 -06001.. SPDX-License-Identifier: GPL-2.0+:
2
3font command
4============
5
6Synopis
7-------
8
9::
10
11 font list
12 font select <name> [<size>]
13 font size <size>
14
Simon Glass9e972c32022-10-06 08:36:16 -060015Description
16-----------
17
18The *font* command allows selection of the font to use on the video console.
Heinrich Schuchardtc261faa2023-01-21 17:18:14 +010019This is available when the TrueType console is in use.
Simon Glass9e972c32022-10-06 08:36:16 -060020
21font list
22~~~~~~~~~
23
24This lists the available fonts, using the name of the font file in the build.
25
Simon Glass9e972c32022-10-06 08:36:16 -060026font select
27~~~~~~~~~~~
28
29This selects a new font and optionally changes the size.
30
Simon Glass9e972c32022-10-06 08:36:16 -060031font size
32~~~~~~~~~
33
34This changes the font size only.
35
Simon Glass9e972c32022-10-06 08:36:16 -060036Examples
37--------
38
39::
40
41 => font list
42 nimbus_sans_l_regular
43 cantoraone_regular
44 => font size 40
45 => font select cantoraone_regular 20
46 =>
Heinrich Schuchardtc261faa2023-01-21 17:18:14 +010047
48Configuration
49-------------
50
51The command is only available if CONFIG_CONSOLE_TRUETYPE=y.
52
53Return value
54------------
55
56The return value $? is 0 (true) if the command completes.
57The return value is 1 (false) if the command fails.