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