man/systemd-hibernate-resume-generator.xml

   1 <?xml version="1.0"?>
   2 <!--*-nxml-*-->
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!--
   5   SPDX-License-Identifier: LGPL-2.1+
   6 -->
   7 <refentry id="systemd-hibernate-resume-generator" conditional='ENABLE_HIBERNATE'>
   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
  32     generator that initiates the procedure to resume the system from hibernation.
  33     It instantiates the
  34     <citerefentry><refentrytitle>systemd-hibernate-resume@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  35     unit according to the value of <option>resume=</option> parameter
  36     specified on the kernel command line, 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>/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>noresume</varname></term>
  61
  62         <listitem><para>Do not try to resume from hibernation. If this parameter is
  63         present, <varname>resume=</varname> is ignored.</para></listitem>
  64       </varlistentry>
  65     </variablelist>
  66   </refsect1>
  67
  68   <refsect1>
  69     <title>See Also</title>
  70     <para>
  71       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  72       <citerefentry><refentrytitle>systemd-hibernate-resume@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  73       <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  74     </para>
  75   </refsect1>
  76
  77 </refentry>