man/systemd-hibernate-resume-generator.xml

   1 <?xml version="1.0"?>
   2 <!--*-nxml-*-->
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   4   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   5 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   6 <refentry id="systemd-hibernate-resume-generator" conditional='ENABLE_HIBERNATE'
   7           xmlns:xi="http://www.w3.org/2001/XInclude">
   8
   9   <refentryinfo>
  10     <title>systemd-hibernate-resume-generator</title>
  11     <productname>systemd</productname>
  12   </refentryinfo>
  13
  14   <refmeta>
  15     <refentrytitle>systemd-hibernate-resume-generator</refentrytitle>
  16     <manvolnum>8</manvolnum>
  17   </refmeta>
  18
  19   <refnamediv>
  20     <refname>systemd-hibernate-resume-generator</refname>
  21     <refpurpose>Unit generator for resume= kernel parameter</refpurpose>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <para><filename>/usr/lib/systemd/system-generators/systemd-hibernate-resume-generator</filename></para>
  26   </refsynopsisdiv>
  27
  28   <refsect1>
  29     <title>Description</title>
  30
  31     <para><command>systemd-hibernate-resume-generator</command> is a generator that initiates the procedure
  32     to resume the system from hibernation. When <option>resume=</option> kernel command line option or
  33     <varname>HibernateLocation</varname> EFI variable is detected, it enables the
  34     <citerefentry><refentrytitle>systemd-hibernate-resume.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  35     unit, which will instruct the kernel to resume the system from the hibernation image.</para>
  36   </refsect1>
  37
  38   <refsect1>
  39     <title>Kernel Command Line</title>
  40
  41     <para><filename>systemd-hibernate-resume-generator</filename>
  42     understands the following kernel command line parameters:</para>
  43
  44     <variablelist class='kernel-commandline-options'>
  45
  46       <varlistentry>
  47         <term><varname>resume=</varname></term>
  48
  49         <listitem><para>Takes a path to the resume device. Both
  50         persistent block device paths like
  51         <filename index="false">/dev/disk/by-foo/bar</filename> and
  52         <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>-style
  53         specifiers like <literal>FOO=bar</literal> are
  54         supported.</para>
  55
  56         <xi:include href="version-info.xml" xpointer="v217"/></listitem>
  57       </varlistentry>
  58
  59       <varlistentry>
  60         <term><varname>resume_offset=</varname></term>
  61
  62         <listitem><para>Takes the page offset of the swap space from the resume device.
  63         Defaults to <literal>0</literal>.</para>
  64
  65         <xi:include href="version-info.xml" xpointer="v254"/></listitem>
  66       </varlistentry>
  67
  68       <varlistentry>
  69         <term><varname>resumeflags=</varname></term>
  70
  71         <listitem><para>Takes the resume device mount options to
  72         use. Defaults <varname>rootflags=</varname> if not specified.</para>
  73
  74         <xi:include href="version-info.xml" xpointer="v243"/></listitem>
  75       </varlistentry>
  76
  77       <varlistentry>
  78         <term><varname>noresume</varname></term>
  79
  80         <listitem><para>Do not try to resume from hibernation. If this parameter is
  81         present, <varname>resume=</varname> is ignored.</para>
  82
  83         <xi:include href="version-info.xml" xpointer="v240"/></listitem>
  84       </varlistentry>
  85     </variablelist>
  86   </refsect1>
  87
  88   <refsect1>
  89     <title>See Also</title>
  90     <para>
  91       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  92       <citerefentry><refentrytitle>systemd-hibernate-resume.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  93       <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  94     </para>
  95   </refsect1>
  96
  97 </refentry>