vconsole.conf(5) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | KERNEL COMMAND LINE | EXAMPLE | SEE ALSO | COLOPHON

VCONSOLE.CONF(5)              vconsole.conf             VCONSOLE.CONF(5)

NAME         top

       vconsole.conf - Configuration file for the virtual console

SYNOPSIS         top

       /etc/vconsole.conf

DESCRIPTION         top

       The /etc/vconsole.conf file configures the virtual console, i.e.
       keyboard mapping and console font. It is applied at boot by udev
       using 90-vconsole.rules file. You can safely mask this file if
       you want to avoid this kind of initialization.

       The format of vconsole.conf is a newline-separated list of
       environment-like shell-compatible variable assignments, ignoring
       comments and empty lines. It is possible to source the
       configuration from shell scripts, however, beyond mere variable
       assignments no shell features are supported, allowing
       applications to read the file without implementing a shell
       compatible execution engine. See os-release(5) for a detailed
       description of the format.

       Note that the kernel command line options vconsole.keymap=,
       vconsole.keymap_toggle=, vconsole.font=, vconsole.font_map=,
       vconsole.font_unimap= may be used to override the console
       settings at boot.

       Depending on the operating system other configuration files might
       be checked for configuration of the virtual console as well,
       however only as fallback.

       /etc/vconsole.conf is usually created and updated using
       systemd-localed.service(8).  localectl(1) may be used to instruct
       systemd-localed.service to query or update configuration.

OPTIONS         top

       The following options are understood:

       KEYMAP=, KEYMAP_TOGGLE=
           Configures the key mapping table for the keyboard.  KEYMAP=
           defaults to "us" if not set. Specially, if "@kernel" is
           specified, no keymap will be loaded, i.e. the kernel's
           default keymap is used. The KEYMAP_TOGGLE= can be used to
           configure a second toggle keymap and is by default unset.

       FONT=, FONT_MAP=, FONT_UNIMAP=
           Configures the console font, the console map and the unicode
           font map.

KERNEL COMMAND LINE         top

       A few configuration parameters from vconsole.conf may be
       overridden on the kernel command line:

       vconsole.keymap=, vconsole.keymap_toggle=
           Overrides KEYMAP= and KEYMAP_TOGGLE=.

           Added in version 232.

       vconsole.font=, vconsole.font_map=, vconsole.font_unimap=
           Overrides FONT=, FONT_MAP=, and FONT_UNIMAP=.

           Added in version 232.

EXAMPLE         top

       Example 1. German keyboard and console

       /etc/vconsole.conf:

           KEYMAP=de-latin1
           FONT=eurlatgr

SEE ALSO         top

       systemd(1), systemd-vconsole-setup.service(8), loadkeys(1),
       setfont(8), locale.conf(5), systemd-localed.service(8)

COLOPHON         top

       This page is part of the systemd (systemd system and service
       manager) project.  Information about the project can be found at
       ⟨http://www.freedesktop.org/wiki/Software/systemd⟩.  If you have
       a bug report for this manual page, see
       ⟨http://www.freedesktop.org/wiki/Software/systemd/#bugreports⟩.
       This page was obtained from the project's upstream Git repository
       ⟨https://github.com/systemd/systemd.git⟩ on 2024-06-14.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2024-06-13.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

systemd 257~devel                                       VCONSOLE.CONF(5)

Pages that refer to this page: localectl(1)systemd-firstboot(1)kernel-command-line(7)systemd.directives(7)systemd.index(7)systemd-localed.service(8)systemd-vconsole-setup.service(8)