]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/systemd-getty-generator.xml
firstboot: Update help string with --root-shell options
[thirdparty/systemd.git] / man / systemd-getty-generator.xml
index adb48a7fd668edb6b48e6a8b33646fdb6ad10806..efd490bf3a5bae77f6faf3948e90d74cfbbb189f 100644 (file)
@@ -1,40 +1,13 @@
 <?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">
-<!--
-  SPDX-License-Identifier: LGPL-2.1+
-
-  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/>.
--->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!-- SPDX-License-Identifier: LGPL-2.1+ -->
 <refentry id="systemd-getty-generator">
 
   <refentryinfo>
     <title>systemd-getty-generator</title>
     <productname>systemd</productname>
-
-    <authorgroup>
-      <author>
-        <contrib>Developer</contrib>
-        <firstname>Lennart</firstname>
-        <surname>Poettering</surname>
-        <email>lennart@poettering.net</email>
-      </author>
-    </authorgroup>
   </refentryinfo>
 
   <refmeta>
   <refsect1>
     <title>Description</title>
 
-    <para><filename>systemd-getty-generator</filename> is a generator
-    that automatically instantiates
-    <filename>serial-getty@.service</filename> on the kernel
-    console(s), if they can function as ttys and are not provided by
-    the virtual console subsystem. It will also instantiate
-    <filename>serial-getty@.service</filename> instances for
-    virtualizer consoles, if execution in a virtualized environment is
-    detected. If execution in a container environment is detected, it
-    will instead enable <filename>console-getty.service</filename> for
-    <filename>/dev/console</filename>, and
-    <filename>container-getty@.service</filename> instances for
-    additional container pseudo TTYs as requested by the container
-    manager (see <ulink
-    url="https://www.freedesktop.org/wiki/Software/systemd/ContainerInterface/"><filename>Container
-    Interface</filename></ulink>). This should ensure that the user is
-    shown a login prompt at the right place, regardless of which
-    environment the system is started in. For example, it is
-    sufficient to redirect the kernel console with a kernel command
-    line argument such as <varname>console=</varname> to get both
-    kernel messages and a getty prompt on a serial TTY. See <ulink
-    url="https://www.kernel.org/doc/Documentation/kernel-parameters.txt"><filename>kernel-parameters.txt</filename></ulink>
-    for more information on the <varname>console=</varname> kernel
-    parameter.</para>
+    <para><filename>systemd-getty-generator</filename> is a generator that automatically instantiates
+    <filename>serial-getty@.service</filename> on the kernel console(s), if they can function as ttys and are
+    not provided by the virtual console subsystem. It will also instantiate
+    <filename>serial-getty@.service</filename> instances for virtualizer consoles, if execution in a
+    virtualized environment is detected. If execution in a container environment is detected, it will instead
+    enable <filename>console-getty.service</filename> for <filename>/dev/console</filename>, and
+    <filename>container-getty@.service</filename> instances for additional container pseudo TTYs as requested
+    by the container manager (see <ulink url="https://systemd.io/CONTAINER_INTERFACE"><filename>Container
+    Interface</filename></ulink>). This should ensure that the user is shown a login prompt at the right
+    place, regardless of which environment the system is started in. For example, it is sufficient to
+    redirect the kernel console with a kernel command line argument such as <varname>console=</varname> to
+    get both kernel messages and a getty prompt on a serial TTY. See <ulink
+    url="https://www.kernel.org/doc/Documentation/admin-guide/kernel-parameters.txt"><filename>kernel-parameters.txt</filename></ulink>
+    for more information on the <varname>console=</varname> kernel parameter.</para>
 
     <para><filename>systemd-getty-generator</filename> implements
     <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>