systemd-suspend.service.xml revision bb31a4ac1997c189a344caf554f34c6aabc71aa7
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
<!--
This file is part of systemd.
Copyright 2012 Lennart Poettering
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>
<productname>systemd</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Lennart</firstname>
<surname>Poettering</surname>
<email>lennart@poettering.net</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd-sleep</refname>
<refpurpose>System sleep state logic</refpurpose>
</refnamediv>
<refsynopsisdiv>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
a system service that is pulled in by
for the actual system suspend. Similar,
execute the actual hibernation.</para>
<para>Immediately before entering system suspend and
hibernation
all executables in
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
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>
<para>Note that
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>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>
</refentry>