systemd-getty-generator.xml revision 798d3a524ea57aaf40cb53858aaa45ec702f012d
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering<?xml version="1.0"?>
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering<!--*-nxml-*-->
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering<!--
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering This file is part of systemd.
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering Copyright 2012 Lennart Poettering
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering systemd is free software; you can redistribute it and/or modify it
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering under the terms of the GNU Lesser General Public License as published by
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering the Free Software Foundation; either version 2.1 of the License, or
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering (at your option) any later version.
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering systemd is distributed in the hope that it will be useful, but
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering WITHOUT ANY WARRANTY; without even the implied warranty of
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering Lesser General Public License for more details.
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering You should have received a copy of the GNU Lesser General Public License
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering along with systemd; If not, see <http://www.gnu.org/licenses/>.
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering-->
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering<refentry id="systemd-getty-generator">
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <refentryinfo>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <title>systemd-getty-generator</title>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <productname>systemd</productname>
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <authorgroup>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <author>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <contrib>Developer</contrib>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <firstname>Lennart</firstname>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <surname>Poettering</surname>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <email>lennart@poettering.net</email>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek </author>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek </authorgroup>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek </refentryinfo>
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <refmeta>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <refentrytitle>systemd-getty-generator</refentrytitle>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <manvolnum>8</manvolnum>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek </refmeta>
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <refnamediv>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <refname>systemd-getty-generator</refname>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <refpurpose>Generator for enabling getty instances on the
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek console</refpurpose>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek </refnamediv>
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <refsynopsisdiv>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para><filename>/usr/lib/systemd/system-generators/systemd-getty-generator</filename></para>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek </refsynopsisdiv>
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <refsect1>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <title>Description</title>
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para><filename>systemd-getty-generator</filename> is a generator
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek that automatically instantiates
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <filename>serial-getty@.service</filename> on the kernel console
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <filename>/dev/console</filename> if that is not directed to the
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek virtual console subsystem. It will also instantiate
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <filename>serial-getty@.service</filename> instances for
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek virtualizer consoles, if execution in a virtualized environment is
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek detected. Finally, it will instantiate
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <filename>container-getty@.service</filename> instances for
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek additional container pseudo TTYs as requested by the container
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek manager (see <ulink
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek url="http://www.freedesktop.org/wiki/Software/systemd/ContainerInterface/"><filename>Container
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek Interface</filename></ulink>). This should ensure that the user is
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek shown a login prompt at the right place, regardless of which
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek environment the system is started in. For example, it is
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek sufficient to redirect the kernel console with a kernel command
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek line argument such as <varname>console=</varname> to get both
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek kernel messages and a getty prompt on a serial TTY. See <ulink
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek url="https://www.kernel.org/doc/Documentation/kernel-parameters.txt"><filename>kernel-parameters.txt</filename></ulink>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek for more information on the <varname>console=</varname> kernel
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek parameter.</para>
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para><filename>systemd-getty-generator</filename> implements the
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <ulink url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek specification</ulink>.</para>
00addadd86aff6187f1b7abe23bf1c42241b42d9Lennart Poettering
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para>Further information about configuration of gettys you may
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek find in
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <ulink url="http://0pointer.de/blog/projects/serial-console.html">systemd
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek for Administrators, Part XVI: Gettys on Serial Consoles (and
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek Elsewhere)</ulink>.</para>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek </refsect1>
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <refsect1>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <title>See Also</title>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <citerefentry project='man-pages'><refentrytitle>agetty</refentrytitle><manvolnum>8</manvolnum></citerefentry>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek </para>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek </refsect1>
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering</refentry>