| Simon Glass | 9e972c3 | 2022-10-06 08:36:16 -0600 | [diff] [blame] | 1 | .. SPDX-License-Identifier: GPL-2.0+: |
| 2 | |
| Heinrich Schuchardt | 1b0c316 | 2024-01-14 14:53:13 +0100 | [diff] [blame] | 3 | .. index:: |
| 4 | single: font (command) |
| 5 | |
| Simon Glass | 9e972c3 | 2022-10-06 08:36:16 -0600 | [diff] [blame] | 6 | font command |
| 7 | ============ |
| 8 | |
| Heinrich Schuchardt | 44b09b3 | 2024-03-16 11:09:36 +0100 | [diff] [blame] | 9 | Synopsis |
| 10 | -------- |
| Simon Glass | 9e972c3 | 2022-10-06 08:36:16 -0600 | [diff] [blame] | 11 | |
| 12 | :: |
| 13 | |
| 14 | font list |
| 15 | font select <name> [<size>] |
| 16 | font size <size> |
| 17 | |
| Simon Glass | 9e972c3 | 2022-10-06 08:36:16 -0600 | [diff] [blame] | 18 | Description |
| 19 | ----------- |
| 20 | |
| 21 | The *font* command allows selection of the font to use on the video console. |
| Heinrich Schuchardt | c261faa | 2023-01-21 17:18:14 +0100 | [diff] [blame] | 22 | This is available when the TrueType console is in use. |
| Simon Glass | 9e972c3 | 2022-10-06 08:36:16 -0600 | [diff] [blame] | 23 | |
| 24 | font list |
| 25 | ~~~~~~~~~ |
| 26 | |
| 27 | This lists the available fonts, using the name of the font file in the build. |
| 28 | |
| Simon Glass | 9e972c3 | 2022-10-06 08:36:16 -0600 | [diff] [blame] | 29 | font select |
| 30 | ~~~~~~~~~~~ |
| 31 | |
| 32 | This selects a new font and optionally changes the size. |
| 33 | |
| Simon Glass | 9e972c3 | 2022-10-06 08:36:16 -0600 | [diff] [blame] | 34 | font size |
| 35 | ~~~~~~~~~ |
| 36 | |
| 37 | This changes the font size only. |
| 38 | |
| Simon Glass | 9e972c3 | 2022-10-06 08:36:16 -0600 | [diff] [blame] | 39 | Examples |
| 40 | -------- |
| 41 | |
| 42 | :: |
| 43 | |
| 44 | => font list |
| 45 | nimbus_sans_l_regular |
| 46 | cantoraone_regular |
| 47 | => font size 40 |
| 48 | => font select cantoraone_regular 20 |
| 49 | => |
| Heinrich Schuchardt | c261faa | 2023-01-21 17:18:14 +0100 | [diff] [blame] | 50 | |
| 51 | Configuration |
| 52 | ------------- |
| 53 | |
| 54 | The command is only available if CONFIG_CONSOLE_TRUETYPE=y. |
| 55 | |
| 56 | Return value |
| 57 | ------------ |
| 58 | |
| 59 | The return value $? is 0 (true) if the command completes. |
| 60 | The return value is 1 (false) if the command fails. |