man/vconsole.conf.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   4 <!ENTITY % entities SYSTEM "custom-entities.ent" >
   5 %entities;
   6 ]>
   7 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   8
   9 <refentry id="vconsole.conf" conditional='ENABLE_VCONSOLE'>
  10   <refentryinfo>
  11     <title>vconsole.conf</title>
  12     <productname>systemd</productname>
  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
  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.
  36     </para>
  37
  38     <para>The format of <filename>vconsole.conf</filename> is a newline-separated list of environment-like
  39     shell-compatible variable assignments, ignoring comments and empty lines. It is possible to source the
  40     configuration from shell scripts, however, beyond mere variable assignments no shell features are
  41     supported, allowing applications to read the file without implementing a shell compatible execution
  42     engine. See
  43     <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry> for a
  44     detailed description of the format.</para>
  45
  46     <para>Note that the kernel command line options
  47     <varname>vconsole.keymap=</varname>,
  48     <varname>vconsole.keymap_toggle=</varname>,
  49     <varname>vconsole.font=</varname>,
  50     <varname>vconsole.font_map=</varname>,
  51     <varname>vconsole.font_unimap=</varname> may be used
  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>
  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>
  64   </refsect1>
  65
  66   <refsect1>
  67     <title>Options</title>
  68
  69     <para>The following options are understood:</para>
  70
  71     <variablelist class='environment-variables'>
  72
  73       <varlistentry>
  74         <term><varname>KEYMAP=</varname></term>
  75         <term><varname>KEYMAP_TOGGLE=</varname></term>
  76
  77         <listitem><para>Configures the key mapping table for the keyboard.
  78         <varname>KEYMAP=</varname> defaults to <literal>&DEFAULT_KEYMAP;</literal> if not set. Specially,
  79         if <literal>kernel</literal> is specified, no keymap will be loaded, i.e. the kernel keymap is used.
  80         The <varname>KEYMAP_TOGGLE=</varname> can be used to configure a second toggle keymap and is by default
  81         unset.</para></listitem>
  82       </varlistentry>
  83
  84       <varlistentry>
  85         <term><varname>FONT=</varname></term>
  86         <term><varname>FONT_MAP=</varname></term>
  87         <term><varname>FONT_UNIMAP=</varname></term>
  88
  89         <listitem><para>Configures the console font, the console map
  90         and the unicode font map.</para></listitem>
  91       </varlistentry>
  92
  93     </variablelist>
  94   </refsect1>
  95
  96   <refsect1>
  97     <title>Kernel Command Line</title>
  98
  99     <para>A few configuration parameters from <filename>vconsole.conf</filename> may be overridden
 100     on the kernel command line:</para>
 101
 102     <variablelist class='kernel-commandline-options'>
 103       <varlistentry>
 104         <term><varname>vconsole.keymap=</varname></term>
 105         <term><varname>vconsole.keymap_toggle=</varname></term>
 106
 107         <listitem><para>Overrides <varname>KEYMAP=</varname> and <varname>KEYMAP_TOGGLE=</varname>.
 108         </para></listitem>
 109       </varlistentry>
 110       <varlistentry>
 111
 112         <term><varname>vconsole.font=</varname></term>
 113         <term><varname>vconsole.font_map=</varname></term>
 114         <term><varname>vconsole.font_unimap=</varname></term>
 115
 116         <listitem><para>Overrides <varname>FONT=</varname>, <varname>FONT_MAP=</varname>, and
 117         <varname>FONT_UNIMAP=</varname>.</para></listitem>
 118       </varlistentry>
 119     </variablelist>
 120   </refsect1>
 121
 122   <refsect1>
 123     <title>Example</title>
 124
 125     <example>
 126       <title>German keyboard and console</title>
 127
 128       <para><filename>/etc/vconsole.conf</filename>:</para>
 129
 130       <programlisting>KEYMAP=de-latin1
 131 FONT=eurlatgr</programlisting>
 132     </example>
 133
 134   </refsect1>
 135
 136   <refsect1>
 137       <title>See Also</title>
 138       <para>
 139         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 140         <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 141         <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 142         <citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 143         <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 144         <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 145       </para>
 146   </refsect1>
 147
 148 </refentry>