]>
Commit | Line | Data |
---|---|---|
eeca220b | 1 | <?xml version='1.0'?> <!--*-nxml-*--> |
eeca220b | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
12b42c76 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
eeca220b LP |
4 | |
5 | <!-- | |
6 | This file is part of systemd. | |
7 | ||
8 | Copyright 2010 Lennart Poettering | |
9 | ||
10 | systemd is free software; you can redistribute it and/or modify it | |
5430f7f2 LP |
11 | under the terms of the GNU Lesser General Public License as published by |
12 | the Free Software Foundation; either version 2.1 of the License, or | |
eeca220b LP |
13 | (at your option) any later version. |
14 | ||
15 | systemd is distributed in the hope that it will be useful, but | |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
5430f7f2 | 18 | Lesser General Public License for more details. |
eeca220b | 19 | |
5430f7f2 | 20 | You should have received a copy of the GNU Lesser General Public License |
eeca220b LP |
21 | along with systemd; If not, see <http://www.gnu.org/licenses/>. |
22 | --> | |
23 | ||
56ba3c78 | 24 | <refentry id="vconsole.conf" conditional='ENABLE_VCONSOLE'> |
798d3a52 ZJS |
25 | <refentryinfo> |
26 | <title>vconsole.conf</title> | |
27 | <productname>systemd</productname> | |
28 | ||
29 | <authorgroup> | |
30 | <author> | |
31 | <contrib>Developer</contrib> | |
32 | <firstname>Lennart</firstname> | |
33 | <surname>Poettering</surname> | |
34 | <email>lennart@poettering.net</email> | |
35 | </author> | |
36 | </authorgroup> | |
37 | </refentryinfo> | |
38 | ||
39 | <refmeta> | |
40 | <refentrytitle>vconsole.conf</refentrytitle> | |
41 | <manvolnum>5</manvolnum> | |
42 | </refmeta> | |
43 | ||
44 | <refnamediv> | |
45 | <refname>vconsole.conf</refname> | |
46 | <refpurpose>Configuration file for the virtual console</refpurpose> | |
47 | </refnamediv> | |
48 | ||
49 | <refsynopsisdiv> | |
50 | <para><filename>/etc/vconsole.conf</filename></para> | |
51 | </refsynopsisdiv> | |
52 | ||
53 | <refsect1> | |
54 | <title>Description</title> | |
55 | ||
56 | <para>The <filename>/etc/vconsole.conf</filename> file configures | |
57 | the virtual console, i.e. keyboard mapping and console font. It is | |
58 | applied at boot by | |
59 | <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> | |
60 | ||
61 | <para>The basic file format of the | |
62 | <filename>vconsole.conf</filename> is a newline-separated list of | |
63 | environment-like shell-compatible variable assignments. It is | |
64 | possible to source the configuration from shell scripts, however, | |
65 | beyond mere variable assignments no shell features are supported, | |
66 | allowing applications to read the file without implementing a | |
67 | shell compatible execution engine.</para> | |
68 | ||
69 | <para>Note that the kernel command line options | |
70 | <varname>vconsole.keymap=</varname>, | |
71 | <varname>vconsole.keymap.toggle=</varname>, | |
72 | <varname>vconsole.font=</varname>, | |
73 | <varname>vconsole.font.map=</varname>, | |
74 | <varname>vconsole.font.unimap=</varname> may be used | |
75 | to override the console settings at boot.</para> | |
76 | ||
77 | <para>Depending on the operating system other configuration files | |
78 | might be checked for configuration of the virtual console as well, | |
79 | however only as fallback.</para> | |
80 | </refsect1> | |
81 | ||
82 | <refsect1> | |
83 | <title>Options</title> | |
84 | ||
85 | <para>The following options are understood:</para> | |
86 | ||
87 | <variablelist> | |
88 | ||
89 | <varlistentry> | |
90 | <term><varname>KEYMAP=</varname></term> | |
91 | <term><varname>KEYMAP_TOGGLE=</varname></term> | |
92 | ||
93 | <listitem><para>Configures the key mapping table for the | |
94 | keyboard. <varname>KEYMAP=</varname> defaults to | |
95 | <literal>us</literal> if not set. The | |
96 | <varname>KEYMAP_TOGGLE=</varname> can be used to configure a | |
97 | second toggle keymap and is by default | |
98 | unset.</para></listitem> | |
99 | </varlistentry> | |
100 | ||
101 | <varlistentry> | |
102 | <term><varname>FONT=</varname></term> | |
103 | <term><varname>FONT_MAP=</varname></term> | |
104 | <term><varname>FONT_UNIMAP=</varname></term> | |
105 | ||
106 | <listitem><para>Configures the console font, the console map | |
107 | and the unicode font map.</para></listitem> | |
108 | </varlistentry> | |
109 | ||
110 | </variablelist> | |
111 | </refsect1> | |
112 | ||
113 | <refsect1> | |
114 | <title>Example</title> | |
115 | ||
116 | <example> | |
117 | <title>German keyboard and console</title> | |
118 | ||
119 | <para><filename>/etc/vconsole.conf</filename>:</para> | |
120 | ||
121 | <programlisting>KEYMAP=de-latin1 | |
25b47f96 | 122 | FONT=eurlatgr</programlisting> |
798d3a52 ZJS |
123 | </example> |
124 | ||
125 | </refsect1> | |
126 | ||
127 | <refsect1> | |
128 | <title>See Also</title> | |
129 | <para> | |
130 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
131 | <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
3ba3a79d ZJS |
132 | <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
133 | <citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
134 | <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
798d3a52 ZJS |
135 | <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> |
136 | </para> | |
137 | </refsect1> | |
eeca220b LP |
138 | |
139 | </refentry> |