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   </refsect1>
  82
  83   <refsect1>
  84     <title>Options</title>
  85
  86     <para>The following options are understood:</para>
  87
  88     <variablelist>
  89
  90       <varlistentry>
  91         <term><varname>KEYMAP=</varname></term>
  92         <term><varname>KEYMAP_TOGGLE=</varname></term>
  93
  94         <listitem><para>Configures the key mapping table for the keyboard.
  95         <varname>KEYMAP=</varname> defaults to <literal>us</literal> if not set. The
  96         <varname>KEYMAP_TOGGLE=</varname> can be used to configure a second toggle keymap and is by
  97         default unset.</para></listitem>
  98       </varlistentry>
  99
 100       <varlistentry>
 101         <term><varname>FONT=</varname></term>
 102         <term><varname>FONT_MAP=</varname></term>
 103         <term><varname>FONT_UNIMAP=</varname></term>
 104
 105         <listitem><para>Configures the console font, the console map
 106         and the unicode font map.</para></listitem>
 107       </varlistentry>
 108
 109     </variablelist>
 110   </refsect1>
 111
 112   <refsect1>
 113     <title>Kernel Command Line</title>
 114
 115     <para>A few configuration parameters from <filename>vconsole.conf</filename> may be overridden
 116     on the kernel command line:</para>
 117
 118     <variablelist class='kernel-commandline-options'>
 119       <varlistentry>
 120         <term><varname>vconsole.keymap=</varname></term>
 121         <term><varname>vconsole.keymap_toggle=</varname></term>
 122
 123         <listitem><para>Overrides <varname>KEYMAP=</varname> and <varname>KEYMAP_TOGGLE=</varname>.
 124         </para></listitem>
 125       </varlistentry>
 126       <varlistentry>
 127
 128         <term><varname>vconsole.font=</varname></term>
 129         <term><varname>vconsole.font_map=</varname></term>
 130         <term><varname>vconsole.font_unimap=</varname></term>
 131
 132         <listitem><para>Overrides <varname>FONT=</varname>, <varname>FONT_MAP=</varname>, and
 133         <varname>FONT_UNIMAP=</varname>.</para></listitem>
 134       </varlistentry>
 135     </variablelist>
 136   </refsect1>
 137
 138   <refsect1>
 139     <title>Example</title>
 140
 141     <example>
 142       <title>German keyboard and console</title>
 143
 144       <para><filename>/etc/vconsole.conf</filename>:</para>
 145
 146       <programlisting>KEYMAP=de-latin1
 147 FONT=eurlatgr</programlisting>
 148     </example>
 149
 150   </refsect1>
 151
 152   <refsect1>
 153       <title>See Also</title>
 154       <para>
 155         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 156         <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 157         <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 158         <citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 159         <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 160         <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 161       </para>
 162   </refsect1>
 163
 164 </refentry>