man/halt.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   SPDX-License-Identifier: LGPL-2.1+
   7 -->
   8
   9 <refentry id="halt"
  10     xmlns:xi="http://www.w3.org/2001/XInclude">
  11
  12   <refentryinfo>
  13     <title>halt</title>
  14     <productname>systemd</productname>
  15   </refentryinfo>
  16
  17   <refmeta>
  18     <refentrytitle>halt</refentrytitle>
  19     <manvolnum>8</manvolnum>
  20   </refmeta>
  21
  22   <refnamediv>
  23     <refname>halt</refname>
  24     <refname>poweroff</refname>
  25     <refname>reboot</refname>
  26     <refpurpose>Halt, power-off or reboot the machine</refpurpose>
  27   </refnamediv>
  28
  29   <refsynopsisdiv>
  30     <cmdsynopsis>
  31       <command>halt</command>
  32       <arg choice="opt" rep="repeat">OPTIONS</arg>
  33     </cmdsynopsis>
  34     <cmdsynopsis>
  35       <command>poweroff</command>
  36       <arg choice="opt" rep="repeat">OPTIONS</arg>
  37     </cmdsynopsis>
  38     <cmdsynopsis>
  39       <command>reboot</command>
  40       <arg choice="opt" rep="repeat">OPTIONS</arg>
  41     </cmdsynopsis>
  42   </refsynopsisdiv>
  43
  44   <refsect1>
  45     <title>Description</title>
  46
  47     <para><command>halt</command>, <command>poweroff</command>,
  48     <command>reboot</command> may be used to halt, power-off or reboot
  49     the machine.</para>
  50
  51   </refsect1>
  52
  53   <refsect1>
  54     <title>Options</title>
  55
  56     <para>The following options are understood:</para>
  57
  58     <variablelist>
  59       <varlistentry>
  60         <term><option>--help</option></term>
  61
  62         <xi:include href="standard-options.xml" xpointer="help-text" />
  63       </varlistentry>
  64
  65       <varlistentry>
  66         <term><option>--halt</option></term>
  67
  68         <listitem><para>Halt the machine, regardless of which one of
  69         the three commands is invoked.</para></listitem>
  70       </varlistentry>
  71
  72       <varlistentry>
  73         <term><option>-p</option></term>
  74         <term><option>--poweroff</option></term>
  75
  76         <listitem><para>Power-off the machine, regardless of which one
  77         of the three commands is invoked.</para></listitem>
  78       </varlistentry>
  79
  80       <varlistentry>
  81         <term><option>--reboot</option></term>
  82
  83         <listitem><para>Reboot the machine, regardless of which one of
  84         the three commands is invoked.</para></listitem>
  85       </varlistentry>
  86
  87       <varlistentry>
  88         <term><option>-f</option></term>
  89         <term><option>--force</option></term>
  90
  91         <listitem><para>Force immediate halt, power-off, or reboot. When
  92         specified once, this results in an immediate but clean shutdown
  93         by the system manager. When specified twice, this results in an
  94         immediate shutdown without contacting the system manager. See the
  95         description of <option>--force</option> in
  96         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  97         for more details.</para></listitem>
  98       </varlistentry>
  99
 100       <varlistentry>
 101         <term><option>-w</option></term>
 102         <term><option>--wtmp-only</option></term>
 103
 104         <listitem><para>Only write wtmp shutdown entry, do not
 105         actually halt, power-off, reboot.</para></listitem>
 106       </varlistentry>
 107
 108       <varlistentry>
 109         <term><option>-d</option></term>
 110         <term><option>--no-wtmp</option></term>
 111
 112         <listitem><para>Do not write wtmp shutdown
 113         entry.</para></listitem>
 114       </varlistentry>
 115
 116       <varlistentry>
 117         <term><option>-n</option></term>
 118         <term><option>--no-sync</option></term>
 119
 120         <listitem><para>Don't sync hard disks/storage media before
 121         halt, power-off, reboot.</para></listitem>
 122       </varlistentry>
 123
 124       <varlistentry>
 125         <term><option>--no-wall</option></term>
 126
 127         <listitem><para>Do not send wall message before halt,
 128         power-off, reboot.</para></listitem>
 129       </varlistentry>
 130     </variablelist>
 131   </refsect1>
 132
 133   <refsect1>
 134     <title>Exit status</title>
 135
 136     <para>On success, 0 is returned, a non-zero failure code
 137     otherwise.</para>
 138   </refsect1>
 139
 140   <refsect1>
 141     <title>Notes</title>
 142
 143     <para>These commands are implemented in a way that preserves compatibility with
 144     the original SysV commands.
 145     <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 146     verbs <command>halt</command>, <command>poweroff</command>,
 147     <command>reboot</command> provide the same functionality with some additional
 148     features.</para>
 149   </refsect1>
 150
 151   <refsect1>
 152     <title>See Also</title>
 153     <para>
 154       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 155       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 156       <citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 157       <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 158     </para>
 159   </refsect1>
 160
 161 </refentry>