f685b7027953690bef06588f1961688e7e55d4a4Lennart Poettering<!--*-nxml-*-->
12b42c76672a66c2d4ea7212c14f8f1b5a62b78dTom Gundersen<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
f685b7027953690bef06588f1961688e7e55d4a4Lennart Poettering This file is part of systemd.
f685b7027953690bef06588f1961688e7e55d4a4Lennart Poettering Copyright 2014 Lennart Poettering
f685b7027953690bef06588f1961688e7e55d4a4Lennart Poettering systemd is free software; you can redistribute it and/or modify it
f685b7027953690bef06588f1961688e7e55d4a4Lennart Poettering under the terms of the GNU Lesser General Public License as published by
f685b7027953690bef06588f1961688e7e55d4a4Lennart Poettering the Free Software Foundation; either version 2.1 of the License, or
f685b7027953690bef06588f1961688e7e55d4a4Lennart Poettering (at your option) any later version.
f685b7027953690bef06588f1961688e7e55d4a4Lennart Poettering systemd is distributed in the hope that it will be useful, but
f685b7027953690bef06588f1961688e7e55d4a4Lennart Poettering WITHOUT ANY WARRANTY; without even the implied warranty of
f685b7027953690bef06588f1961688e7e55d4a4Lennart Poettering MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
f685b7027953690bef06588f1961688e7e55d4a4Lennart Poettering Lesser General Public License for more details.
f685b7027953690bef06588f1961688e7e55d4a4Lennart Poettering You should have received a copy of the GNU Lesser General Public License
f685b7027953690bef06588f1961688e7e55d4a4Lennart Poettering along with systemd; If not, see <http://www.gnu.org/licenses/>.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <title>systemd-debug-generator</title>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <productname>systemd</productname>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <email>lennart@poettering.net</email>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <refentrytitle>systemd-debug-generator</refentrytitle>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <refname>systemd-debug-generator</refname>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <refpurpose>Generator for enabling a runtime debug shell and
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek masking specific units at boot</refpurpose>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <refsynopsisdiv>
12b42c76672a66c2d4ea7212c14f8f1b5a62b78dTom Gundersen <para><filename>/usr/lib/systemd/system-generators/systemd-debug-generator</filename></para>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek </refsynopsisdiv>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para><filename>systemd-debug-generator</filename> is a generator
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek that reads the kernel command line and understands three
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para>If the <option>systemd.mask=</option> option is specified
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek and followed by a unit name, this unit is masked for the runtime,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek similar to the effect of
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <command>mask</command> command. This is useful to boot with
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek certain units removed from the initial boot transaction for
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek debugging system startup. May be specified more than once.</para>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para>If the <option>systemd.wants=</option> option is specified
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek and followed by a unit name, a start job for this unit is added to
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek the initial transaction. This is useful to start one or more
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek additional units at boot. May be specified more than once.</para>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <para>If the <option>systemd.debug-shell</option> option is
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek specified, the debug shell service
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <literal>debug-shell.service</literal> is pulled into the boot
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek transaction. It will spawn a debug shell on tty9 during early
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek system startup. Note that the shell may also be turned on
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek persistently by enabling it with
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <command>enable</command> command.</para>
b1c1a51944e8e11545ae2a230d674f5145595192Zachary Cook <para><filename>systemd-debug-generator</filename> implements
b1c1a51944e8e11545ae2a230d674f5145595192Zachary Cook <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>