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