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   This file is part of systemd.
   6
   7   Copyright 2014 Ivan Shapovalov
   8
   9   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 -->
  22 <refentry id="systemd-hibernate-resume-generator" conditional='ENABLE_HIBERNATE'>
  23
  24   <refentryinfo>
  25     <title>systemd-hibernate-resume-generator</title>
  26     <productname>systemd</productname>
  27
  28     <authorgroup>
  29       <author>
  30         <contrib>Developer</contrib>
  31         <firstname>Ivan</firstname>
  32         <surname>Shapovalov</surname>
  33         <email>intelfx100@gmail.com</email>
  34       </author>
  35     </authorgroup>
  36   </refentryinfo>
  37
  38   <refmeta>
  39     <refentrytitle>systemd-hibernate-resume-generator</refentrytitle>
  40     <manvolnum>8</manvolnum>
  41   </refmeta>
  42
  43   <refnamediv>
  44     <refname>systemd-hibernate-resume-generator</refname>
  45     <refpurpose>Unit generator for resume= kernel parameter</refpurpose>
  46   </refnamediv>
  47
  48   <refsynopsisdiv>
  49     <para><filename>/usr/lib/systemd/system-generators/systemd-hibernate-resume-generator</filename></para>
  50   </refsynopsisdiv>
  51
  52   <refsect1>
  53     <title>Description</title>
  54
  55     <para><filename>systemd-hibernate-resume-generator</filename> is a
  56     generator that instantiates
  57     <citerefentry><refentrytitle>systemd-hibernate-resume@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  58     unit according to the value of <option>resume=</option> parameter
  59     specified on the kernel command line.</para>
  60   </refsect1>
  61
  62   <refsect1>
  63     <title>Kernel Command Line</title>
  64
  65     <para><filename>systemd-hibernate-resume-generator</filename>
  66     understands the following kernel command line parameters:</para>
  67
  68     <variablelist class='kernel-commandline-options'>
  69
  70       <varlistentry>
  71         <term><varname>resume=</varname></term>
  72
  73         <listitem><para>Takes a path to the resume device. Both
  74         persistent block device paths like
  75         <filename>/dev/disk/by-foo/bar</filename> and
  76         <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>-style
  77         specifiers like <literal>FOO=bar</literal> are
  78         supported.</para></listitem>
  79       </varlistentry>
  80
  81     </variablelist>
  82   </refsect1>
  83
  84   <refsect1>
  85     <title>See Also</title>
  86     <para>
  87       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  88       <citerefentry><refentrytitle>systemd-hibernate-resume@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  89       <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  90     </para>
  91   </refsect1>
  92
  93 </refentry>