chiark / gitweb /
journal: systemd v38 fails to build on big-endians
[elogind.git] / 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="vconsole.conf">
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
63                 newline-separated list environment-like
64                 shell-compatible variable assignments. It is possible
65                 to source the configuration from shell scripts,
66                 however, beyond mere variable assignments no shell
67                 features are supported, allowing applications to read
68                 the file without implementing a shell compatible
69                 execution engine.</para>
70
71                 <para>Note that the kernel command line options
72                 <varname>vconsole.keymap=</varname>,
73                 <varname>vconsole.keymap.toggle=</varname>,
74                 <varname>vconsole.font=</varname>,
75                 <varname>vconsole.font.map=</varname>,
76                 <varname>vconsole.font.unimap=</varname> may be used
77                 to override the console settings at boot.</para>
78
79                 <para>Depending on the operating system other
80                 configuration files might be checked for configuration
81                 of the virtual console as well, however only as
82                 fallback.</para>
83         </refsect1>
84
85         <refsect1>
86                 <title>Options</title>
87
88                 <para>The following options are understood:</para>
89
90                 <variablelist>
91
92                         <varlistentry>
93                                 <term><varname>KEYMAP=</varname></term>
94                                 <term><varname>KEYMAP_TOGGLE=</varname></term>
95
96                                 <listitem><para>Configures the key
97                                 mapping table of for they
98                                 keyboard. <varname>KEYMAP=</varname>
99                                 defaults to <literal>us</literal> if
100                                 not set. The
101                                 <varname>KEYMAP_TOGGLE=</varname> can
102                                 be used to configured a second toggle
103                                 keymap and is by default
104                                 unset.</para></listitem>
105                         </varlistentry>
106
107                         <varlistentry>
108                                 <term><varname>FONT=</varname></term>
109                                 <term><varname>FONT_MAP=</varname></term>
110                                 <term><varname>FONT_UNIMAP=</varname></term>
111
112                                 <listitem><para>Configures the console
113                                 font, the console map and the unicode
114                                 font map. <varname>FONT=</varname>
115                                 defaults to
116                                 <literal>latarcyrheb-sun16</literal>.</para></listitem>
117                         </varlistentry>
118
119                 </variablelist>
120         </refsect1>
121
122         <refsect1>
123                 <title>Example</title>
124
125                 <example>
126                         <title>German keyboard and console</title>
127
128                         <para><filename>/etc/vconsole.conf:</filename></para>
129
130                         <programlisting>KEYMAP=de-latin1
131 FONT=latarcyrheb-sun16</programlisting>
132                 </example>
133
134         </refsect1>
135
136         <refsect1>
137                   <title>See Also</title>
138                   <para>
139                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</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                   </para>
144         </refsect1>
145
146 </refentry>