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   systemd is free software; you can redistribute it and/or modify it
  13   under the terms of the GNU Lesser General Public License as published by
  14   the Free Software Foundation; either version 2.1 of the License, or
  15   (at your option) any later version.
  16
  17   systemd is distributed in the hope that it will be useful, but
  18   WITHOUT ANY WARRANTY; without even the implied warranty of
  19   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20   Lesser General Public License for more details.
  21
  22   You should have received a copy of the GNU Lesser General Public License
  23   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  24 -->
  25
  26 <refentry id="halt"
  27     xmlns:xi="http://www.w3.org/2001/XInclude">
  28
  29   <refentryinfo>
  30     <title>halt</title>
  31     <productname>systemd</productname>
  32
  33     <authorgroup>
  34       <author>
  35         <contrib>Developer</contrib>
  36         <firstname>Lennart</firstname>
  37         <surname>Poettering</surname>
  38         <email>lennart@poettering.net</email>
  39       </author>
  40     </authorgroup>
  41   </refentryinfo>
  42
  43   <refmeta>
  44     <refentrytitle>halt</refentrytitle>
  45     <manvolnum>8</manvolnum>
  46   </refmeta>
  47
  48   <refnamediv>
  49     <refname>halt</refname>
  50     <refname>poweroff</refname>
  51     <refname>reboot</refname>
  52     <refpurpose>Halt, power-off or reboot the machine</refpurpose>
  53   </refnamediv>
  54
  55   <refsynopsisdiv>
  56     <cmdsynopsis>
  57       <command>halt</command>
  58       <arg choice="opt" rep="repeat">OPTIONS</arg>
  59     </cmdsynopsis>
  60     <cmdsynopsis>
  61       <command>poweroff</command>
  62       <arg choice="opt" rep="repeat">OPTIONS</arg>
  63     </cmdsynopsis>
  64     <cmdsynopsis>
  65       <command>reboot</command>
  66       <arg choice="opt" rep="repeat">OPTIONS</arg>
  67     </cmdsynopsis>
  68   </refsynopsisdiv>
  69
  70   <refsect1>
  71     <title>Description</title>
  72
  73     <para><command>halt</command>, <command>poweroff</command>,
  74     <command>reboot</command> may be used to halt, power-off or reboot
  75     the machine.</para>
  76
  77   </refsect1>
  78
  79   <refsect1>
  80     <title>Options</title>
  81
  82     <para>The following options are understood:</para>
  83
  84     <variablelist>
  85       <varlistentry>
  86         <term><option>--help</option></term>
  87
  88         <xi:include href="standard-options.xml" xpointer="help-text" />
  89       </varlistentry>
  90
  91       <varlistentry>
  92         <term><option>--halt</option></term>
  93
  94         <listitem><para>Halt the machine, regardless of which one of
  95         the three commands is invoked.</para></listitem>
  96       </varlistentry>
  97
  98       <varlistentry>
  99         <term><option>-p</option></term>
 100         <term><option>--poweroff</option></term>
 101
 102         <listitem><para>Power-off the machine, regardless of which one
 103         of the three commands is invoked.</para></listitem>
 104       </varlistentry>
 105
 106       <varlistentry>
 107         <term><option>--reboot</option></term>
 108
 109         <listitem><para>Reboot the machine, regardless of which one of
 110         the three commands is invoked.</para></listitem>
 111       </varlistentry>
 112
 113       <varlistentry>
 114         <term><option>-f</option></term>
 115         <term><option>--force</option></term>
 116
 117         <listitem><para>Force immediate halt, power-off, reboot. Do
 118         not contact the init system.</para></listitem>
 119       </varlistentry>
 120
 121       <varlistentry>
 122         <term><option>-w</option></term>
 123         <term><option>--wtmp-only</option></term>
 124
 125         <listitem><para>Only write wtmp shutdown entry, do not
 126         actually halt, power-off, reboot.</para></listitem>
 127       </varlistentry>
 128
 129       <varlistentry>
 130         <term><option>-d</option></term>
 131         <term><option>--no-wtmp</option></term>
 132
 133         <listitem><para>Do not write wtmp shutdown
 134         entry.</para></listitem>
 135       </varlistentry>
 136
 137       <varlistentry>
 138         <term><option>-n</option></term>
 139         <term><option>--no-sync</option></term>
 140
 141         <listitem><para>Don't sync hard disks/storage media before
 142         halt, power-off, reboot.</para></listitem>
 143       </varlistentry>
 144
 145       <varlistentry>
 146         <term><option>--no-wall</option></term>
 147
 148         <listitem><para>Do not send wall message before halt,
 149         power-off, reboot.</para></listitem>
 150       </varlistentry>
 151     </variablelist>
 152   </refsect1>
 153
 154   <refsect1>
 155     <title>Exit status</title>
 156
 157     <para>On success, 0 is returned, a non-zero failure code
 158     otherwise.</para>
 159   </refsect1>
 160
 161   <refsect1>
 162     <title>Notes</title>
 163
 164     <para>These are legacy commands available for compatibility
 165     only.</para>
 166   </refsect1>
 167
 168   <refsect1>
 169     <title>See Also</title>
 170     <para>
 171       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 172       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 173       <citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 174       <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 175     </para>
 176   </refsect1>
 177
 178 </refentry>