<?xml version='1.0'?> <!--*-nxml-*-->

<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"

"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<refentry id="vconsole.conf" conditional='ENABLE_VCONSOLE'>

<refentryinfo>

<title>vconsole.conf</title>

<productname>systemd</productname>

<authorgroup>

<author>

<contrib>Developer</contrib>

<firstname>Lennart</firstname>

<surname>Poettering</surname>

<email>lennart@poettering.net</email>

</author>

</authorgroup>

</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

<citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>

<para>The basic file format of the

<filename>vconsole.conf</filename> is a newline-separated list of

environment-like shell-compatible variable assignments. 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.</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>

</refsect1>

<refsect1>

<title>Options</title>

<para>The following options are understood:</para>

<variablelist>

<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>us</literal> if not set. 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>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><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>,

<citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,

<citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>

</para>

</refsect1>

</refentry>