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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % entities SYSTEM "custom-entities.ent" >
%entities;
]>
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
<refentry id="vconsole.conf" conditional='ENABLE_VCONSOLE'
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>vconsole.conf</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>vconsole.conf</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>vconsole.conf</refname>
<refpurpose>Configuration file for the virtual console</refpurpose>
</refnamediv>
<refsynopsisdiv>
<para><filename>/etc/vconsole.conf</filename></para>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>The <filename>/etc/vconsole.conf</filename> file configures
the virtual console, i.e. keyboard mapping and console font. It is
applied at boot by udev using <filename>90-vconsole.rules</filename> file.
You can safely mask this file if you want to avoid this kind of initialization.
</para>
<para>The format of <filename>vconsole.conf</filename> 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
<citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry> for a
detailed description of the format.</para>
<para>Note that the kernel command line options
<varname>vconsole.keymap=</varname>,
<varname>vconsole.keymap_toggle=</varname>,
<varname>vconsole.font=</varname>,
<varname>vconsole.font_map=</varname>,
<varname>vconsole.font_unimap=</varname> may be used
to override the console settings at boot.</para>
<para>Depending on the operating system other configuration files
might be checked for configuration of the virtual console as well,
however only as fallback.</para>
<para><filename>/etc/vconsole.conf</filename> is usually created and updated
using
<citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
<citerefentry><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
may be used to instruct <command>systemd-localed.service</command> to
query or update configuration.</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist class='environment-variables'>
<varlistentry>
<term><varname>KEYMAP=</varname></term>
<term><varname>KEYMAP_TOGGLE=</varname></term>
<listitem><para>Configures the key mapping table for the keyboard. <varname>KEYMAP=</varname>
defaults to <literal>&DEFAULT_KEYMAP;</literal> if not set. Specially, if <literal>@kernel</literal>
is specified, no keymap will be loaded, i.e. the kernel's default keymap is used. The
<varname>KEYMAP_TOGGLE=</varname> can be used to configure a second toggle keymap and is by default
unset.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>FONT=</varname></term>
<term><varname>FONT_MAP=</varname></term>
<term><varname>FONT_UNIMAP=</varname></term>
<listitem><para>Configures the console font, the console map
and the unicode font map.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Kernel Command Line</title>
<para>A few configuration parameters from <filename>vconsole.conf</filename> may be overridden
on the kernel command line:</para>
<variablelist class='kernel-commandline-options'>
<varlistentry>
<term><varname>vconsole.keymap=</varname></term>
<term><varname>vconsole.keymap_toggle=</varname></term>
<listitem><para>Overrides <varname>KEYMAP=</varname> and <varname>KEYMAP_TOGGLE=</varname>.
</para>
<xi:include href="version-info.xml" xpointer="v232"/></listitem>
</varlistentry>
<varlistentry>
<term><varname>vconsole.font=</varname></term>
<term><varname>vconsole.font_map=</varname></term>
<term><varname>vconsole.font_unimap=</varname></term>
<listitem><para>Overrides <varname>FONT=</varname>, <varname>FONT_MAP=</varname>, and
<varname>FONT_UNIMAP=</varname>.</para>
<xi:include href="version-info.xml" xpointer="v232"/></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Example</title>
<example>
<title>German keyboard and console</title>
<para><filename>/etc/vconsole.conf</filename>:</para>
<programlisting>KEYMAP=de-latin1
FONT=eurlatgr</programlisting>
</example>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>
|
