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