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   Copyright © 2014 Ivan Shapovalov
   8 -->
   9 <refentry id="systemd-hibernate-resume-generator" conditional='ENABLE_HIBERNATE'>
  10
  11   <refentryinfo>
  12     <title>systemd-hibernate-resume-generator</title>
  13     <productname>systemd</productname>
  14   </refentryinfo>
  15
  16   <refmeta>
  17     <refentrytitle>systemd-hibernate-resume-generator</refentrytitle>
  18     <manvolnum>8</manvolnum>
  19   </refmeta>
  20
  21   <refnamediv>
  22     <refname>systemd-hibernate-resume-generator</refname>
  23     <refpurpose>Unit generator for resume= kernel parameter</refpurpose>
  24   </refnamediv>
  25
  26   <refsynopsisdiv>
  27     <para><filename>/usr/lib/systemd/system-generators/systemd-hibernate-resume-generator</filename></para>
  28   </refsynopsisdiv>
  29
  30   <refsect1>
  31     <title>Description</title>
  32
  33     <para><filename>systemd-hibernate-resume-generator</filename> is a
  34     generator that instantiates
  35     <citerefentry><refentrytitle>systemd-hibernate-resume@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  36     unit according to the value of <option>resume=</option> parameter
  37     specified on the kernel command line.</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     </variablelist>
  60   </refsect1>
  61
  62   <refsect1>
  63     <title>See Also</title>
  64     <para>
  65       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  66       <citerefentry><refentrytitle>systemd-hibernate-resume@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  67       <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  68     </para>
  69   </refsect1>
  70
  71 </refentry>