man/systemd-debug-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   This file is part of systemd.
   6
   7   Copyright 2014 Lennart Poettering
   8
   9   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 -->
  22 <refentry id="systemd-debug-generator">
  23
  24   <refentryinfo>
  25     <title>systemd-debug-generator</title>
  26     <productname>systemd</productname>
  27
  28     <authorgroup>
  29       <author>
  30         <contrib>Developer</contrib>
  31         <firstname>Lennart</firstname>
  32         <surname>Poettering</surname>
  33         <email>lennart@poettering.net</email>
  34       </author>
  35     </authorgroup>
  36   </refentryinfo>
  37
  38   <refmeta>
  39     <refentrytitle>systemd-debug-generator</refentrytitle>
  40     <manvolnum>8</manvolnum>
  41   </refmeta>
  42
  43   <refnamediv>
  44     <refname>systemd-debug-generator</refname>
  45     <refpurpose>Generator for enabling a runtime debug shell and
  46     masking specific units at boot</refpurpose>
  47   </refnamediv>
  48
  49   <refsynopsisdiv>
  50     <para><filename>/usr/lib/systemd/system-generators/systemd-debug-generator</filename></para>
  51   </refsynopsisdiv>
  52
  53   <refsect1>
  54     <title>Description</title>
  55
  56     <para><filename>systemd-debug-generator</filename> is a generator
  57     that reads the kernel command line and understands three
  58     options:</para>
  59
  60     <para>If the <option>systemd.mask=</option> option is specified
  61     and followed by a unit name, this unit is masked for the runtime,
  62     similar to the effect of
  63     <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
  64     <command>mask</command> command. This is useful to boot with
  65     certain units removed from the initial boot transaction for
  66     debugging system startup. May be specified more than once.</para>
  67
  68     <para>If the <option>systemd.wants=</option> option is specified
  69     and followed by a unit name, a start job for this unit is added to
  70     the initial transaction. This is useful to start one or more
  71     additional units at boot. May be specified more than once.</para>
  72
  73     <para>If the <option>systemd.debug-shell</option> option is
  74     specified, the debug shell service
  75     <literal>debug-shell.service</literal> is pulled into the boot
  76     transaction. It will spawn a debug shell on tty9 during early
  77     system startup. Note that the shell may also be turned on
  78     persistently by enabling it with
  79     <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
  80     <command>enable</command> command.</para>
  81
  82     <para><filename>systemd-debug-generator</filename> implements the
  83     <ulink
  84     url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator
  85     specification</ulink>.</para>
  86   </refsect1>
  87
  88   <refsect1>
  89     <title>See Also</title>
  90     <para>
  91       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  92       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  93       <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  94     </para>
  95   </refsect1>
  96
  97 </refentry>