man: rework systemd-vconsole-setup man page a bit (#7312)

It's not systemd that invokes the service internally as needed, it's
systemd-localed. Correct that.

Also, stop using the word "helper". To me a "helper" constitutes
something internal, not official API. I doubt systemd-vconsole-setup
really matches that description though, hence let's better avoid the
term.

Also, clean up some other wording, and be less imbiguous, by suggesting
a single command to apply vconsole.conf instead of two.

Follow-up for 597c25d2a7
This commit is contained in:
Lennart Poettering 2017-11-13 19:14:19 +01:00 committed by Zbigniew Jędrzejewski-Szmek
parent f38326f21a
commit 49b625ed82

View file

@ -57,25 +57,21 @@
<refsect1>
<title>Description</title>
<para><filename>systemd-vconsole-setup</filename> is a helper used to prepare either all virtual consoles, or — if
the optional <replaceable>TTY</replaceable> parameter is provided — a specific one. When the system is booting up
it's called by <citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry> during vtconsole subsystem initialization.
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> also calls it internally as needed via
<filename>systemd-vconsole-setup.service</filename>. The helper calls
<citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry> and
<citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>
internally.
<para><filename>systemd-vconsole-setup</filename> sets up and configures either all virtual consoles, or — if the
optional <replaceable>TTY</replaceable> parameter is provided — a specific one. When the system is booting up it's
called by <citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry> during
VT console subsystem initialization. Also,
<citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> invokes
it as needed when language or console changes are made. Internally, this program calls <citerefentry
project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry> and <citerefentry
project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
<para>
You may want to use this helper whenever you change <filename>vconsole.conf</filename> to
refresh the settings on your consoles — either through the <command>systemctl restart</command> /
<command>systemctl start</command> command or directly through the executable.
</para>
<para>Execute <command>systemctl restart systemd-vconsole-setup.service</command> in order to apply any manual
changes made to <filename>/etc/vconsole.conf</filename>.</para>
<para>See
<citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for information about the configuration files and kernel command line options understood by this program.</para>
<para>See <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
information about the configuration files and kernel command line options understood by this program.</para>
</refsect1>
<refsect1>