summaryrefslogtreecommitdiff
path: root/man/systemd-suspend.service.xml
blob: 4a4ed5cbdb20e3389100a5509f94da9a19a4a843 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<?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
  Copyright 2013 Zbigniew Jędrzejewski-Szmek

  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-hybrid-sleep.service</refname>
                <refname>systemd-sleep</refname>
                <refpurpose>System sleep state logic</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <para><filename>systemd-suspend.service</filename></para>
                <para><filename>systemd-hibernate.service</filename></para>
                <para><filename>systemd-hybrid-sleep.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. Similarly,
                <filename>systemd-hibernate.service</filename> is
                pulled in by <filename>hibernate.target</filename> to
                execute the actual hibernation. Finally,
                <filename>systemd-hybrid-sleep.service</filename> is
                pulled in by <filename>hybrid-sleep.target</filename>
                to execute hybrid hibernation with system
                suspend.</para>

                <para>Immediately before entering system suspend
                and/or hibernation
                <filename>systemd-suspend.service</filename> (and the
                other mentioned units, respectively) 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>",
                "<literal>hibernate</literal>", or
                "<literal>hybrid-sleep</literal>" depending on the
                chosen action. Immediately after leaving system
                suspend and/or 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 until all executables
                have 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/hibernation and resume there are
                much nicer interfaces available.</para>

                <para>Note that
                <filename>systemd-suspend.service</filename>,
                <filename>systemd-hibernate.service</filename>, and
                <filename>systemd-hybrid-sleep.service</filename>
                should never be executed directly. Instead, trigger
                system sleep states with a command such as
                "<literal>systemctl suspend</literal>" or
                similar.</para>

                <para>Internally, this service will echo a string like
                "<literal>mem</literal>" into
                <filename>/sys/power/state</filename>, to trigger the
                actual system suspend. What exactly is written
                where can be configured in the <literal>[Sleep]</literal>
                section of <filename>/etc/systemd/sleep.conf</filename>.
                See <citerefentry><refentrytitle>systemd-sleep.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
                </para>
        </refsect1>

        <refsect1>
                <title>Options</title>

                <para><command>systemd-sleep</command> understands the
                following commands:</para>

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

                                <listitem><para>Print a short help
                                text and exit.</para></listitem>
                        </varlistentry>
                        <varlistentry>
                                <term><option>--version</option></term>

                                <listitem><para>Print the systemd version
                                identifier and exit.</para></listitem>
                        </varlistentry>
                        <varlistentry>
                                <term><option>suspend</option></term>
                                <term><option>hibernate</option></term>
                                <term><option>hybrid-sleep</option></term>

                                <listitem><para>Suspend, hibernate, or
                                put the system to hybrid sleep.</para>
                                </listitem>
                        </varlistentry>
                </variablelist>
        </refsect1>

        <refsect1>
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd-sleep.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <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>