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
   8   <refentryinfo>
   9     <title>systemd-hibernate-resume-generator</title>
  10     <productname>systemd</productname>
  11   </refentryinfo>
  12
  13   <refmeta>
  14     <refentrytitle>systemd-hibernate-resume-generator</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>systemd-hibernate-resume-generator</refname>
  20     <refpurpose>Unit generator for resume= kernel parameter</refpurpose>
  21   </refnamediv>
  22
  23   <refsynopsisdiv>
  24     <para><filename>/usr/lib/systemd/system-generators/systemd-hibernate-resume-generator</filename></para>
  25   </refsynopsisdiv>
  26
  27   <refsect1>
  28     <title>Description</title>
  29
  30     <para><command>systemd-hibernate-resume-generator</command> is a
  31     generator that initiates the procedure to resume the system from hibernation.
  32     It creates the
  33     <citerefentry><refentrytitle>systemd-hibernate-resume.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  34     unit according to the value of <option>resume=</option> parameter
  35     specified on the kernel command line, or the value of EFI variable
  36     <varname>HibernateLocation</varname>, which will instruct the kernel
  37     to resume the system from the hibernation image on that device.</para>
  38   </refsect1>
  39
  40   <refsect1>
  41     <title>Kernel Command Line</title>
  42
  43     <para><filename>systemd-hibernate-resume-generator</filename>
  44     understands the following kernel command line parameters:</para>
  45
  46     <variablelist class='kernel-commandline-options'>
  47
  48       <varlistentry>
  49         <term><varname>resume=</varname></term>
  50
  51         <listitem><para>Takes a path to the resume device. Both
  52         persistent block device paths like
  53         <filename index="false">/dev/disk/by-foo/bar</filename> and
  54         <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>-style
  55         specifiers like <literal>FOO=bar</literal> are
  56         supported.</para></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></listitem>
  64       </varlistentry>
  65
  66       <varlistentry>
  67         <term><varname>resumeflags=</varname></term>
  68
  69         <listitem><para>Takes the resume device mount options to
  70         use. Defaults <varname>rootflags=</varname> if not specified.</para></listitem>
  71       </varlistentry>
  72
  73       <varlistentry>
  74         <term><varname>noresume</varname></term>
  75
  76         <listitem><para>Do not try to resume from hibernation. If this parameter is
  77         present, <varname>resume=</varname> is ignored.</para></listitem>
  78       </varlistentry>
  79     </variablelist>
  80   </refsect1>
  81
  82   <refsect1>
  83     <title>See Also</title>
  84     <para>
  85       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  86       <citerefentry><refentrytitle>systemd-hibernate-resume.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  87       <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  88     </para>
  89   </refsect1>
  90
  91 </refentry>