man/systemd-bsod.service.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   5
   6 <refentry id="systemd-bsod.service" conditional='HAVE_QRENCODE ENABLE_INITRD'
   7           xmlns:xi="http://www.w3.org/2001/XInclude">
   8
   9   <refentryinfo>
  10     <title>systemd-bsod</title>
  11     <productname>systemd</productname>
  12   </refentryinfo>
  13
  14   <refmeta>
  15     <refentrytitle>systemd-bsod.service</refentrytitle>
  16     <manvolnum>8</manvolnum>
  17   </refmeta>
  18
  19   <refnamediv>
  20     <refname>systemd-bsod.service</refname>
  21     <refname>systemd-bsod</refname>
  22     <refpurpose>Displays boot-time emergency log message in full screen</refpurpose>
  23   </refnamediv>
  24
  25   <refsynopsisdiv>
  26     <para><filename>systemd-bsod.service</filename></para>
  27     <cmdsynopsis>
  28       <command>/usr/lib/systemd/systemd-bsod</command>
  29       <arg choice="opt" rep="repeat">OPTIONS</arg>
  30     </cmdsynopsis>
  31   </refsynopsisdiv>
  32
  33   <refsect1>
  34     <title>Description</title>
  35
  36     <para><filename>systemd-bsod.service</filename> is used to display a blue screen which contains a message
  37     relating to a boot failure, including a QR code which can be scanned to get helpful information about the
  38     failure.</para>
  39   </refsect1>
  40
  41   <refsect1>
  42     <title>Options</title>
  43
  44     <para>The following options are understood by <command>systemd-bsod</command>:</para>
  45
  46     <variablelist>
  47       <xi:include href="standard-options.xml" xpointer="help" />
  48       <xi:include href="standard-options.xml" xpointer="version" />
  49
  50       <varlistentry>
  51         <term><option>-c</option></term>
  52         <term><option>--continuous</option></term>
  53
  54         <listitem><para>When specified, <command>systemd-bsod</command> waits continuously for changes in the
  55         journal if it doesn't find any emergency messages on the initial attempt.</para>
  56
  57          <xi:include href="version-info.xml" xpointer="v255"/></listitem>
  58       </varlistentry>
  59
  60       <varlistentry>
  61         <term><option>--tty=</option><replaceable></replaceable></term>
  62
  63         <listitem><para>Specify the TTY to output to. By default <command>systemd-bsod</command> will
  64         automatically find a free VT to display the message on. If this option is specified a TTY may be
  65         selected explicitly. Use <option>--tty=/dev/tty</option> to direct output to the terminal the command
  66         is invoked on.</para>
  67
  68          <xi:include href="version-info.xml" xpointer="v256"/></listitem>
  69       </varlistentry>
  70     </variablelist>
  71
  72   </refsect1>
  73
  74   <refsect1>
  75     <title>Exit status</title>
  76
  77     <para>On success (displaying the journal message successfully), 0 is returned, a non-zero failure code otherwise.</para>
  78   </refsect1>
  79
  80   <refsect1>
  81     <title>See Also</title>
  82     <para>
  83       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  84     </para>
  85   </refsect1>
  86
  87 </refentry>