New upstream version 242

[systemd.git] / man / systemd-hibernate-resume@.service.xml

<?xml version="1.0"?>
<!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1+ -->
<refentry id="systemd-hibernate-resume@.service" conditional='ENABLE_HIBERNATE'>

  <refentryinfo>
    <title>systemd-hibernate-resume@.service</title>
    <productname>systemd</productname>
  </refentryinfo>

  <refmeta>
    <refentrytitle>systemd-hibernate-resume@.service</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>systemd-hibernate-resume@.service</refname>
    <refname>systemd-hibernate-resume</refname>
    <refpurpose>Resume from hibernation</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <para><filename>systemd-hibernate-resume@.service</filename></para>
    <para><filename>/usr/lib/systemd/systemd-hibernate-resume</filename></para>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><filename>systemd-hibernate-resume@.service</filename>
    initiates the resume from hibernation. It is instantiated with the
    device to resume from as the template argument.</para>

    <para><filename>systemd-hibernate-resume</filename> only supports
    the in-kernel hibernation implementation, known as
    <ulink url="https://www.kernel.org/doc/Documentation/power/swsusp.txt">swsusp</ulink>.
    Internally, it works by writing the major:minor of specified
    device node to <filename>/sys/power/resume</filename>.</para>

    <para>Failing to initiate a resume is not an error condition. It
    may mean that there was no resume image (e. g. if the system has
    been simply powered off and not hibernated). In such case, the
    boot is ordinarily continued.</para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemd-hibernate-resume-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
    </para>
  </refsect1>

</refentry>