1 <?xml version='
1.0'
?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 SPDX-License-Identifier: LGPL-2.1+
9 <refentry id=
"vconsole.conf" conditional='ENABLE_VCONSOLE'
>
11 <title>vconsole.conf
</title>
12 <productname>systemd
</productname>
16 <contrib>Developer
</contrib>
17 <firstname>Lennart
</firstname>
18 <surname>Poettering
</surname>
19 <email>lennart@poettering.net
</email>
25 <refentrytitle>vconsole.conf
</refentrytitle>
26 <manvolnum>5</manvolnum>
30 <refname>vconsole.conf
</refname>
31 <refpurpose>Configuration file for the virtual console
</refpurpose>
35 <para><filename>/etc/vconsole.conf
</filename></para>
39 <title>Description
</title>
41 <para>The
<filename>/etc/vconsole.conf
</filename> file configures
42 the virtual console, i.e. keyboard mapping and console font. It is
43 applied at boot by udev using
<filename>90-vconsole.rules
</filename> file.
44 You can safely mask this file if you want to avoid this kind of initialization.
47 <para>The basic file format of the
48 <filename>vconsole.conf
</filename> is a newline-separated list of
49 environment-like shell-compatible variable assignments. It is
50 possible to source the configuration from shell scripts, however,
51 beyond mere variable assignments no shell features are supported,
52 allowing applications to read the file without implementing a
53 shell compatible execution engine.
</para>
55 <para>Note that the kernel command line options
56 <varname>vconsole.keymap=
</varname>,
57 <varname>vconsole.keymap_toggle=
</varname>,
58 <varname>vconsole.font=
</varname>,
59 <varname>vconsole.font_map=
</varname>,
60 <varname>vconsole.font_unimap=
</varname> may be used
61 to override the console settings at boot.
</para>
63 <para>Depending on the operating system other configuration files
64 might be checked for configuration of the virtual console as well,
65 however only as fallback.
</para>
67 <para><filename>/etc/vconsole.conf
</filename> is usually created and updated
69 <citerefentry><refentrytitle>systemd-localed.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
70 <citerefentry><refentrytitle>localectl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
71 may be used to instruct
<command>systemd-localed.service
</command> to
72 query or update configuration.
</para>
76 <title>Options
</title>
78 <para>The following options are understood:
</para>
83 <term><varname>KEYMAP=
</varname></term>
84 <term><varname>KEYMAP_TOGGLE=
</varname></term>
86 <listitem><para>Configures the key mapping table for the keyboard.
87 <varname>KEYMAP=
</varname> defaults to
<literal>us
</literal> if not set. The
88 <varname>KEYMAP_TOGGLE=
</varname> can be used to configure a second toggle keymap and is by
89 default unset.
</para></listitem>
93 <term><varname>FONT=
</varname></term>
94 <term><varname>FONT_MAP=
</varname></term>
95 <term><varname>FONT_UNIMAP=
</varname></term>
97 <listitem><para>Configures the console font, the console map
98 and the unicode font map.
</para></listitem>
105 <title>Kernel Command Line
</title>
107 <para>A few configuration parameters from
<filename>vconsole.conf
</filename> may be overridden
108 on the kernel command line:
</para>
110 <variablelist class='kernel-commandline-options'
>
112 <term><varname>vconsole.keymap=
</varname></term>
113 <term><varname>vconsole.keymap_toggle=
</varname></term>
115 <listitem><para>Overrides
<varname>KEYMAP=
</varname> and
<varname>KEYMAP_TOGGLE=
</varname>.
120 <term><varname>vconsole.font=
</varname></term>
121 <term><varname>vconsole.font_map=
</varname></term>
122 <term><varname>vconsole.font_unimap=
</varname></term>
124 <listitem><para>Overrides
<varname>FONT=
</varname>,
<varname>FONT_MAP=
</varname>, and
125 <varname>FONT_UNIMAP=
</varname>.
</para></listitem>
131 <title>Example
</title>
134 <title>German keyboard and console
</title>
136 <para><filename>/etc/vconsole.conf
</filename>:
</para>
138 <programlisting>KEYMAP=de-latin1
139 FONT=eurlatgr
</programlisting>
145 <title>See Also
</title>
147 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
148 <citerefentry><refentrytitle>systemd-vconsole-setup.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
149 <citerefentry project='mankier'
><refentrytitle>loadkeys
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
150 <citerefentry project='die-net'
><refentrytitle>setfont
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
151 <citerefentry project='man-pages'
><refentrytitle>locale.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
152 <citerefentry><refentrytitle>systemd-localed.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>