systemd-sleep.conf.xml revision e93549ef29c4123d9ee45acb5815048390201e49
c6d33447e28403a90ad817dba4df75fae785be28pquerna<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
c6d33447e28403a90ad817dba4df75fae785be28pquerna<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
c6d33447e28403a90ad817dba4df75fae785be28pquerna"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
c6d33447e28403a90ad817dba4df75fae785be28pquernaThis file is part of systemd.
c6d33447e28403a90ad817dba4df75fae785be28pquernaCopyright 2013 Zbigniew Jędrzejewski-Szmek
c6d33447e28403a90ad817dba4df75fae785be28pquernasystemd is free software; you can redistribute it and/or modify it
c6d33447e28403a90ad817dba4df75fae785be28pquernaunder the terms of the GNU Lesser General Public License as published by
c6d33447e28403a90ad817dba4df75fae785be28pquernathe Free Software Foundation; either version 2.1 of the License, or
c6d33447e28403a90ad817dba4df75fae785be28pquerna(at your option) any later version.
c6d33447e28403a90ad817dba4df75fae785be28pquernasystemd is distributed in the hope that it will be useful, but
c6d33447e28403a90ad817dba4df75fae785be28pquernaWITHOUT ANY WARRANTY; without even the implied warranty of
546d45814f6de2976187f3eaad9ba7a4b01c8b77pquernaMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
546d45814f6de2976187f3eaad9ba7a4b01c8b77pquernaLesser General Public License for more details.
c6d33447e28403a90ad817dba4df75fae785be28pquernaYou should have received a copy of the GNU Lesser General Public License
c6d33447e28403a90ad817dba4df75fae785be28pquernaalong with systemd; If not, see <http://www.gnu.org/licenses/>.
c6d33447e28403a90ad817dba4df75fae785be28pquerna <refentryinfo>
c6d33447e28403a90ad817dba4df75fae785be28pquerna <authorgroup>
546d45814f6de2976187f3eaad9ba7a4b01c8b77pquerna </authorgroup>
546d45814f6de2976187f3eaad9ba7a4b01c8b77pquerna </refentryinfo>
546d45814f6de2976187f3eaad9ba7a4b01c8b77pquerna <refnamediv>
c6d33447e28403a90ad817dba4df75fae785be28pquerna <refpurpose>Suspend and hibernation configuration file</refpurpose>
c6d33447e28403a90ad817dba4df75fae785be28pquerna </refnamediv>
c6d33447e28403a90ad817dba4df75fae785be28pquerna <refsynopsisdiv>
c6d33447e28403a90ad817dba4df75fae785be28pquerna <para><filename>/etc/systemd/sleep.conf</filename></para>
c6d33447e28403a90ad817dba4df75fae785be28pquerna <para><filename>/etc/systemd/sleep.conf.d/*.conf</filename></para>
546d45814f6de2976187f3eaad9ba7a4b01c8b77pquerna <para><filename>/run/systemd/sleep.conf.d/*.conf</filename></para>
c6d33447e28403a90ad817dba4df75fae785be28pquerna <para><filename>/usr/lib/systemd/sleep.conf.d/*.conf</filename></para>
c6d33447e28403a90ad817dba4df75fae785be28pquerna </refsynopsisdiv>
c6d33447e28403a90ad817dba4df75fae785be28pquerna <para><command>systemd</command> supports three general
c6d33447e28403a90ad817dba4df75fae785be28pquerna power-saving modes:</para>
c6d33447e28403a90ad817dba4df75fae785be28pquerna <variablelist>
c6d33447e28403a90ad817dba4df75fae785be28pquerna <varlistentry>
c6d33447e28403a90ad817dba4df75fae785be28pquerna where execution of the OS is paused,
c6d33447e28403a90ad817dba4df75fae785be28pquerna and complete power loss might result
c6d33447e28403a90ad817dba4df75fae785be28pquerna in lost data, and which is fast to
c6d33447e28403a90ad817dba4df75fae785be28pquerna enter and exit. This corresponds to
c6d33447e28403a90ad817dba4df75fae785be28pquerna suspend, standby, or freeze states as
c6d33447e28403a90ad817dba4df75fae785be28pquerna understood by the kernel.
c6d33447e28403a90ad817dba4df75fae785be28pquerna </varlistentry>
c6d33447e28403a90ad817dba4df75fae785be28pquerna <varlistentry>
c6d33447e28403a90ad817dba4df75fae785be28pquerna where execution of the OS is paused,
c6d33447e28403a90ad817dba4df75fae785be28pquerna and complete power loss does not
c6d33447e28403a90ad817dba4df75fae785be28pquerna result in lost data, and which might
c6d33447e28403a90ad817dba4df75fae785be28pquerna be slow to enter and exit. This
c6d33447e28403a90ad817dba4df75fae785be28pquerna corresponds to the hibernation as
c6d33447e28403a90ad817dba4df75fae785be28pquerna understood by the kernel.
c6d33447e28403a90ad817dba4df75fae785be28pquerna </varlistentry>
546d45814f6de2976187f3eaad9ba7a4b01c8b77pquerna <varlistentry>
c6d33447e28403a90ad817dba4df75fae785be28pquerna where execution of the OS is paused,
c6d33447e28403a90ad817dba4df75fae785be28pquerna which might be slow to enter, and on
c6d33447e28403a90ad817dba4df75fae785be28pquerna complete power loss does not result in
c6d33447e28403a90ad817dba4df75fae785be28pquerna lost data but might be slower to exit
c6d33447e28403a90ad817dba4df75fae785be28pquerna in that case. This mode is called
c6d33447e28403a90ad817dba4df75fae785be28pquerna suspend-to-both by the kernel.
c6d33447e28403a90ad817dba4df75fae785be28pquerna </varlistentry>
c6d33447e28403a90ad817dba4df75fae785be28pquerna </variablelist>
c6d33447e28403a90ad817dba4df75fae785be28pquerna <para>Settings in these files determine what strings
c6d33447e28403a90ad817dba4df75fae785be28pquerna will be written to
c6d33447e28403a90ad817dba4df75fae785be28pquerna <citerefentry><refentrytitle>systemd-sleep</refentrytitle><manvolnum>8</manvolnum></citerefentry>
c6d33447e28403a90ad817dba4df75fae785be28pquerna <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
c6d33447e28403a90ad817dba4df75fae785be28pquerna attempts to suspend or hibernate the machine.</para>
c6d33447e28403a90ad817dba4df75fae785be28pquerna </refsect1>
c6d33447e28403a90ad817dba4df75fae785be28pquerna <xi:include href="standard-conf.xml" xpointer="main-conf" />
c6d33447e28403a90ad817dba4df75fae785be28pquerna <para>The following options can be configured in the
c6d33447e28403a90ad817dba4df75fae785be28pquerna <varlistentry>
c6d33447e28403a90ad817dba4df75fae785be28pquerna respectively,
c6d33447e28403a90ad817dba4df75fae785be28pquerna <citerefentry><refentrytitle>systemd-suspend.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
c6d33447e28403a90ad817dba4df75fae785be28pquerna <citerefentry><refentrytitle>systemd-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, or
c6d33447e28403a90ad817dba4df75fae785be28pquerna <citerefentry><refentrytitle>systemd-hybrid-sleep.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
c6d33447e28403a90ad817dba4df75fae785be28pquerna More than one value can be specified by separating
c6d33447e28403a90ad817dba4df75fae785be28pquerna multiple values with whitespace. They will be tried
c6d33447e28403a90ad817dba4df75fae785be28pquerna in turn, until one is written without error. If
c6d33447e28403a90ad817dba4df75fae785be28pquerna neither succeeds, the operation will be aborted.
c6d33447e28403a90ad817dba4df75fae785be28pquerna </varlistentry>
c6d33447e28403a90ad817dba4df75fae785be28pquerna <varlistentry>
c6d33447e28403a90ad817dba4df75fae785be28pquerna respectively,
c6d33447e28403a90ad817dba4df75fae785be28pquerna <citerefentry><refentrytitle>systemd-suspend.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
c6d33447e28403a90ad817dba4df75fae785be28pquerna <citerefentry><refentrytitle>systemd-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, or
c6d33447e28403a90ad817dba4df75fae785be28pquerna <citerefentry><refentrytitle>systemd-hybrid-sleep.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
c6d33447e28403a90ad817dba4df75fae785be28pquerna More than one value can be specified by separating
c6d33447e28403a90ad817dba4df75fae785be28pquerna multiple values with whitespace. They will be tried
c6d33447e28403a90ad817dba4df75fae785be28pquerna in turn, until one is written without error. If
c6d33447e28403a90ad817dba4df75fae785be28pquerna neither succeeds, the operation will be aborted.
c6d33447e28403a90ad817dba4df75fae785be28pquerna </varlistentry>
c6d33447e28403a90ad817dba4df75fae785be28pquerna </variablelist>
c6d33447e28403a90ad817dba4df75fae785be28pquerna </refsect1>
c6d33447e28403a90ad817dba4df75fae785be28pquerna <para>Example: to exploit the <quote>freeze</quote> mode added
c6d33447e28403a90ad817dba4df75fae785be28pquerna in Linux 3.9, one can use <command>systemctl suspend</command>
c6d33447e28403a90ad817dba4df75fae785be28pquerna <programlisting>[Sleep]
c6d33447e28403a90ad817dba4df75fae785be28pquerna </refsect1>
c6d33447e28403a90ad817dba4df75fae785be28pquerna <citerefentry><refentrytitle>systemd-sleep</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
c6d33447e28403a90ad817dba4df75fae785be28pquerna <citerefentry><refentrytitle>systemd-suspend.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
c6d33447e28403a90ad817dba4df75fae785be28pquerna <citerefentry><refentrytitle>systemd-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
c6d33447e28403a90ad817dba4df75fae785be28pquerna <citerefentry><refentrytitle>systemd-hybrid-sleep.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
c6d33447e28403a90ad817dba4df75fae785be28pquerna <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
c6d33447e28403a90ad817dba4df75fae785be28pquerna <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
c6d33447e28403a90ad817dba4df75fae785be28pquerna </refsect1>