man/vconsole.conf.xml

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