1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
4 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
7 This file is part of systemd.
9 Copyright 2010 Lennart Poettering
11 systemd is free software; you can redistribute it and/or modify it
12 under the terms of the GNU Lesser General Public License as published by
13 the Free Software Foundation; either version 2.1 of the License, or
14 (at your option) any later version.
16 systemd is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 Lesser General Public License for more details.
21 You should have received a copy of the GNU Lesser General Public License
22 along with systemd; If not, see <http://www.gnu.org/licenses/>.
25 <refentry id="vconsole.conf" conditional='ENABLE_VCONSOLE'>
27 <title>vconsole.conf</title>
28 <productname>systemd</productname>
32 <contrib>Developer</contrib>
33 <firstname>Lennart</firstname>
34 <surname>Poettering</surname>
35 <email>lennart@poettering.net</email>
41 <refentrytitle>vconsole.conf</refentrytitle>
42 <manvolnum>5</manvolnum>
46 <refname>vconsole.conf</refname>
47 <refpurpose>Configuration file for the virtual console</refpurpose>
51 <para><filename>/etc/vconsole.conf</filename></para>
55 <title>Description</title>
57 <para>The <filename>/etc/vconsole.conf</filename> file
58 configures the virtual console, i.e. keyboard mapping
59 and console font. It is applied at boot by
60 <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
62 <para>The basic file format of the
63 <filename>vconsole.conf</filename> is a
64 newline-separated list of environment-like
65 shell-compatible variable assignments. It is possible
66 to source the configuration from shell scripts,
67 however, beyond mere variable assignments no shell
68 features are supported, allowing applications to read
69 the file without implementing a shell compatible
70 execution engine.</para>
72 <para>Note that the kernel command line options
73 <varname>vconsole.keymap=</varname>,
74 <varname>vconsole.keymap.toggle=</varname>,
75 <varname>vconsole.font=</varname>,
76 <varname>vconsole.font.map=</varname>,
77 <varname>vconsole.font.unimap=</varname> may be used
78 to override the console settings at boot.</para>
80 <para>Depending on the operating system other
81 configuration files might be checked for configuration
82 of the virtual console as well, however only as
87 <title>Options</title>
89 <para>The following options are understood:</para>
94 <term><varname>KEYMAP=</varname></term>
95 <term><varname>KEYMAP_TOGGLE=</varname></term>
97 <listitem><para>Configures the key
99 keyboard. <varname>KEYMAP=</varname>
100 defaults to <literal>us</literal> if
102 <varname>KEYMAP_TOGGLE=</varname> can
103 be used to configure a second toggle
104 keymap and is by default
105 unset.</para></listitem>
109 <term><varname>FONT=</varname></term>
110 <term><varname>FONT_MAP=</varname></term>
111 <term><varname>FONT_UNIMAP=</varname></term>
113 <listitem><para>Configures the console
114 font, the console map and the unicode
115 font map.</para></listitem>
122 <title>Example</title>
125 <title>German keyboard and console</title>
127 <para><filename>/etc/vconsole.conf</filename>:</para>
129 <programlisting>KEYMAP=de-latin1
130 FONT=latarcyrheb-sun16</programlisting>
136 <title>See Also</title>
138 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
139 <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
140 <citerefentry><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
141 <citerefentry><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
142 <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
143 <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>