systemd/man/systemd-vconsole-setup.service.xml

<?xml version="1.0"?>
<!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
  This file is part of systemd.

  Copyright 2012 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="systemd-vconsole-setup.service" conditional='ENABLE_VCONSOLE'>

  <refentryinfo>
    <title>systemd-vconsole-setup.service</title>
    <productname>systemd</productname>

    <authorgroup>
      <author>
        <contrib>Developer</contrib>
        <firstname>Lennart</firstname>
        <surname>Poettering</surname>
        <email>lennart@poettering.net</email>
      </author>
    </authorgroup>
  </refentryinfo>

  <refmeta>
    <refentrytitle>systemd-vconsole-setup.service</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>systemd-vconsole-setup.service</refname>
    <refname>systemd-vconsole-setup</refname>
    <refpurpose>Configure the virtual consoles</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <para><filename>systemd-vconsole-setup.service</filename></para>
    <cmdsynopsis>
      <command>/usr/lib/systemd/systemd-vconsole-setup</command>
      <arg choice="opt">TTY</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <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><command>udev</command></citerefentry> during vtconsole subsystem initialization.
      <productname>Systemd</productname> 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>

    <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>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>
    <title>See Also</title>
    <para>
      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
      <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
    </para>
  </refsect1>

</refentry>