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 <!ENTITY % entities SYSTEM "custom-entities.ent" >
   5 %entities;
   6 ]>
   7
   8 <!--
   9   This file is part of systemd.
  10
  11   Copyright 2010 Lennart Poettering
  12
  13   systemd is free software; you can redistribute it and/or modify it
  14   under the terms of the GNU Lesser General Public License as published by
  15   the Free Software Foundation; either version 2.1 of the License, or
  16   (at your option) any later version.
  17
  18   systemd is distributed in the hope that it will be useful, but
  19   WITHOUT ANY WARRANTY; without even the implied warranty of
  20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  21   Lesser General Public License for more details.
  22
  23   You should have received a copy of the GNU Lesser General Public License
  24   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  25 -->
  26
  27 <refentry id="vconsole.conf" conditional='ENABLE_VCONSOLE'>
  28   <refentryinfo>
  29     <title>vconsole.conf</title>
  30     <productname>systemd</productname>
  31
  32     <authorgroup>
  33       <author>
  34         <contrib>Developer</contrib>
  35         <firstname>Lennart</firstname>
  36         <surname>Poettering</surname>
  37         <email>lennart@poettering.net</email>
  38       </author>
  39     </authorgroup>
  40   </refentryinfo>
  41
  42   <refmeta>
  43     <refentrytitle>vconsole.conf</refentrytitle>
  44     <manvolnum>5</manvolnum>
  45   </refmeta>
  46
  47   <refnamediv>
  48     <refname>vconsole.conf</refname>
  49     <refpurpose>Configuration file for the virtual console</refpurpose>
  50   </refnamediv>
  51
  52   <refsynopsisdiv>
  53     <para><filename>/etc/vconsole.conf</filename></para>
  54   </refsynopsisdiv>
  55
  56   <refsect1>
  57     <title>Description</title>
  58
  59     <para>The <filename>/etc/vconsole.conf</filename> file configures
  60     the virtual console, i.e. keyboard mapping and console font. It is
  61     applied at boot by
  62     <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</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   </refsect1>
  84
  85   <refsect1>
  86     <title>Options</title>
  87
  88     <para>The following options are understood:</para>
  89
  90     <variablelist>
  91
  92       <varlistentry>
  93         <term><varname>KEYMAP=</varname></term>
  94         <term><varname>KEYMAP_TOGGLE=</varname></term>
  95
  96         <listitem><para>Configures the key mapping table for the
  97         keyboard. <varname>KEYMAP=</varname> defaults to
  98         <literal>us</literal> if not set. The
  99         <varname>KEYMAP_TOGGLE=</varname> can be used to configure a
 100         second toggle keymap and is by default
 101         unset.</para></listitem>
 102       </varlistentry>
 103
 104       <varlistentry>
 105         <term><varname>FONT=</varname></term>
 106         <term><varname>FONT_MAP=</varname></term>
 107         <term><varname>FONT_UNIMAP=</varname></term>
 108
 109         <listitem><para>Configures the console font, the console map
 110         and the unicode font map.</para></listitem>
 111       </varlistentry>
 112
 113     </variablelist>
 114   </refsect1>
 115
 116   <refsect1>
 117     <title>Example</title>
 118
 119     <example>
 120       <title>German keyboard and console</title>
 121
 122       <para><filename>/etc/vconsole.conf</filename>:</para>
 123
 124       <programlisting>KEYMAP=de-latin1
 125 FONT=eurlatgr</programlisting>
 126     </example>
 127
 128   </refsect1>
 129
 130   <refsect1>
 131       <title>See Also</title>
 132       <para>
 133         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 134         <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 135         <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 136         <citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 137         <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 138         <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 139       </para>
 140   </refsect1>
 141
 142 </refentry>