Reindent man pages to 2ch

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

<?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 2014 Ivan Shapovalov

  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-hibernate-resume@.service">

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

    <authorgroup>
      <author>
        <contrib>Developer</contrib>
        <firstname>Ivan</firstname>
        <surname>Shapovalov</surname>
        <email>intelfx100@gmail.com</email>
      </author>
    </authorgroup>
  </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>