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