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 configures
  58     the virtual console, i.e. keyboard mapping and console font. It is
  59     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 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
  95         keyboard. <varname>KEYMAP=</varname> defaults to
  96         <literal>us</literal> if not set. The
  97         <varname>KEYMAP_TOGGLE=</varname> can be used to configure a
  98         second toggle keymap and is by default
  99         unset.</para></listitem>
 100       </varlistentry>
 101
 102       <varlistentry>
 103         <term><varname>FONT=</varname></term>
 104         <term><varname>FONT_MAP=</varname></term>
 105         <term><varname>FONT_UNIMAP=</varname></term>
 106
 107         <listitem><para>Configures the console font, the console map
 108         and the unicode font map.</para></listitem>
 109       </varlistentry>
 110
 111     </variablelist>
 112   </refsect1>
 113
 114   <refsect1>
 115     <title>Example</title>
 116
 117     <example>
 118       <title>German keyboard and console</title>
 119
 120       <para><filename>/etc/vconsole.conf</filename>:</para>
 121
 122       <programlisting>KEYMAP=de-latin1
 123 FONT=eurlatgr</programlisting>
 124     </example>
 125
 126   </refsect1>
 127
 128   <refsect1>
 129       <title>See Also</title>
 130       <para>
 131         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 132         <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 133         <citerefentry><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 134         <citerefentry><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 135         <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 136         <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 137       </para>
 138   </refsect1>
 139
 140 </refentry>