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