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.2/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   5
   6 <refentry id="systemd-bsod.service" conditional='HAVE_QRENCODE' xmlns:xi="http://www.w3.org/2001/XInclude">
   7
   8   <refentryinfo>
   9     <title>systemd-bsod</title>
  10     <productname>systemd</productname>
  11   </refentryinfo>
  12
  13   <refmeta>
  14     <refentrytitle>systemd-bsod.service</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>systemd-bsod.service</refname>
  20     <refname>systemd-bsod</refname>
  21     <refpurpose>Displays boot-time emergency log message in full screen</refpurpose>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <para><filename>systemd-bsod.service</filename></para>
  26     <cmdsynopsis>
  27       <command>systemd-bsod</command>
  28       <arg choice="opt" rep="repeat">OPTIONS</arg>
  29     </cmdsynopsis>
  30   </refsynopsisdiv>
  31
  32   <refsect1>
  33     <title>Description</title>
  34
  35     <para><filename>systemd-bsod.service</filename> is used to display a blue screen which contains a message
  36     relating to a boot failure, including a QR code which can be scanned to get helpful information about the
  37     failure.</para>
  38   </refsect1>
  39
  40   <refsect1>
  41     <title>Options</title>
  42
  43     <para>The following options are understood by <command>systemd-bsod</command>:</para>
  44
  45     <variablelist>
  46       <xi:include href="standard-options.xml" xpointer="help" />
  47       <xi:include href="standard-options.xml" xpointer="version" />
  48
  49       <varlistentry>
  50         <term><option>-c</option></term>
  51         <term><option>--continuous</option></term>
  52
  53         <listitem><para>When specified, <command>systemd-bsod</command> waits continuously for changes in the
  54         journal if it doesn't find any emergency messages on the initial attempt.</para>
  55
  56          <xi:include href="version-info.xml" xpointer="v255"/></listitem>
  57       </varlistentry>
  58     </variablelist>
  59
  60   </refsect1>
  61
  62   <refsect1>
  63     <title>Exit status</title>
  64
  65     <para>On success (displaying the journal message successfully), 0 is returned, a non-zero failure code otherwise.</para>
  66   </refsect1>
  67
  68   <refsect1>
  69     <title>See Also</title>
  70     <para>
  71       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  72     </para>
  73   </refsect1>
  74
  75 </refentry>