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