man/systemd-vconsole-setup.service.xml

   1 <?xml version="1.0"?>
   2 <!--*-nxml-*-->
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!--
   5   This file is part of systemd.
   6
   7   Copyright 2012 Lennart Poettering
   8
   9   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 -->
  22 <refentry id="systemd-vconsole-setup.service" conditional='ENABLE_VCONSOLE'>
  23
  24   <refentryinfo>
  25     <title>systemd-vconsole-setup.service</title>
  26     <productname>systemd</productname>
  27
  28     <authorgroup>
  29       <author>
  30         <contrib>Developer</contrib>
  31         <firstname>Lennart</firstname>
  32         <surname>Poettering</surname>
  33         <email>lennart@poettering.net</email>
  34       </author>
  35     </authorgroup>
  36   </refentryinfo>
  37
  38   <refmeta>
  39     <refentrytitle>systemd-vconsole-setup.service</refentrytitle>
  40     <manvolnum>8</manvolnum>
  41   </refmeta>
  42
  43   <refnamediv>
  44     <refname>systemd-vconsole-setup.service</refname>
  45     <refname>systemd-vconsole-setup</refname>
  46     <refpurpose>Configure the virtual consoles</refpurpose>
  47   </refnamediv>
  48
  49   <refsynopsisdiv>
  50     <para><filename>systemd-vconsole-setup.service</filename></para>
  51     <cmdsynopsis>
  52       <command>/usr/lib/systemd/systemd-vconsole-setup</command>
  53       <arg choice="opt">TTY</arg>
  54     </cmdsynopsis>
  55   </refsynopsisdiv>
  56
  57   <refsect1>
  58     <title>Description</title>
  59
  60     <para><filename>systemd-vconsole-setup</filename> is a helper used to prepare either all virtual consoles, or — if
  61       the optional <replaceable>TTY</replaceable> parameter is provided — a specific one. When the system is booting up
  62       it's called by <citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry> during vtconsole subsystem initialization.
  63       <productname>Systemd</productname> also calls it internally as needed via
  64       <filename>systemd-vconsole-setup.service</filename>. The helper calls
  65       <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry> and
  66       <citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  67       internally.
  68     </para>
  69
  70     <para>
  71       You may want to use this helper whenever you change <filename>vconsole.conf</filename> to
  72       refresh the settings on your consoles — either through the <command>systemctl restart</command> /
  73       <command>systemctl start</command> command or directly through the executable.
  74     </para>
  75
  76     <para>See
  77     <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  78     for information about the configuration files and kernel command line options understood by this program.</para>
  79   </refsect1>
  80
  81   <refsect1>
  82     <title>See Also</title>
  83     <para>
  84       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  85       <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  86       <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  87       <citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  88       <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  89     </para>
  90   </refsect1>
  91
  92 </refentry>