man/systemd-getty-generator.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   SPDX-License-Identifier: LGPL-2.1+
   6 -->
   7 <refentry id="systemd-getty-generator">
   8
   9   <refentryinfo>
  10     <title>systemd-getty-generator</title>
  11     <productname>systemd</productname>
  12   </refentryinfo>
  13
  14   <refmeta>
  15     <refentrytitle>systemd-getty-generator</refentrytitle>
  16     <manvolnum>8</manvolnum>
  17   </refmeta>
  18
  19   <refnamediv>
  20     <refname>systemd-getty-generator</refname>
  21     <refpurpose>Generator for enabling getty instances on the
  22     console</refpurpose>
  23   </refnamediv>
  24
  25   <refsynopsisdiv>
  26     <para><filename>/usr/lib/systemd/system-generators/systemd-getty-generator</filename></para>
  27   </refsynopsisdiv>
  28
  29   <refsect1>
  30     <title>Description</title>
  31
  32     <para><filename>systemd-getty-generator</filename> is a generator
  33     that automatically instantiates
  34     <filename>serial-getty@.service</filename> on the kernel
  35     console(s), if they can function as ttys and are not provided by
  36     the virtual console subsystem. It will also instantiate
  37     <filename>serial-getty@.service</filename> instances for
  38     virtualizer consoles, if execution in a virtualized environment is
  39     detected. If execution in a container environment is detected, it
  40     will instead enable <filename>console-getty.service</filename> for
  41     <filename>/dev/console</filename>, and
  42     <filename>container-getty@.service</filename> instances for
  43     additional container pseudo TTYs as requested by the container
  44     manager (see <ulink
  45     url="https://www.freedesktop.org/wiki/Software/systemd/ContainerInterface/"><filename>Container
  46     Interface</filename></ulink>). This should ensure that the user is
  47     shown a login prompt at the right place, regardless of which
  48     environment the system is started in. For example, it is
  49     sufficient to redirect the kernel console with a kernel command
  50     line argument such as <varname>console=</varname> to get both
  51     kernel messages and a getty prompt on a serial TTY. See <ulink
  52     url="https://www.kernel.org/doc/Documentation/admin-guide/kernel-parameters.txt"><filename>kernel-parameters.txt</filename></ulink>
  53     for more information on the <varname>console=</varname> kernel
  54     parameter.</para>
  55
  56     <para><filename>systemd-getty-generator</filename> implements
  57     <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
  58
  59     <para>Further information about configuration of gettys can be
  60     found in
  61     <ulink url="http://0pointer.de/blog/projects/serial-console.html">systemd
  62     for Administrators, Part XVI: Gettys on Serial Consoles (and
  63     Elsewhere)</ulink>.</para>
  64   </refsect1>
  65
  66   <refsect1>
  67     <title>See Also</title>
  68     <para>
  69       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  70       <citerefentry project='man-pages'><refentrytitle>agetty</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  71     </para>
  72   </refsect1>
  73
  74 </refentry>