doc/usage/cmd/font.rst

   1 .. SPDX-License-Identifier: GPL-2.0+:
   2
   3 .. index::
   4    single: font (command)
   5
   6 font command
   7 ============
   8
   9 Synopis
  10 -------
  11
  12 ::
  13
  14     font list
  15     font select <name> [<size>]
  16     font size <size>
  17
  18 Description
  19 -----------
  20
  21 The *font* command allows selection of the font to use on the video console.
  22 This is available when the TrueType console is in use.
  23
  24 font list
  25 ~~~~~~~~~
  26
  27 This lists the available fonts, using the name of the font file in the build.
  28
  29 font select
  30 ~~~~~~~~~~~
  31
  32 This selects a new font and optionally changes the size.
  33
  34 font size
  35 ~~~~~~~~~
  36
  37 This changes the font size only.
  38
  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     =>
  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.