]> git.proxmox.com Git - systemd.git/blob - man/systemd-sleep.conf.5
Imported Upstream version 217
[systemd.git] / man / systemd-sleep.conf.5
1 '\" t
2 .TH "SYSTEMD\-SLEEP\&.CONF" "5" "" "systemd 217" "systemd-sleep.conf"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 systemd-sleep.conf \- Suspend and hibernation configuration file
24 .SH "SYNOPSIS"
25 .PP
26 /etc/systemd/sleep\&.conf
27 .SH "DESCRIPTION"
28 .PP
29 \fBsystemd\fR
30 supports three general power\-saving modes:
31 .PP
32 suspend
33 .RS 4
34 a low\-power state where execution of the OS is paused, and complete power loss might result in lost data, and which is fast to enter and exit\&. This corresponds to suspend, standby, or freeze states as understood by the kernel\&.
35 .RE
36 .PP
37 hibernate
38 .RS 4
39 a low\-power state where execution of the OS is paused, and complete power loss does not result in lost data, and which might be slow to enter and exit\&. This corresponds to the hibernation as understood by the kernel\&.
40 .RE
41 .PP
42 hybrid\-sleep
43 .RS 4
44 a low\-power state where execution of the OS is paused, which might be slow to enter, and on complete power loss does not result in lost data but might be slower to exit in that case\&. This mode is called suspend\-to\-both by the kernel\&.
45 .RE
46 .PP
47 Settings in this file determine what strings will be written to
48 /sys/power/disk
49 and
50 /sys/power/state
51 by
52 \fBsystemd-sleep\fR(8)
53 when
54 \fBsystemd\fR(1)
55 attempts to suspend or hibernate the machine\&.
56 .SH "OPTIONS"
57 .PP
58 The following options can be configured in the
59 "[Sleep]"
60 section of
61 /etc/systemd/sleep\&.conf:
62 .PP
63 \fISuspendMode=\fR, \fIHibernateMode=\fR, \fIHybridSleepMode=\fR
64 .RS 4
65 The string to be written to
66 /sys/power/disk
67 by, respectively,
68 \fBsystemd-suspend.service\fR(8),
69 \fBsystemd-hibernate.service\fR(8), or
70 \fBsystemd-hybrid-sleep.service\fR(8)\&. More than one value can be specified by separating multiple values with whitespace\&. They will be tried in turn, until one is written without error\&. If neither succeeds, the operation will be aborted\&.
71 .RE
72 .PP
73 \fISuspendState=\fR, \fIHibernateState=\fR, \fIHybridSleepState=\fR
74 .RS 4
75 The string to be written to
76 /sys/power/state
77 by, respectively,
78 \fBsystemd-suspend.service\fR(8),
79 \fBsystemd-hibernate.service\fR(8), or
80 \fBsystemd-hybrid-sleep.service\fR(8)\&. More than one value can be specified by separating multiple values with whitespace\&. They will be tried in turn, until one is written without error\&. If neither succeeds, the operation will be aborted\&.
81 .RE
82 .SH "EXAMPLE: FREEZE"
83 .PP
84 Example: to exploit the
85 \(lqfreeze\(rq
86 mode added in Linux 3\&.9, one can use
87 \fBsystemctl suspend\fR
88 with
89 .sp
90 .if n \{\
91 .RS 4
92 .\}
93 .nf
94 [Sleep]
95 SuspendState=freeze
96 .fi
97 .if n \{\
98 .RE
99 .\}
100 .SH "SEE ALSO"
101 .PP
102 \fBsystemd-sleep\fR(8),
103 \fBsystemd-suspend.service\fR(8),
104 \fBsystemd-hibernate.service\fR(8),
105 \fBsystemd-hybrid-sleep.service\fR(8),
106 \fBsystemd\fR(1),
107 \fBsystemd.directives\fR(7)