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 General Public License as published by
  13   the Free Software Foundation; either version 2 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   General Public License for more details.
  20
  21   You should have received a copy of the GNU General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 -->
  24
  25 <refentry id="hostname">
  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.</para>
  60
  61                 <para>The basic file format of the
  62                 <filename>vconsole.conf</filename> is a set of
  63                 environment-like shell-compatible variable
  64                 assignments. It is possible to source the
  65                 configuration from shell scripts, however, beyond mere
  66                 variable assignments no shell features are supported,
  67                 allowing applications to read the file without
  68                 containing a 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> can be used
  76                 to override the console settings at boot.</para>
  77
  78                 <para>Depending on the operating system other
  79                 configuration files might be checked for configuration
  80                 of the virtual console as well, however only as
  81                 fallback.</para>
  82         </refsect1>
  83
  84         <refsect1>
  85                 <title>Options</title>
  86
  87                 <para>The following options are understood:</para>
  88
  89                 <variablelist>
  90
  91                         <varlistentry>
  92                                 <term><varname>KEYMAP=</varname></term>
  93                                 <term><varname>KEYMAP_TOGGLE=</varname></term>
  94
  95                                 <listitem><para>Configures the key
  96                                 mapping table of for they
  97                                 keyboard. <varname>KEYMAP=</varname>
  98                                 defaults to <literal>us</literal> if
  99                                 not set. The
 100                                 <varname>KEYMAP_TOGGLE=</varname> can
 101                                 be used to configured a second toggle
 102                                 keymap and is by default
 103                                 unset.</para></listitem>
 104                         </varlistentry>
 105
 106                         <varlistentry>
 107                                 <term><varname>FONT=</varname></term>
 108                                 <term><varname>FONT_MAP=</varname></term>
 109                                 <term><varname>FONT_UNIMAP=</varname></term>
 110
 111                                 <listitem><para>Configures the console
 112                                 font, the console map and the unicode
 113                                 font map. <varname>FONT=</varname>
 114                                 defaults to
 115                                 <literal>latarcyrheb-sun16</literal>.</para></listitem>
 116                         </varlistentry>
 117
 118                 </variablelist>
 119         </refsect1>
 120
 121         <refsect1>
 122                   <title>See Also</title>
 123                   <para>
 124                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 125                           <citerefentry><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 126                           <citerefentry><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 127                           <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 128                   </para>
 129         </refsect1>
 130
 131 </refentry>