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