summaryrefslogtreecommitdiff
path: root/doc/usage/cmd/font.rst
blob: 8ba149d7599b54fc1c0691b690abd515a95ad0cd (plain)
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
.. SPDX-License-Identifier: GPL-2.0+:

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

Synopis
-------

::

    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.

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

This selects a new font and optionally changes the size.

font size
~~~~~~~~~

This changes the font size only.

Examples
--------

::

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

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.