Imported Upstream version 219

[systemd.git] / man / systemd-sleep.conf.5

'\" t
.TH "SYSTEMD\-SLEEP\&.CONF" "5" "" "systemd 219" "systemd-sleep.conf"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
systemd-sleep.conf, sleep.conf.d \- Suspend and hibernation configuration file
.SH "SYNOPSIS"
.PP
/etc/systemd/sleep\&.conf
.PP
/etc/systemd/sleep\&.conf\&.d/*\&.conf
.PP
/run/systemd/sleep\&.conf\&.d/*\&.conf
.PP
/usr/lib/systemd/sleep\&.conf\&.d/*\&.conf
.SH "DESCRIPTION"
.PP
\fBsystemd\fR
supports three general power\-saving modes:
.PP
suspend
.RS 4
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\&.
.RE
.PP
hibernate
.RS 4
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\&.
.RE
.PP
hybrid\-sleep
.RS 4
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\&.
.RE
.PP
Settings in these files determine what strings will be written to
/sys/power/disk
and
/sys/power/state
by
\fBsystemd-sleep\fR(8)
when
\fBsystemd\fR(1)
attempts to suspend or hibernate the machine\&.
.SH "CONFIGURATION DIRECTORIES AND PRECEDENCE"
.PP
Configuration files are read from directories in
/etc/,
/run/, and
/usr/lib/, in order of precedence\&. Each configuration file in these configuration directories shall be named in the style of
\fIfilename\fR\&.conf\&. Files in
/etc/
override files with the same name in
/run/
and
/usr/lib/\&. Files in
/run/
override files with the same name in
/usr/lib/\&.
.PP
Packages should install their configuration files in
/usr/lib/\&. Files in
/etc/
are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. All configuration files are sorted by their filename in lexicographic order, regardless of which of the directories they reside in\&. If multiple files specify the same option, the entry in the file with the lexicographically latest name will take precedence\&. It is recommended to prefix all filenames with a two\-digit number and a dash, to simplify the ordering of the files\&.
.PP
If the administrator wants to disable a configuration file supplied by the vendor, the recommended way is to place a symlink to
/dev/null
in the configuration directory in
/etc/, with the same filename as the vendor configuration file\&.
.SH "CONFIGURATION FILE"
.PP
Configuration is also read from a single configuration file in
/etc/\&. This file is read before any of the configuration directories, and has the lowest precedence; entries in a file in any configuration directory override entries in the single configuration file\&.
.SH "OPTIONS"
.PP
The following options can be configured in the
"[Sleep]"
section of
/etc/systemd/sleep\&.conf
or a
sleep\&.conf\&.d
file:
.PP
\fISuspendMode=\fR, \fIHibernateMode=\fR, \fIHybridSleepMode=\fR
.RS 4
The string to be written to
/sys/power/disk
by, respectively,
\fBsystemd-suspend.service\fR(8),
\fBsystemd-hibernate.service\fR(8), or
\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\&.
.RE
.PP
\fISuspendState=\fR, \fIHibernateState=\fR, \fIHybridSleepState=\fR
.RS 4
The string to be written to
/sys/power/state
by, respectively,
\fBsystemd-suspend.service\fR(8),
\fBsystemd-hibernate.service\fR(8), or
\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\&.
.RE
.SH "EXAMPLE: FREEZE"
.PP
Example: to exploit the
\(lqfreeze\(rq
mode added in Linux 3\&.9, one can use
\fBsystemctl suspend\fR
with
.sp
.if n \{\
.RS 4
.\}
.nf
[Sleep]
SuspendState=freeze
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\fBsystemd-sleep\fR(8),
\fBsystemd-suspend.service\fR(8),
\fBsystemd-hibernate.service\fR(8),
\fBsystemd-hybrid-sleep.service\fR(8),
\fBsystemd\fR(1),
\fBsystemd.directives\fR(7)