man/vconsole.conf.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   4         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   5
   6 <!--
   7   This file is part of systemd.
   8
   9   Copyright 2010 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 -->
  24
  25 <refentry id="vconsole.conf" conditional='ENABLE_VCONSOLE'>
  26         <refentryinfo>
  27                 <title>vconsole.conf</title>
  28                 <productname>systemd</productname>
  29
  30                 <authorgroup>
  31                         <author>
  32                                 <contrib>Developer</contrib>
  33                                 <firstname>Lennart</firstname>
  34                                 <surname>Poettering</surname>
  35                                 <email>lennart@poettering.net</email>
  36                         </author>
  37                 </authorgroup>
  38         </refentryinfo>
  39
  40         <refmeta>
  41                 <refentrytitle>vconsole.conf</refentrytitle>
  42                 <manvolnum>5</manvolnum>
  43         </refmeta>
  44
  45         <refnamediv>
  46                 <refname>vconsole.conf</refname>
  47                 <refpurpose>Configuration file for the virtual console</refpurpose>
  48         </refnamediv>
  49
  50         <refsynopsisdiv>
  51                 <para><filename>/etc/vconsole.conf</filename></para>
  52         </refsynopsisdiv>
  53
  54         <refsect1>
  55                 <title>Description</title>
  56
  57                 <para>The <filename>/etc/vconsole.conf</filename> file
  58                 configures the virtual console, i.e. keyboard mapping
  59                 and console font. It is applied at boot by
  60                 <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
  61
  62                 <para>The basic file format of the
  63                 <filename>vconsole.conf</filename> is a
  64                 newline-separated list of environment-like
  65                 shell-compatible variable assignments. It is possible
  66                 to source the configuration from shell scripts,
  67                 however, beyond mere variable assignments no shell
  68                 features are supported, allowing applications to read
  69                 the file without implementing a shell compatible
  70                 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
  81                 configuration files might be checked for configuration
  82                 of the virtual console as well, however only as
  83                 fallback.</para>
  84         </refsect1>
  85
  86         <refsect1>
  87                 <title>Options</title>
  88
  89                 <para>The following options are understood:</para>
  90
  91                 <variablelist>
  92
  93                         <varlistentry>
  94                                 <term><varname>KEYMAP=</varname></term>
  95                                 <term><varname>KEYMAP_TOGGLE=</varname></term>
  96
  97                                 <listitem><para>Configures the key
  98                                 mapping table for the
  99                                 keyboard. <varname>KEYMAP=</varname>
 100                                 defaults to <literal>us</literal> if
 101                                 not set. The
 102                                 <varname>KEYMAP_TOGGLE=</varname> can
 103                                 be used to configure a second toggle
 104                                 keymap and is by default
 105                                 unset.</para></listitem>
 106                         </varlistentry>
 107
 108                         <varlistentry>
 109                                 <term><varname>FONT=</varname></term>
 110                                 <term><varname>FONT_MAP=</varname></term>
 111                                 <term><varname>FONT_UNIMAP=</varname></term>
 112
 113                                 <listitem><para>Configures the console
 114                                 font, the console map and the unicode
 115                                 font map.</para></listitem>
 116                         </varlistentry>
 117
 118                 </variablelist>
 119         </refsect1>
 120
 121         <refsect1>
 122                 <title>Example</title>
 123
 124                 <example>
 125                         <title>German keyboard and console</title>
 126
 127                         <para><filename>/etc/vconsole.conf</filename>:</para>
 128
 129                         <programlisting>KEYMAP=de-latin1
 130 FONT=latarcyrheb-sun16</programlisting>
 131                 </example>
 132
 133         </refsect1>
 134
 135         <refsect1>
 136                   <title>See Also</title>
 137                   <para>
 138                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 139                           <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 140                           <citerefentry><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 141                           <citerefentry><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 142                           <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 143                           <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 144                   </para>
 145         </refsect1>
 146
 147 </refentry>