man/systemd-getty-generator.xml

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