shaba/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2025-01-05 13:18:06 +03:00
Code
cb3801a4c9
systemd/man/poweroff.xml

179 lines
6.0 KiB
XML
Raw Normal View History

man: add more man pages
2010-06-24 02:11:04 +04:00
<?xml version='1.0'?> <!--*-nxml-*-->
man: use same header for all files The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml
2019-03-14 16:40:58 +03:00
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
man: use same version in public and system ident.
2023-12-25 17:48:33 +03:00
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
license: LGPL-2.1+ -> LGPL-2.1-or-later
2020-11-09 07:23:58 +03:00
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
man: add more man pages
2010-06-24 02:11:04 +04:00
man: deemphasize "halt" Systemd documents "halt" as the primary shutdown mechanism, redirecting "reboot" and "shutdown" to the halt(8), but halt is a really strange and obsolete concept. Who would want to really keep their machine running after shutdown? I expect that halting is almost unused. Let's at least make it less prominent in the docs. While at it, use "power off" for a verb and "power-off" for noun (but "poweroff" of the actual command name).
2022-12-06 13:27:31 +03:00
<refentry id="poweroff"
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
man: deemphasize "halt" Systemd documents "halt" as the primary shutdown mechanism, redirecting "reboot" and "shutdown" to the halt(8), but halt is a really strange and obsolete concept. Who would want to really keep their machine running after shutdown? I expect that halting is almost unused. Let's at least make it less prominent in the docs. While at it, use "power off" for a verb and "power-off" for noun (but "poweroff" of the actual command name).
2022-12-06 13:27:31 +03:00
<title>poweroff</title>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<productname>systemd</productname>
</refentryinfo>
<refmeta>
man: deemphasize "halt" Systemd documents "halt" as the primary shutdown mechanism, redirecting "reboot" and "shutdown" to the halt(8), but halt is a really strange and obsolete concept. Who would want to really keep their machine running after shutdown? I expect that halting is almost unused. Let's at least make it less prominent in the docs. While at it, use "power off" for a verb and "power-off" for noun (but "poweroff" of the actual command name).
2022-12-06 13:27:31 +03:00
<refentrytitle>poweroff</refentrytitle>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>poweroff</refname>
<refname>reboot</refname>
man: deemphasize "halt" Systemd documents "halt" as the primary shutdown mechanism, redirecting "reboot" and "shutdown" to the halt(8), but halt is a really strange and obsolete concept. Who would want to really keep their machine running after shutdown? I expect that halting is almost unused. Let's at least make it less prominent in the docs. While at it, use "power off" for a verb and "power-off" for noun (but "poweroff" of the actual command name).
2022-12-06 13:27:31 +03:00
<refname>halt</refname>
<refpurpose>Power off, reboot, or halt the machine</refpurpose>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
man: deemphasize "halt" Systemd documents "halt" as the primary shutdown mechanism, redirecting "reboot" and "shutdown" to the halt(8), but halt is a really strange and obsolete concept. Who would want to really keep their machine running after shutdown? I expect that halting is almost unused. Let's at least make it less prominent in the docs. While at it, use "power off" for a verb and "power-off" for noun (but "poweroff" of the actual command name).
2022-12-06 13:27:31 +03:00
<command>poweroff</command>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
<cmdsynopsis>
man: deemphasize "halt" Systemd documents "halt" as the primary shutdown mechanism, redirecting "reboot" and "shutdown" to the halt(8), but halt is a really strange and obsolete concept. Who would want to really keep their machine running after shutdown? I expect that halting is almost unused. Let's at least make it less prominent in the docs. While at it, use "power off" for a verb and "power-off" for noun (but "poweroff" of the actual command name).
2022-12-06 13:27:31 +03:00
<command>reboot</command>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
<cmdsynopsis>
man: deemphasize "halt" Systemd documents "halt" as the primary shutdown mechanism, redirecting "reboot" and "shutdown" to the halt(8), but halt is a really strange and obsolete concept. Who would want to really keep their machine running after shutdown? I expect that halting is almost unused. Let's at least make it less prominent in the docs. While at it, use "power off" for a verb and "power-off" for noun (but "poweroff" of the actual command name).
2022-12-06 13:27:31 +03:00
<command>halt</command>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
man: deemphasize "halt" Systemd documents "halt" as the primary shutdown mechanism, redirecting "reboot" and "shutdown" to the halt(8), but halt is a really strange and obsolete concept. Who would want to really keep their machine running after shutdown? I expect that halting is almost unused. Let's at least make it less prominent in the docs. While at it, use "power off" for a verb and "power-off" for noun (but "poweroff" of the actual command name).
2022-12-06 13:27:31 +03:00
<para><command>poweroff</command>, <command>reboot</command>, and <command>halt</command> may be used to
power off, reboot, or halt the machine. All three commands take the same options.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>--help</option></term>
man: wrap the whole description in <listitem> Unfortunately, version-info includes and standard-options includes are not composable...
2023-12-23 15:46:39 +03:00
<listitem>
<xi:include href="standard-options.xml" xpointer="help-para" />
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
man: wrap the whole description in <listitem> Unfortunately, version-info includes and standard-options includes are not composable...
2023-12-23 15:46:39 +03:00
<xi:include href="version-info.xml" xpointer="v253"/>
</listitem>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</varlistentry>
<varlistentry>
<term><option>--halt</option></term>
<listitem><para>Halt the machine, regardless of which one of
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
the three commands is invoked.</para>
<xi:include href="version-info.xml" xpointer="v253"/></listitem>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</varlistentry>
<varlistentry>
<term><option>-p</option></term>
<term><option>--poweroff</option></term>
man: deemphasize "halt" Systemd documents "halt" as the primary shutdown mechanism, redirecting "reboot" and "shutdown" to the halt(8), but halt is a really strange and obsolete concept. Who would want to really keep their machine running after shutdown? I expect that halting is almost unused. Let's at least make it less prominent in the docs. While at it, use "power off" for a verb and "power-off" for noun (but "poweroff" of the actual command name).
2022-12-06 13:27:31 +03:00
<listitem><para>Power off the machine, when either <command>halt</command>
man: document reboot --poweroff exception When reboot is invoked, the -p/--poweroff option is intentionally ignored. Update the man page to reflect this exception.
2022-10-28 18:01:15 +03:00
or <command>poweroff</command> is invoked. This option is ignored when
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<command>reboot</command> is invoked.</para>
<xi:include href="version-info.xml" xpointer="v253"/></listitem>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</varlistentry>
<varlistentry>
<term><option>--reboot</option></term>
<listitem><para>Reboot the machine, regardless of which one of
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
the three commands is invoked.</para>
<xi:include href="version-info.xml" xpointer="v253"/></listitem>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</varlistentry>
<varlistentry>
<term><option>-f</option></term>
<term><option>--force</option></term>
man: explicitly document that "reboot -f" is different from "systemctl reboot -f" Closes #24696.
2022-09-16 19:25:44 +03:00
<listitem>
man: deemphasize "halt" Systemd documents "halt" as the primary shutdown mechanism, redirecting "reboot" and "shutdown" to the halt(8), but halt is a really strange and obsolete concept. Who would want to really keep their machine running after shutdown? I expect that halting is almost unused. Let's at least make it less prominent in the docs. While at it, use "power off" for a verb and "power-off" for noun (but "poweroff" of the actual command name).
2022-12-06 13:27:31 +03:00
<para>Force immediate power-off, halt, or reboot. If specified, the command does not contact the
init system. In most cases, filesystems are not properly unmounted before shutdown. For example,
the command <command>reboot -f</command> is mostly equivalent to
<command>systemctl reboot -ff</command>, instead of <command>systemctl reboot -f</command>.
</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v253"/>
man: explicitly document that "reboot -f" is different from "systemctl reboot -f" Closes #24696.
2022-09-16 19:25:44 +03:00
</listitem>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</varlistentry>
<varlistentry>
<term><option>-w</option></term>
<term><option>--wtmp-only</option></term>
man: deemphasize "halt" Systemd documents "halt" as the primary shutdown mechanism, redirecting "reboot" and "shutdown" to the halt(8), but halt is a really strange and obsolete concept. Who would want to really keep their machine running after shutdown? I expect that halting is almost unused. Let's at least make it less prominent in the docs. While at it, use "power off" for a verb and "power-off" for noun (but "poweroff" of the actual command name).
2022-12-06 13:27:31 +03:00
<listitem><para>Only write wtmp shutdown entry, do not actually power off, reboot, or halt.
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
</para>
<xi:include href="version-info.xml" xpointer="v253"/></listitem>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</varlistentry>
<varlistentry>
<term><option>-d</option></term>
<term><option>--no-wtmp</option></term>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<listitem><para>Do not write wtmp shutdown entry.</para>
<xi:include href="version-info.xml" xpointer="v253"/></listitem>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</varlistentry>
systemctl: restore the no-sync option for legacy halt (#3249) The sync() call on shutdown had been removed with commit 57371e5829a61e5ee6c9f98404dfc729d6c62608 together with the no-sync option for the shutdown commands. The sync call was restored in commit 4a3ad39957399c4a30fc472a804e72907ecaa4f9 but the no-sync option wasn't re-added. I think we should restore this option at least for the legacy halt command.
2016-05-19 17:35:27 +03:00
<varlistentry>
<term><option>-n</option></term>
<term><option>--no-sync</option></term>
man: deemphasize "halt" Systemd documents "halt" as the primary shutdown mechanism, redirecting "reboot" and "shutdown" to the halt(8), but halt is a really strange and obsolete concept. Who would want to really keep their machine running after shutdown? I expect that halting is almost unused. Let's at least make it less prominent in the docs. While at it, use "power off" for a verb and "power-off" for noun (but "poweroff" of the actual command name).
2022-12-06 13:27:31 +03:00
<listitem><para>Don't sync hard disks/storage media before power-off, reboot, or halt.
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
</para>
<xi:include href="version-info.xml" xpointer="v253"/></listitem>
systemctl: restore the no-sync option for legacy halt (#3249) The sync() call on shutdown had been removed with commit 57371e5829a61e5ee6c9f98404dfc729d6c62608 together with the no-sync option for the shutdown commands. The sync call was restored in commit 4a3ad39957399c4a30fc472a804e72907ecaa4f9 but the no-sync option wasn't re-added. I think we should restore this option at least for the legacy halt command.
2016-05-19 17:35:27 +03:00
</varlistentry>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<varlistentry>
<term><option>--no-wall</option></term>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<listitem><para>Do not send wall message before power-off, reboot, or halt.</para>
<xi:include href="version-info.xml" xpointer="v253"/></listitem>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Exit status</title>
man: deemphasize "halt" Systemd documents "halt" as the primary shutdown mechanism, redirecting "reboot" and "shutdown" to the halt(8), but halt is a really strange and obsolete concept. Who would want to really keep their machine running after shutdown? I expect that halting is almost unused. Let's at least make it less prominent in the docs. While at it, use "power off" for a verb and "power-off" for noun (but "poweroff" of the actual command name).
2022-12-06 13:27:31 +03:00
<para>On success, 0 is returned, a non-zero failure code otherwise.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</refsect1>
<refsect1>
<title>Notes</title>
man: extend on halt documentation Based on the suggestions on #13254 and #13264 Fixes: #13254
2020-01-16 21:01:05 +03:00
<para>These commands are implemented in a way that preserves basic compatibility with the original SysV
man: deemphasize "halt" Systemd documents "halt" as the primary shutdown mechanism, redirecting "reboot" and "shutdown" to the halt(8), but halt is a really strange and obsolete concept. Who would want to really keep their machine running after shutdown? I expect that halting is almost unused. Let's at least make it less prominent in the docs. While at it, use "power off" for a verb and "power-off" for noun (but "poweroff" of the actual command name).
2022-12-06 13:27:31 +03:00
commands. <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
verbs <command>poweroff</command>, <command>reboot</command>, <command>halt</command> provide the same
man: extend on halt documentation Based on the suggestions on #13254 and #13264 Fixes: #13254
2020-01-16 21:01:05 +03:00
functionality with some additional features.</para>
<para>Note that on many SysV systems <command>halt</command> used to be synonymous to
<command>poweroff</command>, i.e. both commands would equally result in powering the machine off. systemd
is more accurate here, and <command>halt</command> results in halting the machine only (leaving power
on), and <command>poweroff</command> is required to actually power it off.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</refsect1>
<refsect1>
<title>See Also</title>
man: use <simplelist> for 'See also' sections This is just a slight markup improvement; there should be no difference in rendering.
2023-12-22 21:09:32 +03:00
<para><simplelist type="inline">
<member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
<member><citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
</simplelist></para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</refsect1>
man: add more man pages
2010-06-24 02:11:04 +04:00
</refentry>
Copy Permalink