[systemd-commits] 2 commits - Makefile.am man/systemd-halt.service.xml man/systemd-hostnamed.service.xml man/systemd-suspend.service.xml units/systemd-halt.service.in units/systemd-hibernate.service.in units/systemd-kexec.service.in units/systemd-poweroff.service.in units/systemd-reboot.service.in units/systemd-suspend.service.in
Lennart Poettering
lennart at kemper.freedesktop.org
Tue Jun 26 08:50:47 PDT 2012
Makefile.am | 18 ++++-
man/systemd-halt.service.xml | 119 +++++++++++++++++++++++++++++++++++++
man/systemd-hostnamed.service.xml | 2
man/systemd-suspend.service.xml | 111 ++++++++++++++++++++++++++++++++++
units/systemd-halt.service.in | 1
units/systemd-hibernate.service.in | 1
units/systemd-kexec.service.in | 1
units/systemd-poweroff.service.in | 1
units/systemd-reboot.service.in | 1
units/systemd-suspend.service.in | 1
10 files changed, 253 insertions(+), 3 deletions(-)
New commits:
commit 0127336c01198ef210882207d24257cb3752718b
Author: Lennart Poettering <lennart at poettering.net>
Date: Tue Jun 26 17:50:29 2012 +0200
man: document systemd-halt.service and friends
diff --git a/Makefile.am b/Makefile.am
index 4de639d..7b8710b 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -492,7 +492,8 @@ MANPAGES = \
man/systemd-update-utmp-runlevel.service.8 \
man/systemd-initctl.service.8 \
man/systemd-shutdownd.service.8 \
- man/systemd-suspend.service.8
+ man/systemd-suspend.service.8 \
+ man/systemd-halt.service.8
MANPAGES_ALIAS = \
man/reboot.8 \
@@ -507,7 +508,11 @@ MANPAGES_ALIAS = \
man/systemd-initctl.8 \
man/systemd-shutdownd.8 \
man/systemd-hibernate.service.8 \
- man/systemd-sleep.8
+ man/systemd-sleep.8 \
+ man/systemd-shutdown.8 \
+ man/systemd-poweroff.service.8 \
+ man/systemd-reboot.service.8 \
+ man/systemd-kexec.service.8
man/reboot.8: man/halt.8
man/poweroff.8: man/halt.8
@@ -522,6 +527,10 @@ man/systemd-initctl.8: man/systemd-initctl.service.8
man/systemd-shutdownd.8: man/systemd-shutdownd.service.8
man/systemd-hibernate.service.8: man/systemd-suspend.service.8
man/systemd-sleep.8: man/systemd-suspend.service.8
+man/systemd-shutdown.8: man/systemd-halt.service.8
+man/systemd-poweroff.service.8: man/systemd-halt.service.8
+man/systemd-reboot.service.8: man/systemd-halt.service.8
+man/systemd-kexec.service.8: man/systemd-halt.service.8
XML_FILES = \
${patsubst %.1,%.xml,${patsubst %.3,%.xml,${patsubst %.5,%.xml,${patsubst %.7,%.xml,${patsubst %.8,%.xml,$(MANPAGES)}}}}}
diff --git a/man/systemd-halt.service.xml b/man/systemd-halt.service.xml
new file mode 100644
index 0000000..6957fb9
--- /dev/null
+++ b/man/systemd-halt.service.xml
@@ -0,0 +1,119 @@
+<?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 2012 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="systemd-halt.service">
+
+ <refentryinfo>
+ <title>systemd-halt.service</title>
+ <productname>systemd</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Lennart</firstname>
+ <surname>Poettering</surname>
+ <email>lennart at poettering.net</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>systemd-halt.service</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>systemd-halt.service</refname>
+ <refname>systemd-poweroff.service</refname>
+ <refname>systemd-reboot.service</refname>
+ <refname>systemd-kexec.service</refname>
+ <refname>systemd-shutdown</refname>
+ <refpurpose>systemd System Shutdown Logic</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <para><filename>systemd-halt.service</filename></para>
+ <para><filename>systemd-poweroff.service</filename></para>
+ <para><filename>systemd-reboot.service</filename></para>
+ <para><filename>systemd-kexec.service</filename></para>
+ <para><filename>/usr/lib/systemd/systemd-shutdown</filename></para>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para><filename>systemd-halt.service</filename> is a
+ system service that is pulled in by
+ <filename>halt.target</filename> and is responsible
+ for the actual system halt. Similar,
+ <filename>systemd-poweroff.service</filename> is
+ pulled in by <filename>poweroff.target</filename>,
+ <filename>systemd-reboot.service</filename> by
+ <filename>reboot.target</filename> and
+ <filename>systemd-kexec.service</filename> by
+ <filename>kexec.target</filename> to execute the
+ respective actions.</para>
+
+ <para>When these services are run they ensure that PID
+ 1 is replaced by the
+ <filename>/usr/lib/systemd/system-shutdown</filename>
+ tool which is then responsible for the actual
+ shutdown. Before shutting down this binary will try to
+ unmount all remaining file systems, disable all
+ remaining swap devices, detach all remaining storage
+ devices and kill all remaining processes.</para>
+
+ <para>Immediately before executing the actual system
+ halt/poweroff/reboot/kexec
+ <filename>system-shutdown</filename> will run all
+ executables in
+ <filename>/usr/lib/systemd/system-shutdown/</filename>
+ and pass one arguments to them: either
+ "<literal>halt</literal>",
+ "<literal>poweroff</literal>",
+ "<literal>reboot</literal>" or
+ "<literal>kexec</literal>", depending on the chosen
+ action. All executables in this directory are executed
+ in parallel, and execution of the action is not
+ continued before all executables finished.</para>
+
+ <para>Note that
+ <filename>systemd-halt.service</filename> (and the
+ related units) should never be executed
+ directly. Instead, trigger system shutdown with a
+ command such as "<literal>systemctl halt</literal>" or
+ suchlike.</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>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd-suspend.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>
diff --git a/man/systemd-suspend.service.xml b/man/systemd-suspend.service.xml
index dea778f..1ae742b 100644
--- a/man/systemd-suspend.service.xml
+++ b/man/systemd-suspend.service.xml
@@ -46,7 +46,7 @@
<refname>systemd-suspend.service</refname>
<refname>systemd-hibernate.service</refname>
<refname>systemd-sleep</refname>
- <refpurpose>systemd System Suspend/Hibernate Logic</refpurpose>
+ <refpurpose>systemd System Sleep State Logic</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -74,13 +74,14 @@
and pass two arguments to them. The first argument
will be "<literal>pre</literal>", the second either
"<literal>suspend</literal>" or
- "<literal>hibernate</literal>", depending on the chosen
- action. Immediately after leaving system suspend and
- hibernation the same executables are run, but the
- first argument is now "<literal>post</literal>". All
- executables in this directory are executed in
- parallel, and execution of the action is not continued
- before all executables finished.</para>
+ "<literal>hibernate</literal>", depending on the
+ chosen action. Immediately after leaving system
+ suspend and hibernation the same executables are run,
+ but the first argument is now
+ "<literal>post</literal>". All executables in this
+ directory are executed in parallel, and execution of
+ the action is not continued before all executables
+ finished.</para>
<para>Note that scripts or binaries dropped in
<filename>/usr/lib/systemd/system-sleep/</filename>
@@ -89,13 +90,20 @@
of system suspend and resume there are much nicer
interfaces available.</para>
+ <para>Note that
+ <filename>systemd-suspend.service</filename> and
+ <filename>systemd-hibernate.service</filename> should
+ never be executed directly. Instead, trigger system
+ sleep states with a command such as "<literal>systemctl
+ suspend</literal>" or suchlike.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+ <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-halt.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
</para>
</refsect1>
diff --git a/units/systemd-halt.service.in b/units/systemd-halt.service.in
index b746d1e..d55d622 100644
--- a/units/systemd-halt.service.in
+++ b/units/systemd-halt.service.in
@@ -7,6 +7,7 @@
[Unit]
Description=Halt
+Documentation=man:systemd-halt.service(8)
DefaultDependencies=no
Requires=shutdown.target umount.target final.target
After=shutdown.target umount.target final.target
diff --git a/units/systemd-kexec.service.in b/units/systemd-kexec.service.in
index 17d0344..61303f9 100644
--- a/units/systemd-kexec.service.in
+++ b/units/systemd-kexec.service.in
@@ -7,6 +7,7 @@
[Unit]
Description=Reboot via kexec
+Documentation=man:systemd-halt.service(8)
DefaultDependencies=no
Requires=shutdown.target umount.target final.target
After=shutdown.target umount.target final.target
diff --git a/units/systemd-poweroff.service.in b/units/systemd-poweroff.service.in
index 851a0f9..3630719 100644
--- a/units/systemd-poweroff.service.in
+++ b/units/systemd-poweroff.service.in
@@ -7,6 +7,7 @@
[Unit]
Description=Power-Off
+Documentation=man:systemd-halt.service(8)
DefaultDependencies=no
Requires=shutdown.target umount.target final.target
After=shutdown.target umount.target final.target
diff --git a/units/systemd-reboot.service.in b/units/systemd-reboot.service.in
index e6a8aab..d99bd3e 100644
--- a/units/systemd-reboot.service.in
+++ b/units/systemd-reboot.service.in
@@ -7,6 +7,7 @@
[Unit]
Description=Reboot
+Documentation=man:systemd-halt.service(8)
DefaultDependencies=no
Requires=shutdown.target umount.target final.target
After=shutdown.target umount.target final.target
commit e2b696ee9bffad34daaafc99d3a5d8ee13504288
Author: Lennart Poettering <lennart at poettering.net>
Date: Tue Jun 26 17:33:11 2012 +0200
man: document systemd-suspend.service
diff --git a/Makefile.am b/Makefile.am
index 751511b..4de639d 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -491,7 +491,8 @@ MANPAGES = \
man/systemd-remount-fs.service.8 \
man/systemd-update-utmp-runlevel.service.8 \
man/systemd-initctl.service.8 \
- man/systemd-shutdownd.service.8
+ man/systemd-shutdownd.service.8 \
+ man/systemd-suspend.service.8
MANPAGES_ALIAS = \
man/reboot.8 \
@@ -504,7 +505,9 @@ MANPAGES_ALIAS = \
man/systemd-update-utmp-shutdown.service.8 \
man/systemd-update-utmp.8 \
man/systemd-initctl.8 \
- man/systemd-shutdownd.8
+ man/systemd-shutdownd.8 \
+ man/systemd-hibernate.service.8 \
+ man/systemd-sleep.8
man/reboot.8: man/halt.8
man/poweroff.8: man/halt.8
@@ -517,6 +520,8 @@ man/systemd-update-utmp-shutdown.service.8: man/systemd-update-utmp-runlevel.ser
man/systemd-update-utmp.8: man/systemd-update-utmp-runlevel.service.8
man/systemd-initctl.8: man/systemd-initctl.service.8
man/systemd-shutdownd.8: man/systemd-shutdownd.service.8
+man/systemd-hibernate.service.8: man/systemd-suspend.service.8
+man/systemd-sleep.8: man/systemd-suspend.service.8
XML_FILES = \
${patsubst %.1,%.xml,${patsubst %.3,%.xml,${patsubst %.5,%.xml,${patsubst %.7,%.xml,${patsubst %.8,%.xml,$(MANPAGES)}}}}}
diff --git a/man/systemd-hostnamed.service.xml b/man/systemd-hostnamed.service.xml
index 94ae062..f98663f 100644
--- a/man/systemd-hostnamed.service.xml
+++ b/man/systemd-hostnamed.service.xml
@@ -75,7 +75,7 @@
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sethostname</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
diff --git a/man/systemd-suspend.service.xml b/man/systemd-suspend.service.xml
new file mode 100644
index 0000000..dea778f
--- /dev/null
+++ b/man/systemd-suspend.service.xml
@@ -0,0 +1,103 @@
+<?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 2012 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="systemd-suspend.service">
+
+ <refentryinfo>
+ <title>systemd-suspend.service</title>
+ <productname>systemd</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Lennart</firstname>
+ <surname>Poettering</surname>
+ <email>lennart at poettering.net</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>systemd-suspend.service</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>systemd-suspend.service</refname>
+ <refname>systemd-hibernate.service</refname>
+ <refname>systemd-sleep</refname>
+ <refpurpose>systemd System Suspend/Hibernate Logic</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <para><filename>systemd-suspend.service</filename></para>
+ <para><filename>systemd-hibernate.service</filename></para>
+ <para><filename>/usr/lib/systemd/systemd-sleep</filename></para>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para><filename>systemd-suspend.service</filename> is
+ a system service that is pulled in by
+ <filename>suspend.target</filename> and is responsible
+ for the actual system suspend. Similar,
+ <filename>systemd-hibernate.service</filename> is
+ pulled in by <filename>hibernate.target</filename> to
+ executed the actual hibernation.</para>
+
+ <para>Immediately before entering system suspend and
+ hibernation
+ <filename>systemd-suspend.service</filename> will run
+ all executables in
+ <filename>/usr/lib/systemd/system-sleep/</filename>
+ and pass two arguments to them. The first argument
+ will be "<literal>pre</literal>", the second either
+ "<literal>suspend</literal>" or
+ "<literal>hibernate</literal>", depending on the chosen
+ action. Immediately after leaving system suspend and
+ hibernation the same executables are run, but the
+ first argument is now "<literal>post</literal>". All
+ executables in this directory are executed in
+ parallel, and execution of the action is not continued
+ before all executables finished.</para>
+
+ <para>Note that scripts or binaries dropped in
+ <filename>/usr/lib/systemd/system-sleep/</filename>
+ are intended for local use only and should be
+ considered hacks. If applications want to be notified
+ of system suspend and resume there are much nicer
+ interfaces available.</para>
+
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+ <para>
+ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+ <citerefentry><refentrytitle>systemd-halt.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>
diff --git a/units/systemd-hibernate.service.in b/units/systemd-hibernate.service.in
index 6dba653..29d9b69 100644
--- a/units/systemd-hibernate.service.in
+++ b/units/systemd-hibernate.service.in
@@ -7,6 +7,7 @@
[Unit]
Description=Hibernate
+Documentation=man:systemd-suspend.service(8)
DefaultDependencies=no
Requires=sleep.target
After=sleep.target
diff --git a/units/systemd-suspend.service.in b/units/systemd-suspend.service.in
index 3cf819e..3a702d2 100644
--- a/units/systemd-suspend.service.in
+++ b/units/systemd-suspend.service.in
@@ -7,6 +7,7 @@
[Unit]
Description=Suspend
+Documentation=man:systemd-suspend.service(8)
DefaultDependencies=no
Requires=sleep.target
After=sleep.target
More information about the systemd-commits
mailing list