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   This file is part of systemd.
   8
   9   Copyright 2014 Ivan Shapovalov
  10 -->
  11 <refentry id="systemd-hibernate-resume-generator" conditional='ENABLE_HIBERNATE'>
  12
  13   <refentryinfo>
  14     <title>systemd-hibernate-resume-generator</title>
  15     <productname>systemd</productname>
  16
  17     <authorgroup>
  18       <author>
  19         <contrib>Developer</contrib>
  20         <firstname>Ivan</firstname>
  21         <surname>Shapovalov</surname>
  22         <email>intelfx100@gmail.com</email>
  23       </author>
  24     </authorgroup>
  25   </refentryinfo>
  26
  27   <refmeta>
  28     <refentrytitle>systemd-hibernate-resume-generator</refentrytitle>
  29     <manvolnum>8</manvolnum>
  30   </refmeta>
  31
  32   <refnamediv>
  33     <refname>systemd-hibernate-resume-generator</refname>
  34     <refpurpose>Unit generator for resume= kernel parameter</refpurpose>
  35   </refnamediv>
  36
  37   <refsynopsisdiv>
  38     <para><filename>/usr/lib/systemd/system-generators/systemd-hibernate-resume-generator</filename></para>
  39   </refsynopsisdiv>
  40
  41   <refsect1>
  42     <title>Description</title>
  43
  44     <para><filename>systemd-hibernate-resume-generator</filename> is a
  45     generator that instantiates
  46     <citerefentry><refentrytitle>systemd-hibernate-resume@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  47     unit according to the value of <option>resume=</option> parameter
  48     specified on the kernel command line.</para>
  49   </refsect1>
  50
  51   <refsect1>
  52     <title>Kernel Command Line</title>
  53
  54     <para><filename>systemd-hibernate-resume-generator</filename>
  55     understands the following kernel command line parameters:</para>
  56
  57     <variablelist class='kernel-commandline-options'>
  58
  59       <varlistentry>
  60         <term><varname>resume=</varname></term>
  61
  62         <listitem><para>Takes a path to the resume device. Both
  63         persistent block device paths like
  64         <filename>/dev/disk/by-foo/bar</filename> and
  65         <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>-style
  66         specifiers like <literal>FOO=bar</literal> are
  67         supported.</para></listitem>
  68       </varlistentry>
  69
  70     </variablelist>
  71   </refsect1>
  72
  73   <refsect1>
  74     <title>See Also</title>
  75     <para>
  76       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  77       <citerefentry><refentrytitle>systemd-hibernate-resume@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  78       <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  79     </para>
  80   </refsect1>
  81
  82 </refentry>