]>
Commit | Line | Data |
---|---|---|
d2c68822 IS |
1 | <?xml version="1.0"?> |
2 | <!--*-nxml-*--> | |
3a54a157 ZJS |
3 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
4 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
db9ecf05 | 5 | <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> |
4623eecb AK |
6 | <refentry id="systemd-hibernate-resume-generator" conditional='ENABLE_HIBERNATE' |
7 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
d2c68822 | 8 | |
798d3a52 ZJS |
9 | <refentryinfo> |
10 | <title>systemd-hibernate-resume-generator</title> | |
11 | <productname>systemd</productname> | |
798d3a52 ZJS |
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> | |
12b42c76 | 25 | <para><filename>/usr/lib/systemd/system-generators/systemd-hibernate-resume-generator</filename></para> |
798d3a52 ZJS |
26 | </refsynopsisdiv> |
27 | ||
28 | <refsect1> | |
29 | <title>Description</title> | |
30 | ||
e83419d0 ZJS |
31 | <para><command>systemd-hibernate-resume-generator</command> is a |
32 | generator that initiates the procedure to resume the system from hibernation. | |
760e99bb MY |
33 | It creates the |
34 | <citerefentry><refentrytitle>systemd-hibernate-resume.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
798d3a52 | 35 | unit according to the value of <option>resume=</option> parameter |
9deeca12 MY |
36 | specified on the kernel command line, or the value of EFI variable |
37 | <varname>HibernateLocation</varname>, which will instruct the kernel | |
e83419d0 | 38 | to resume the system from the hibernation image on that device.</para> |
798d3a52 ZJS |
39 | </refsect1> |
40 | ||
41 | <refsect1> | |
42 | <title>Kernel Command Line</title> | |
43 | ||
44 | <para><filename>systemd-hibernate-resume-generator</filename> | |
45 | understands the following kernel command line parameters:</para> | |
46 | ||
47 | <variablelist class='kernel-commandline-options'> | |
48 | ||
49 | <varlistentry> | |
50 | <term><varname>resume=</varname></term> | |
51 | ||
52 | <listitem><para>Takes a path to the resume device. Both | |
53 | persistent block device paths like | |
211c99c7 | 54 | <filename index="false">/dev/disk/by-foo/bar</filename> and |
3ba3a79d | 55 | <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>-style |
798d3a52 ZJS |
56 | specifiers like <literal>FOO=bar</literal> are |
57 | supported.</para></listitem> | |
58 | </varlistentry> | |
59 | ||
760e99bb MY |
60 | <varlistentry> |
61 | <term><varname>resume_offset=</varname></term> | |
62 | ||
63 | <listitem><para>Takes the page offset of the swap space from the resume device. | |
64 | Defaults to <literal>0</literal>.</para></listitem> | |
65 | </varlistentry> | |
66 | ||
8b6805a2 JR |
67 | <varlistentry> |
68 | <term><varname>resumeflags=</varname></term> | |
69 | ||
70 | <listitem><para>Takes the resume device mount options to | |
71 | use. Defaults <varname>rootflags=</varname> if not specified.</para></listitem> | |
72 | </varlistentry> | |
73 | ||
e83419d0 ZJS |
74 | <varlistentry> |
75 | <term><varname>noresume</varname></term> | |
76 | ||
77 | <listitem><para>Do not try to resume from hibernation. If this parameter is | |
78 | present, <varname>resume=</varname> is ignored.</para></listitem> | |
79 | </varlistentry> | |
798d3a52 ZJS |
80 | </variablelist> |
81 | </refsect1> | |
82 | ||
83 | <refsect1> | |
84 | <title>See Also</title> | |
85 | <para> | |
86 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
760e99bb | 87 | <citerefentry><refentrytitle>systemd-hibernate-resume.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
798d3a52 ZJS |
88 | <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry> |
89 | </para> | |
90 | </refsect1> | |
d2c68822 IS |
91 | |
92 | </refentry> |