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