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