blob: 44a04f5d075e6e94f731a2edd01f44b6d5997822 [file] [log] [blame]
Simon Glass9e972c32022-10-06 08:36:16 -06001.. SPDX-License-Identifier: GPL-2.0+:
2
Heinrich Schuchardt1b0c3162024-01-14 14:53:13 +01003.. index::
4 single: font (command)
5
Simon Glass9e972c32022-10-06 08:36:16 -06006font command
7============
8
Heinrich Schuchardt44b09b32024-03-16 11:09:36 +01009Synopsis
10--------
Simon Glass9e972c32022-10-06 08:36:16 -060011
12::
13
14 font list
15 font select <name> [<size>]
Simon Glass4f0336d2024-01-07 17:14:54 -070016 font size [<size>]
Simon Glass9e972c32022-10-06 08:36:16 -060017
Simon Glass9e972c32022-10-06 08:36:16 -060018Description
19-----------
20
21The *font* command allows selection of the font to use on the video console.
Heinrich Schuchardtc261faa2023-01-21 17:18:14 +010022This is available when the TrueType console is in use.
Simon Glass9e972c32022-10-06 08:36:16 -060023
24font list
25~~~~~~~~~
26
27This lists the available fonts, using the name of the font file in the build.
28
Simon Glass9e972c32022-10-06 08:36:16 -060029font select
30~~~~~~~~~~~
31
32This selects a new font and optionally changes the size.
33
Simon Glass9e972c32022-10-06 08:36:16 -060034font size
35~~~~~~~~~
36
Simon Glass4f0336d2024-01-07 17:14:54 -070037This changes the font size only. With no argument it shows the current size.
Simon Glass9e972c32022-10-06 08:36:16 -060038
Simon Glass9e972c32022-10-06 08:36:16 -060039Examples
40--------
41
42::
43
44 => font list
45 nimbus_sans_l_regular
46 cantoraone_regular
Simon Glass4f0336d2024-01-07 17:14:54 -070047 => font size
48 30
Simon Glass9e972c32022-10-06 08:36:16 -060049 => font size 40
50 => font select cantoraone_regular 20
51 =>
Heinrich Schuchardtc261faa2023-01-21 17:18:14 +010052
53Configuration
54-------------
55
56The command is only available if CONFIG_CONSOLE_TRUETYPE=y.
57
58Return value
59------------
60
61The return value $? is 0 (true) if the command completes.
62The return value is 1 (false) if the command fails.