]>
Commit | Line | Data |
---|---|---|
4aa6e778 LP |
1 | <?xml version="1.0"?> |
2 | <!--*-nxml-*--> | |
3a54a157 | 3 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
eea10b26 | 4 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> |
db9ecf05 | 5 | <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> |
4623eecb AK |
6 | <refentry id="systemd-vconsole-setup.service" conditional='ENABLE_VCONSOLE' |
7 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
4aa6e778 | 8 | |
798d3a52 ZJS |
9 | <refentryinfo> |
10 | <title>systemd-vconsole-setup.service</title> | |
11 | <productname>systemd</productname> | |
798d3a52 ZJS |
12 | </refentryinfo> |
13 | ||
14 | <refmeta> | |
15 | <refentrytitle>systemd-vconsole-setup.service</refentrytitle> | |
16 | <manvolnum>8</manvolnum> | |
17 | </refmeta> | |
18 | ||
19 | <refnamediv> | |
20 | <refname>systemd-vconsole-setup.service</refname> | |
21 | <refname>systemd-vconsole-setup</refname> | |
808b95ef | 22 | <refpurpose>Configure the virtual consoles</refpurpose> |
798d3a52 ZJS |
23 | </refnamediv> |
24 | ||
25 | <refsynopsisdiv> | |
26 | <para><filename>systemd-vconsole-setup.service</filename></para> | |
808b95ef MS |
27 | <cmdsynopsis> |
28 | <command>/usr/lib/systemd/systemd-vconsole-setup</command> | |
29 | <arg choice="opt">TTY</arg> | |
30 | </cmdsynopsis> | |
798d3a52 ZJS |
31 | </refsynopsisdiv> |
32 | ||
33 | <refsect1> | |
34 | <title>Description</title> | |
35 | ||
467cd9f0 | 36 | <para><command>systemd-vconsole-setup</command> sets up and configures either all virtual consoles, or |
6cfb3ebc ZJS |
37 | — if the optional <replaceable>TTY</replaceable> parameter is provided — a specific one. When the system |
38 | is booting up, <filename>systemd-vconsole-setup.service</filename> is called by | |
39 | <citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry> during | |
40 | VT console subsystem initialization. Also, | |
41 | <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
42 | invokes it as needed when language or console changes are made. | |
43 | Internally, this program calls | |
44 | <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
45 | and | |
46 | <citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
808b95ef MS |
47 | </para> |
48 | ||
49b625ed LP |
49 | <para>Execute <command>systemctl restart systemd-vconsole-setup.service</command> in order to apply any manual |
50 | changes made to <filename>/etc/vconsole.conf</filename>.</para> | |
798d3a52 | 51 | |
49b625ed LP |
52 | <para>See <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> for |
53 | information about the configuration files and kernel command line options understood by this program.</para> | |
798d3a52 ZJS |
54 | </refsect1> |
55 | ||
ea575e17 LP |
56 | <refsect1> |
57 | <title>Credentials</title> | |
58 | ||
59 | <para><command>systemd-vconsole-setup</command> supports the service credentials logic as implemented by | |
bf63dadb | 60 | <varname>ImportCredential=</varname>/<varname>LoadCredential=</varname>/<varname>SetCredential=</varname> |
bbfb25f4 | 61 | (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>1</manvolnum></citerefentry> for |
ea575e17 LP |
62 | details). The following credentials are used when passed in:</para> |
63 | ||
8914f7e8 | 64 | <variablelist class='system-credentials'> |
ea575e17 LP |
65 | <varlistentry> |
66 | <term><varname>vconsole.keymap</varname></term> | |
67 | <term><varname>vconsole.keymap_toggle</varname></term> | |
68 | ||
69 | <listitem><para>The keymap (and toggle keymap) to apply. The matching options in | |
70 | <filename>vconsole.conf</filename> and on the kernel command line take precedence over these | |
71 | credentials.</para> | |
72 | ||
73 | <para>Note the relationship to the <varname>firstboot.keymap</varname> credential understood by | |
74 | <citerefentry><refentrytitle>systemd-firstboot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>: | |
75 | both ultimately affect the same setting, but <varname>firstboot.keymap</varname> is written into | |
76 | <filename>/etc/vconsole.conf</filename> on first boot (if not already configured), and then read from | |
77 | there by <command>systemd-vconsole-setup</command>, while <varname>vconsole.keymap</varname> is read | |
78 | on every boot, and is not persisted to disk (but any configuration in | |
ec07c3c8 AK |
79 | <filename>vconsole.conf</filename> will take precedence if present).</para> |
80 | ||
81 | <xi:include href="version-info.xml" xpointer="v253"/></listitem> | |
ea575e17 LP |
82 | </varlistentry> |
83 | ||
84 | <varlistentry> | |
85 | <term><varname>vconsole.font</varname></term> | |
86 | <term><varname>vconsole.font_map</varname></term> | |
87 | <term><varname>vconsole.font_unimap</varname></term> | |
88 | ||
89 | <listitem><para>The console font settings to apply. The matching options in | |
90 | <filename>vconsole.conf</filename> and on the kernel command line take precedence over these | |
ec07c3c8 AK |
91 | credentials.</para> |
92 | ||
93 | <xi:include href="version-info.xml" xpointer="v253"/></listitem> | |
ea575e17 LP |
94 | </varlistentry> |
95 | </variablelist> | |
96 | </refsect1> | |
97 | ||
798d3a52 ZJS |
98 | <refsect1> |
99 | <title>See Also</title> | |
13a69c12 DT |
100 | <para><simplelist type="inline"> |
101 | <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> | |
102 | <member><citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> | |
103 | <member><citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> | |
104 | <member><citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> | |
105 | <member><citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> | |
106 | </simplelist></para> | |
798d3a52 | 107 | </refsect1> |
4aa6e778 LP |
108 | |
109 | </refentry> |