Open Menu / doc / usage / cmd / font.rst
Loading...
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
.. SPDX-License-Identifier: GPL-2.0+:

.. index::
   single: font (command)

font command
============

Synopsis
--------

::

    font list
    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.

font list
~~~~~~~~~

This lists the available fonts, using the name of the font file in the build.
Any enabled bitmap fonts are listed as well.

font select
~~~~~~~~~~~

This selects a new font and optionally changes the size. If the name is not
provided, the default font is used.

font size
~~~~~~~~~

This changes the font size only. With no argument it shows the current size.

Examples
--------

::

    => font list
    nimbus_sans_l_regular
    cantoraone_regular
    => font size
    30
    => font size 40
    => font select cantoraone_regular 20
    =>

This shows an example of selecting a bitmap font Truetype is active::

    => font list
    8x16
    12x22
    nimbus_sans_l_regular
    cantoraone_regular
    => font sel 8x16


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.