chiark / gitweb /
rtnl: match - only match on one type at a time
[elogind.git] / 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
26         <refentryinfo>
27                 <title>halt</title>
28                 <productname>systemd</productname>
29
30                 <authorgroup>
31                         <author>
32                                 <contrib>Developer</contrib>
33                                 <firstname>Lennart</firstname>
34                                 <surname>Poettering</surname>
35                                 <email>lennart@poettering.net</email>
36                         </author>
37                 </authorgroup>
38         </refentryinfo>
39
40         <refmeta>
41                 <refentrytitle>halt</refentrytitle>
42                 <manvolnum>8</manvolnum>
43         </refmeta>
44
45         <refnamediv>
46                 <refname>halt</refname>
47                 <refname>poweroff</refname>
48                 <refname>reboot</refname>
49                 <refpurpose>Halt, power-off or reboot the machine</refpurpose>
50         </refnamediv>
51
52         <refsynopsisdiv>
53                 <cmdsynopsis>
54                         <command>halt <arg choice="opt" rep="repeat">OPTIONS</arg></command>
55                 </cmdsynopsis>
56                 <cmdsynopsis>
57                         <command>poweroff <arg choice="opt" rep="repeat">OPTIONS</arg></command>
58                 </cmdsynopsis>
59                 <cmdsynopsis>
60                         <command>reboot <arg choice="opt" rep="repeat">OPTIONS</arg></command>
61                 </cmdsynopsis>
62         </refsynopsisdiv>
63
64         <refsect1>
65                 <title>Description</title>
66
67                 <para><command>halt</command>,
68                 <command>poweroff</command>, <command>reboot</command>
69                 may be used to halt, power-off or reboot the
70                 machine.</para>
71
72         </refsect1>
73
74         <refsect1>
75                 <title>Options</title>
76
77                 <para>The following options are understood:</para>
78
79                 <variablelist>
80                         <varlistentry>
81                                 <term><option>--help</option></term>
82
83                                 <listitem><para>Prints a short help
84                                 text and exits.</para></listitem>
85                         </varlistentry>
86
87                         <varlistentry>
88                                 <term><option>--halt</option></term>
89
90                                 <listitem><para>Halt the machine,
91                                 regardless of which one of the three
92                                 commands is invoked.</para></listitem>
93                         </varlistentry>
94
95                         <varlistentry>
96                                 <term><option>-p</option></term>
97                                 <term><option>--poweroff</option></term>
98
99                                 <listitem><para>Power-off the machine,
100                                 regardless of which one of the three
101                                 commands is invoked.</para></listitem>
102                         </varlistentry>
103
104                         <varlistentry>
105                                 <term><option>--reboot</option></term>
106
107                                 <listitem><para>Reboot the machine,
108                                 regardless of which one of the three
109                                 commands is invoked.</para></listitem>
110                         </varlistentry>
111
112                         <varlistentry>
113                                 <term><option>-f</option></term>
114                                 <term><option>--force</option></term>
115
116                                 <listitem><para>Force immediate halt,
117                                 power-off, reboot. Do not contact the
118                                 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
126                                 shutdown entry, do not actually halt,
127                                 power-off, reboot.</para></listitem>
128                         </varlistentry>
129
130                         <varlistentry>
131                                 <term><option>-d</option></term>
132                                 <term><option>--no-wtmp</option></term>
133
134                                 <listitem><para>Do not write wtmp
135                                 shutdown entry.</para></listitem>
136                         </varlistentry>
137
138                         <varlistentry>
139                                 <term><option>--no-wall</option></term>
140
141                                 <listitem><para>Do not send wall
142                                 message before
143                                 halt, power-off, reboot.</para></listitem>
144                         </varlistentry>
145                 </variablelist>
146         </refsect1>
147
148         <refsect1>
149                 <title>Exit status</title>
150
151                 <para>On success 0 is returned, a non-zero failure
152                 code otherwise.</para>
153         </refsect1>
154
155         <refsect1>
156                 <title>Notes</title>
157
158                 <para>These are legacy commands available for
159                 compatibility only.</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><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
169                 </para>
170         </refsect1>
171
172 </refentry>