vconsole.conf.xml revision 681eb9cf2b831293a4f3d4c48a748d2e4a25d69e
279c6ec074be17dce62dd1b2c6ed7c2cc56a7b78David Lawrence<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
281bfa2a98f1d1721538086e1b550185559f1d8bMark Andrews "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
281bfa2a98f1d1721538086e1b550185559f1d8bMark Andrews<!ENTITY % entities SYSTEM "custom-entities.ent" >
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence This file is part of systemd.
281bfa2a98f1d1721538086e1b550185559f1d8bMark Andrews Copyright 2010 Lennart Poettering
281bfa2a98f1d1721538086e1b550185559f1d8bMark Andrews systemd is free software; you can redistribute it and/or modify it
281bfa2a98f1d1721538086e1b550185559f1d8bMark Andrews under the terms of the GNU Lesser General Public License as published by
281bfa2a98f1d1721538086e1b550185559f1d8bMark Andrews the Free Software Foundation; either version 2.1 of the License, or
281bfa2a98f1d1721538086e1b550185559f1d8bMark Andrews (at your option) any later version.
279c6ec074be17dce62dd1b2c6ed7c2cc56a7b78David Lawrence systemd is distributed in the hope that it will be useful, but
281bfa2a98f1d1721538086e1b550185559f1d8bMark Andrews WITHOUT ANY WARRANTY; without even the implied warranty of
a14613fce99dee3cad5bf842fd6be78f8e463582Brian Wellington MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
279c6ec074be17dce62dd1b2c6ed7c2cc56a7b78David Lawrence Lesser General Public License for more details.
279c6ec074be17dce62dd1b2c6ed7c2cc56a7b78David Lawrence You should have received a copy of the GNU Lesser General Public License
279c6ec074be17dce62dd1b2c6ed7c2cc56a7b78David Lawrence along with systemd; If not, see <http://www.gnu.org/licenses/>.
fd837244be31850a764863688bce11df9ce972f4Andreas Gustafsson<refentry id="vconsole.conf" conditional='ENABLE_VCONSOLE'>
fd837244be31850a764863688bce11df9ce972f4Andreas Gustafsson <refentryinfo>
8d4257cff01b3821abcb9a21f46c6c6a43bb1e72Bob Halley <authorgroup>
dc97fe4ed08488d314ab5bc8e99ed839542cf411David Lawrence </authorgroup>
dc97fe4ed08488d314ab5bc8e99ed839542cf411David Lawrence </refentryinfo>
7005cfed8cd3296d356883dcb414979f22e06b13Brian Wellington <refpurpose>Configuration file for the virtual console</refpurpose>
6f7660093e70d3a7c80738b681ac0f5c1b661c00Mark Andrews </refnamediv>
6f7660093e70d3a7c80738b681ac0f5c1b661c00Mark Andrews <refsynopsisdiv>
d8dcd6ad4617cc8d7df979bd62101fa9c4bac1bcBob Halley <para><filename>/etc/vconsole.conf</filename></para>
d8dcd6ad4617cc8d7df979bd62101fa9c4bac1bcBob Halley </refsynopsisdiv>
d2a97368971414ffd71907e404fe02591dc5ed83Mark Andrews <para>The <filename>/etc/vconsole.conf</filename> file configures
a30e7fc23415fd238d067a8a871607bca36068baMichael Graff the virtual console, i.e. keyboard mapping and console font. It is
a30e7fc23415fd238d067a8a871607bca36068baMichael Graff applied at boot by
5c00d1c90030a311d2700970fa7cffc8f828a48cBob Halley <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
194b6a25192581bbc8ec731e32e8989042b202a4Michael Graff <para>The basic file format of the
6286983c506433d642b23e64845c50be30f2a7f6Mark Andrews <filename>vconsole.conf</filename> is a newline-separated list of
6286983c506433d642b23e64845c50be30f2a7f6Mark Andrews environment-like shell-compatible variable assignments. It is
6286983c506433d642b23e64845c50be30f2a7f6Mark Andrews possible to source the configuration from shell scripts, however,
8313838954d67250d0ed7edf67fba5da0790d1a7Michael Graff beyond mere variable assignments no shell features are supported,
8313838954d67250d0ed7edf67fba5da0790d1a7Michael Graff allowing applications to read the file without implementing a
8313838954d67250d0ed7edf67fba5da0790d1a7Michael Graff shell compatible execution engine.</para>
8313838954d67250d0ed7edf67fba5da0790d1a7Michael Graff <para>Note that the kernel command line options
703e1c0bb66f3cd3d300358ca0c1fdf3cb5fb1c5Brian Wellington <varname>vconsole.keymap.toggle=</varname>,
b15c543f7957fbb4284f0fc20b3278f2a411d272Mark Andrews <varname>vconsole.font.unimap=</varname> may be used
b15c543f7957fbb4284f0fc20b3278f2a411d272Mark Andrews to override the console settings at boot.</para>
0eb2572d79822d02ea05448ce4e5f1759c73d171Michael Graff <para>Depending on the operating system other configuration files
0eb2572d79822d02ea05448ce4e5f1759c73d171Michael Graff might be checked for configuration of the virtual console as well,
0eb2572d79822d02ea05448ce4e5f1759c73d171Michael Graff however only as fallback.</para>
3f123dcc2fe5d2cd08ca91b732741d86a4036906Brian Wellington <para>The following options are understood:</para>
3f123dcc2fe5d2cd08ca91b732741d86a4036906Brian Wellington <variablelist>
64b92523f9333ba053f4b2860335583be455b0b3Brian Wellington <varlistentry>
876753d5ce1be48f3218fb4875fac501f8adfd6cDavid Lawrence <term><varname>KEYMAP_TOGGLE=</varname></term>
876753d5ce1be48f3218fb4875fac501f8adfd6cDavid Lawrence <listitem><para>Configures the key mapping table for the
876753d5ce1be48f3218fb4875fac501f8adfd6cDavid Lawrence keyboard. <varname>KEYMAP=</varname> defaults to
876753d5ce1be48f3218fb4875fac501f8adfd6cDavid Lawrence <varname>KEYMAP_TOGGLE=</varname> can be used to configure a
876753d5ce1be48f3218fb4875fac501f8adfd6cDavid Lawrence second toggle keymap and is by default
ed71ea51c6ecb5d7d659b6e6a20f6b3f5c2678c6David Lawrence </varlistentry>
ed71ea51c6ecb5d7d659b6e6a20f6b3f5c2678c6David Lawrence <varlistentry>
49a2cf8f211213712d452287ae8e121cf59e3178David Lawrence <listitem><para>Configures the console font, the console map
49a2cf8f211213712d452287ae8e121cf59e3178David Lawrence </varlistentry>
49a2cf8f211213712d452287ae8e121cf59e3178David Lawrence </variablelist>
f54d0c9c6e65de367d4ef08f51d22a2fb4c56208Mark Andrews <para><filename>/etc/vconsole.conf</filename>:</para>
49a2cf8f211213712d452287ae8e121cf59e3178David Lawrence <programlisting>KEYMAP=de-latin1
a14613fce99dee3cad5bf842fd6be78f8e463582Brian WellingtonFONT=eurlatgr</programlisting>
bff8ac12a8c099257bdbf7d0c55d2d5b77591926Mark Andrews <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
fd837244be31850a764863688bce11df9ce972f4Andreas Gustafsson <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
fd837244be31850a764863688bce11df9ce972f4Andreas Gustafsson <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
fd837244be31850a764863688bce11df9ce972f4Andreas Gustafsson <citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
f54d0c9c6e65de367d4ef08f51d22a2fb4c56208Mark Andrews <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
f54d0c9c6e65de367d4ef08f51d22a2fb4c56208Mark Andrews <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>