vconsole.conf.xml revision eeca220bc280ebbed98bb3fc2c8d63efeccbfca1
d3ed5b56cb6b58f87ffd125bed48f7668f13de1edirkx<?xml version='1.0'?> <!--*-nxml-*-->
893328ef6ff86d0ca27774778d84410353789fb0fielding<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
6de8046f8f7e07cd83895a528df25d977e502c76nd<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
893328ef6ff86d0ca27774778d84410353789fb0fielding "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
0202d2114cc6d7042995100519cce45c808c153bnd
0202d2114cc6d7042995100519cce45c808c153bnd<!--
0202d2114cc6d7042995100519cce45c808c153bnd This file is part of systemd.
893328ef6ff86d0ca27774778d84410353789fb0fielding
0202d2114cc6d7042995100519cce45c808c153bnd Copyright 2010 Lennart Poettering
893328ef6ff86d0ca27774778d84410353789fb0fielding
0202d2114cc6d7042995100519cce45c808c153bnd systemd is free software; you can redistribute it and/or modify it
0202d2114cc6d7042995100519cce45c808c153bnd under the terms of the GNU General Public License as published by
0202d2114cc6d7042995100519cce45c808c153bnd the Free Software Foundation; either version 2 of the License, or
0202d2114cc6d7042995100519cce45c808c153bnd (at your option) any later version.
0202d2114cc6d7042995100519cce45c808c153bnd
893328ef6ff86d0ca27774778d84410353789fb0fielding systemd is distributed in the hope that it will be useful, but
893328ef6ff86d0ca27774778d84410353789fb0fielding WITHOUT ANY WARRANTY; without even the implied warranty of
893328ef6ff86d0ca27774778d84410353789fb0fielding MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
893328ef6ff86d0ca27774778d84410353789fb0fielding General Public License for more details.
0d50a692ff2ac7bdb42e417737ed86ebf0a41671ben
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz You should have received a copy of the GNU General Public License
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz along with systemd; If not, see <http://www.gnu.org/licenses/>.
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz-->
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz<refentry id="hostname">
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <refentryinfo>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <title>vconsole.conf</title>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <productname>systemd</productname>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <authorgroup>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <author>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <contrib>Developer</contrib>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <firstname>Lennart</firstname>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <surname>Poettering</surname>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <email>lennart@poettering.net</email>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz </author>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz </authorgroup>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz </refentryinfo>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <refmeta>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <refentrytitle>vconsole.conf</refentrytitle>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <manvolnum>5</manvolnum>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz </refmeta>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <refnamediv>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <refname>vconsole.conf</refname>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <refpurpose>configuration file for the virtual console</refpurpose>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz </refnamediv>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz
893328ef6ff86d0ca27774778d84410353789fb0fielding <refsynopsisdiv>
893328ef6ff86d0ca27774778d84410353789fb0fielding <para><filename>/etc/vconsole.conf</filename></para>
893328ef6ff86d0ca27774778d84410353789fb0fielding </refsynopsisdiv>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz
0b7037d0efc1cd510ee12e8a35c982c3f2da0353pquerna <refsect1>
0b7037d0efc1cd510ee12e8a35c982c3f2da0353pquerna <title>Description</title>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz
893328ef6ff86d0ca27774778d84410353789fb0fielding <para>The <filename>/etc/vconsole.conf</filename> file
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz configures the virtual console, i.e. keyboard mapping
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz and console font.</para>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <para>The basic file format of the
893328ef6ff86d0ca27774778d84410353789fb0fielding <filename>vconsole.conf</filename> is a set of
f14fe1f44cb7018927ee0e31eb959cba8dc3700bjorton environment-like shell-compatible variable
893328ef6ff86d0ca27774778d84410353789fb0fielding assignments. It is possible to source the
0b7037d0efc1cd510ee12e8a35c982c3f2da0353pquerna configuration from shell scripts, however, beyond mere
893328ef6ff86d0ca27774778d84410353789fb0fielding variable assignments no shell features are supported,
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz allowing applications to read the file without
893328ef6ff86d0ca27774778d84410353789fb0fielding containing a shell compatible execution engine.</para>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <para>Note that the kernel command line options
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <varname>vconsole.keymap=</varname>,
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <varname>vconsole.keymap.toggle=</varname>,
893328ef6ff86d0ca27774778d84410353789fb0fielding <varname>vconsole.font=</varname>,
f14fe1f44cb7018927ee0e31eb959cba8dc3700bjorton <varname>vconsole.font.map=</varname>,
893328ef6ff86d0ca27774778d84410353789fb0fielding <varname>vconsole.font.unimap=</varname> can be used
0b7037d0efc1cd510ee12e8a35c982c3f2da0353pquerna to override the console settings at boot.</para>
0b7037d0efc1cd510ee12e8a35c982c3f2da0353pquerna
0b7037d0efc1cd510ee12e8a35c982c3f2da0353pquerna <para>Depending on the operating system other
0b7037d0efc1cd510ee12e8a35c982c3f2da0353pquerna configuration files might be checked for configuration
893328ef6ff86d0ca27774778d84410353789fb0fielding of the virtual console as well, however only as
893328ef6ff86d0ca27774778d84410353789fb0fielding fallback.</para>
893328ef6ff86d0ca27774778d84410353789fb0fielding </refsect1>
893328ef6ff86d0ca27774778d84410353789fb0fielding
893328ef6ff86d0ca27774778d84410353789fb0fielding <refsect1>
893328ef6ff86d0ca27774778d84410353789fb0fielding <title>Options</title>
893328ef6ff86d0ca27774778d84410353789fb0fielding
623882f55701a4c5a6bded180f60d86a524ac341sascha <para>The following options are understood:</para>
623882f55701a4c5a6bded180f60d86a524ac341sascha
e07615ab3b59412d79eebb8d5b12f488e77c14a7jorton <variablelist>
e07615ab3b59412d79eebb8d5b12f488e77c14a7jorton
c066cdcb75ca262e424345b347b86e7ce2285869jerenkrantz <varlistentry>
c15906bab97b9b71b6dc08c1aa2f5c0b72b5ca4edreid <term><varname>KEYMAP=</varname></term>
c15906bab97b9b71b6dc08c1aa2f5c0b72b5ca4edreid <term><varname>KEYMAP_TOGGLE=</varname></term>
96e6cafca226a8a2a64a7bbdc634b5b2679c9e0csascha
96e6cafca226a8a2a64a7bbdc634b5b2679c9e0csascha <listitem><para>Configures the key
893328ef6ff86d0ca27774778d84410353789fb0fielding mapping table of for they
893328ef6ff86d0ca27774778d84410353789fb0fielding keyboard. <varname>KEYMAP=</varname>
893328ef6ff86d0ca27774778d84410353789fb0fielding defaults to <literal>us</literal> if
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz not set. The
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <varname>KEYMAP_TOGGLE=</varname> can
893328ef6ff86d0ca27774778d84410353789fb0fielding be used to configured a second toggle
893328ef6ff86d0ca27774778d84410353789fb0fielding keymap and is by default
893328ef6ff86d0ca27774778d84410353789fb0fielding unset.</para></listitem>
893328ef6ff86d0ca27774778d84410353789fb0fielding </varlistentry>
893328ef6ff86d0ca27774778d84410353789fb0fielding
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <varlistentry>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <term><varname>FONT=</varname></term>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <term><varname>FONT_MAP=</varname></term>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <term><varname>FONT_UNIMAP=</varname></term>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <listitem><para>Configures the console
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz font, the console map and the unicode
893328ef6ff86d0ca27774778d84410353789fb0fielding font map. <varname>FONT=</varname>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz defaults to
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <literal>latarcyrheb-sun16</literal>.</para></listitem>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz </varlistentry>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz </variablelist>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz </refsect1>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz
893328ef6ff86d0ca27774778d84410353789fb0fielding <refsect1>
1e5333ef1a0edb888d75c0cdd90b33fa7e89fc31wsanchez <title>See Also</title>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <para>
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
99d360dcbb5ac2be27694be74cc6124dbadf3315jerenkrantz <citerefentry><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1e5333ef1a0edb888d75c0cdd90b33fa7e89fc31wsanchez <citerefentry><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1d13cbde60ace1b56ca57b9f0f74168bb1288174trawick <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1d13cbde60ace1b56ca57b9f0f74168bb1288174trawick </para>
80b1e2ff2e3515fdab14675684b2640ceb6ce1c7trawick </refsect1>
1d13cbde60ace1b56ca57b9f0f74168bb1288174trawick
9045837071eae7a4b55204a21f31ccee17749af3jerenkrantz</refentry>
ab44eb80e084a02a66a58336d6fcfbbe48310439trawick