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   systemd is free software; you can redistribute it and/or modify it
  13   under the terms of the GNU Lesser General Public License as published by
  14   the Free Software Foundation; either version 2.1 of the License, or
  15   (at your option) any later version.
  16
  17   systemd is distributed in the hope that it will be useful, but
  18   WITHOUT ANY WARRANTY; without even the implied warranty of
  19   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20   Lesser General Public License for more details.
  21
  22   You should have received a copy of the GNU Lesser General Public License
  23   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  24 -->
  25
  26 <refentry id="vconsole.conf" conditional='ENABLE_VCONSOLE'>
  27   <refentryinfo>
  28     <title>vconsole.conf</title>
  29     <productname>systemd</productname>
  30
  31     <authorgroup>
  32       <author>
  33         <contrib>Developer</contrib>
  34         <firstname>Lennart</firstname>
  35         <surname>Poettering</surname>
  36         <email>lennart@poettering.net</email>
  37       </author>
  38     </authorgroup>
  39   </refentryinfo>
  40
  41   <refmeta>
  42     <refentrytitle>vconsole.conf</refentrytitle>
  43     <manvolnum>5</manvolnum>
  44   </refmeta>
  45
  46   <refnamediv>
  47     <refname>vconsole.conf</refname>
  48     <refpurpose>Configuration file for the virtual console</refpurpose>
  49   </refnamediv>
  50
  51   <refsynopsisdiv>
  52     <para><filename>/etc/vconsole.conf</filename></para>
  53   </refsynopsisdiv>
  54
  55   <refsect1>
  56     <title>Description</title>
  57
  58     <para>The <filename>/etc/vconsole.conf</filename> file configures
  59     the virtual console, i.e. keyboard mapping and console font. It is
  60     applied at boot by udev using <filename>90-vconsole.rules</filename> file.
  61     You can safely mask this file if you want to avoid this kind of initialization.
  62     </para>
  63
  64     <para>The basic file format of the
  65     <filename>vconsole.conf</filename> is a newline-separated list of
  66     environment-like shell-compatible variable assignments. It is
  67     possible to source the configuration from shell scripts, however,
  68     beyond mere variable assignments no shell features are supported,
  69     allowing applications to read the file without implementing a
  70     shell compatible execution engine.</para>
  71
  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>
  79
  80     <para>Depending on the operating system other configuration files
  81     might be checked for configuration of the virtual console as well,
  82     however only as fallback.</para>
  83
  84     <para><filename>/etc/vconsole.conf</filename> is usually created and updated
  85     using
  86     <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
  87     <citerefentry><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  88     may be used to instruct <command>systemd-localed.service</command> to
  89     query or update configuration.</para>
  90   </refsect1>
  91
  92   <refsect1>
  93     <title>Options</title>
  94
  95     <para>The following options are understood:</para>
  96
  97     <variablelist>
  98
  99       <varlistentry>
 100         <term><varname>KEYMAP=</varname></term>
 101         <term><varname>KEYMAP_TOGGLE=</varname></term>
 102
 103         <listitem><para>Configures the key mapping table for the keyboard.
 104         <varname>KEYMAP=</varname> defaults to <literal>us</literal> if not set. The
 105         <varname>KEYMAP_TOGGLE=</varname> can be used to configure a second toggle keymap and is by
 106         default unset.</para></listitem>
 107       </varlistentry>
 108
 109       <varlistentry>
 110         <term><varname>FONT=</varname></term>
 111         <term><varname>FONT_MAP=</varname></term>
 112         <term><varname>FONT_UNIMAP=</varname></term>
 113
 114         <listitem><para>Configures the console font, the console map
 115         and the unicode font map.</para></listitem>
 116       </varlistentry>
 117
 118     </variablelist>
 119   </refsect1>
 120
 121   <refsect1>
 122     <title>Kernel Command Line</title>
 123
 124     <para>A few configuration parameters from <filename>vconsole.conf</filename> may be overridden
 125     on the kernel command line:</para>
 126
 127     <variablelist class='kernel-commandline-options'>
 128       <varlistentry>
 129         <term><varname>vconsole.keymap=</varname></term>
 130         <term><varname>vconsole.keymap_toggle=</varname></term>
 131
 132         <listitem><para>Overrides <varname>KEYMAP=</varname> and <varname>KEYMAP_TOGGLE=</varname>.
 133         </para></listitem>
 134       </varlistentry>
 135       <varlistentry>
 136
 137         <term><varname>vconsole.font=</varname></term>
 138         <term><varname>vconsole.font_map=</varname></term>
 139         <term><varname>vconsole.font_unimap=</varname></term>
 140
 141         <listitem><para>Overrides <varname>FONT=</varname>, <varname>FONT_MAP=</varname>, and
 142         <varname>FONT_UNIMAP=</varname>.</para></listitem>
 143       </varlistentry>
 144     </variablelist>
 145   </refsect1>
 146
 147   <refsect1>
 148     <title>Example</title>
 149
 150     <example>
 151       <title>German keyboard and console</title>
 152
 153       <para><filename>/etc/vconsole.conf</filename>:</para>
 154
 155       <programlisting>KEYMAP=de-latin1
 156 FONT=eurlatgr</programlisting>
 157     </example>
 158
 159   </refsect1>
 160
 161   <refsect1>
 162       <title>See Also</title>
 163       <para>
 164         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 165         <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 166         <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 167         <citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 168         <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 169         <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 170       </para>
 171   </refsect1>
 172
 173 </refentry>