man: xinclude pkg-config note

[thirdparty/systemd.git] / man / halt.xml

<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  This file is part of systemd.

  Copyright 2010 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="halt"
          xmlns:xi="http://www.w3.org/2001/XInclude">

        <refentryinfo>
                <title>halt</title>
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Lennart</firstname>
                                <surname>Poettering</surname>
                                <email>lennart@poettering.net</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>halt</refentrytitle>
                <manvolnum>8</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>halt</refname>
                <refname>poweroff</refname>
                <refname>reboot</refname>
                <refpurpose>Halt, power-off or reboot the machine</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <cmdsynopsis>
                        <command>halt <arg choice="opt" rep="repeat">OPTIONS</arg></command>
                </cmdsynopsis>
                <cmdsynopsis>
                        <command>poweroff <arg choice="opt" rep="repeat">OPTIONS</arg></command>
                </cmdsynopsis>
                <cmdsynopsis>
                        <command>reboot <arg choice="opt" rep="repeat">OPTIONS</arg></command>
                </cmdsynopsis>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para><command>halt</command>,
                <command>poweroff</command>, <command>reboot</command>
                may be used to halt, power-off or reboot the
                machine.</para>

        </refsect1>

        <refsect1>
                <title>Options</title>

                <para>The following options are understood:</para>

                <variablelist>
                        <varlistentry>
                                <term><option>--help</option></term>

                                <xi:include href="standard-options.xml" xpointer="help-text" />
                        </varlistentry>

                        <varlistentry>
                                <term><option>--halt</option></term>

                                <listitem><para>Halt the machine,
                                regardless of which one of the three
                                commands is invoked.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-p</option></term>
                                <term><option>--poweroff</option></term>

                                <listitem><para>Power-off the machine,
                                regardless of which one of the three
                                commands is invoked.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--reboot</option></term>

                                <listitem><para>Reboot the machine,
                                regardless of which one of the three
                                commands is invoked.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-f</option></term>
                                <term><option>--force</option></term>

                                <listitem><para>Force immediate halt,
                                power-off, reboot. Do not contact the
                                init system.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-w</option></term>
                                <term><option>--wtmp-only</option></term>

                                <listitem><para>Only write wtmp
                                shutdown entry, do not actually halt,
                                power-off, reboot.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-d</option></term>
                                <term><option>--no-wtmp</option></term>

                                <listitem><para>Do not write wtmp
                                shutdown entry.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--no-wall</option></term>

                                <listitem><para>Do not send wall
                                message before
                                halt, power-off, reboot.</para></listitem>
                        </varlistentry>
                </variablelist>
        </refsect1>

        <refsect1>
                <title>Exit status</title>

                <para>On success, 0 is returned, a non-zero failure
                code otherwise.</para>
        </refsect1>

        <refsect1>
                <title>Notes</title>

                <para>These are legacy commands available for
                compatibility only.</para>
        </refsect1>

        <refsect1>
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>