]>
Commit | Line | Data |
---|---|---|
eeca220b | 1 | <?xml version='1.0'?> <!--*-nxml-*--> |
3a54a157 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
d9689a35 MY |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ |
4 | <!ENTITY % entities SYSTEM "custom-entities.ent" > | |
5 | %entities; | |
6 | ]> | |
db9ecf05 | 7 | <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> |
eeca220b | 8 | |
4623eecb AK |
9 | <refentry id="vconsole.conf" conditional='ENABLE_VCONSOLE' |
10 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
798d3a52 ZJS |
11 | <refentryinfo> |
12 | <title>vconsole.conf</title> | |
13 | <productname>systemd</productname> | |
798d3a52 ZJS |
14 | </refentryinfo> |
15 | ||
16 | <refmeta> | |
17 | <refentrytitle>vconsole.conf</refentrytitle> | |
18 | <manvolnum>5</manvolnum> | |
19 | </refmeta> | |
20 | ||
21 | <refnamediv> | |
22 | <refname>vconsole.conf</refname> | |
23 | <refpurpose>Configuration file for the virtual console</refpurpose> | |
24 | </refnamediv> | |
25 | ||
26 | <refsynopsisdiv> | |
27 | <para><filename>/etc/vconsole.conf</filename></para> | |
28 | </refsynopsisdiv> | |
29 | ||
30 | <refsect1> | |
31 | <title>Description</title> | |
32 | ||
33 | <para>The <filename>/etc/vconsole.conf</filename> file configures | |
34 | the virtual console, i.e. keyboard mapping and console font. It is | |
61eca97f MS |
35 | applied at boot by udev using <filename>90-vconsole.rules</filename> file. |
36 | You can safely mask this file if you want to avoid this kind of initialization. | |
61eca97f | 37 | </para> |
798d3a52 | 38 | |
49fddcd3 ZJS |
39 | <para>The format of <filename>vconsole.conf</filename> is a newline-separated list of environment-like |
40 | shell-compatible variable assignments, ignoring comments and empty lines. It is possible to source the | |
41 | configuration from shell scripts, however, beyond mere variable assignments no shell features are | |
42 | supported, allowing applications to read the file without implementing a shell compatible execution | |
43 | engine. See | |
44 | <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry> for a | |
45 | detailed description of the format.</para> | |
798d3a52 ZJS |
46 | |
47 | <para>Note that the kernel command line options | |
48 | <varname>vconsole.keymap=</varname>, | |
61eca97f | 49 | <varname>vconsole.keymap_toggle=</varname>, |
798d3a52 | 50 | <varname>vconsole.font=</varname>, |
61eca97f MS |
51 | <varname>vconsole.font_map=</varname>, |
52 | <varname>vconsole.font_unimap=</varname> may be used | |
798d3a52 ZJS |
53 | to override the console settings at boot.</para> |
54 | ||
55 | <para>Depending on the operating system other configuration files | |
56 | might be checked for configuration of the virtual console as well, | |
57 | however only as fallback.</para> | |
8968e36f ZJS |
58 | |
59 | <para><filename>/etc/vconsole.conf</filename> is usually created and updated | |
60 | using | |
61 | <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
62 | <citerefentry><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
63 | may be used to instruct <command>systemd-localed.service</command> to | |
64 | query or update configuration.</para> | |
798d3a52 ZJS |
65 | </refsect1> |
66 | ||
67 | <refsect1> | |
68 | <title>Options</title> | |
69 | ||
70 | <para>The following options are understood:</para> | |
71 | ||
833fc980 | 72 | <variablelist class='environment-variables'> |
798d3a52 ZJS |
73 | |
74 | <varlistentry> | |
75 | <term><varname>KEYMAP=</varname></term> | |
76 | <term><varname>KEYMAP_TOGGLE=</varname></term> | |
77 | ||
bf77d597 LP |
78 | <listitem><para>Configures the key mapping table for the keyboard. <varname>KEYMAP=</varname> |
79 | defaults to <literal>&DEFAULT_KEYMAP;</literal> if not set. Specially, if <literal>@kernel</literal> | |
80 | is specified, no keymap will be loaded, i.e. the kernel's default keymap is used. The | |
81 | <varname>KEYMAP_TOGGLE=</varname> can be used to configure a second toggle keymap and is by default | |
ef7f5baa | 82 | unset.</para></listitem> |
798d3a52 ZJS |
83 | </varlistentry> |
84 | ||
85 | <varlistentry> | |
86 | <term><varname>FONT=</varname></term> | |
87 | <term><varname>FONT_MAP=</varname></term> | |
88 | <term><varname>FONT_UNIMAP=</varname></term> | |
89 | ||
90 | <listitem><para>Configures the console font, the console map | |
91 | and the unicode font map.</para></listitem> | |
92 | </varlistentry> | |
93 | ||
94 | </variablelist> | |
95 | </refsect1> | |
96 | ||
72ccee50 ZJS |
97 | <refsect1> |
98 | <title>Kernel Command Line</title> | |
99 | ||
100 | <para>A few configuration parameters from <filename>vconsole.conf</filename> may be overridden | |
101 | on the kernel command line:</para> | |
102 | ||
103 | <variablelist class='kernel-commandline-options'> | |
104 | <varlistentry> | |
105 | <term><varname>vconsole.keymap=</varname></term> | |
106 | <term><varname>vconsole.keymap_toggle=</varname></term> | |
107 | ||
108 | <listitem><para>Overrides <varname>KEYMAP=</varname> and <varname>KEYMAP_TOGGLE=</varname>. | |
ec07c3c8 AK |
109 | </para> |
110 | ||
111 | <xi:include href="version-info.xml" xpointer="v232"/></listitem> | |
72ccee50 ZJS |
112 | </varlistentry> |
113 | <varlistentry> | |
114 | ||
115 | <term><varname>vconsole.font=</varname></term> | |
116 | <term><varname>vconsole.font_map=</varname></term> | |
117 | <term><varname>vconsole.font_unimap=</varname></term> | |
118 | ||
119 | <listitem><para>Overrides <varname>FONT=</varname>, <varname>FONT_MAP=</varname>, and | |
ec07c3c8 AK |
120 | <varname>FONT_UNIMAP=</varname>.</para> |
121 | ||
122 | <xi:include href="version-info.xml" xpointer="v232"/></listitem> | |
72ccee50 ZJS |
123 | </varlistentry> |
124 | </variablelist> | |
125 | </refsect1> | |
126 | ||
798d3a52 ZJS |
127 | <refsect1> |
128 | <title>Example</title> | |
129 | ||
130 | <example> | |
131 | <title>German keyboard and console</title> | |
132 | ||
133 | <para><filename>/etc/vconsole.conf</filename>:</para> | |
134 | ||
135 | <programlisting>KEYMAP=de-latin1 | |
25b47f96 | 136 | FONT=eurlatgr</programlisting> |
798d3a52 ZJS |
137 | </example> |
138 | ||
139 | </refsect1> | |
140 | ||
141 | <refsect1> | |
142 | <title>See Also</title> | |
143 | <para> | |
144 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
145 | <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
3ba3a79d ZJS |
146 | <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
147 | <citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
148 | <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
798d3a52 ZJS |
149 | <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> |
150 | </para> | |
151 | </refsect1> | |
eeca220b LP |
152 | |
153 | </refentry> |