summaryrefslogtreecommitdiff
path: root/doc/usage/cmd/font.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/usage/cmd/font.rst')
-rw-r--r--doc/usage/cmd/font.rst52
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/usage/cmd/font.rst b/doc/usage/cmd/font.rst
new file mode 100644
index 00000000000..6fb08232703
--- /dev/null
+++ b/doc/usage/cmd/font.rst
@@ -0,0 +1,52 @@
+.. 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. This is the case when
+`CONFIG_CONSOLE_TRUETYPE` is enabled.
+
+
+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
+ =>