summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--Makefile.am9
-rw-r--r--man/systemd-hostnamed.service.xml2
-rw-r--r--man/systemd-suspend.service.xml103
-rw-r--r--units/systemd-hibernate.service.in1
-rw-r--r--units/systemd-suspend.service.in1
5 files changed, 113 insertions, 3 deletions
diff --git a/Makefile.am b/Makefile.am
index 751511bc46..4de639dcee 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 94ae062ba7..f98663fea5 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 0000000000..dea778fbec
--- /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@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 6dba653d37..29d9b696a8 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 3cf819e476..3a702d2e22 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
generated by cgit v1.2.3-54-g00ecf (git 2.45.2) at 2024-11-05 04:17:35 +0000