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