]>
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"> | |
0307f791 | 5 | <!-- SPDX-License-Identifier: LGPL-2.1+ --> |
232bd677 | 6 | <refentry id="systemd-hibernate-resume-generator" conditional='ENABLE_HIBERNATE'> |
d2c68822 | 7 | |
798d3a52 ZJS |
8 | <refentryinfo> |
9 | <title>systemd-hibernate-resume-generator</title> | |
10 | <productname>systemd</productname> | |
798d3a52 ZJS |
11 | </refentryinfo> |
12 | ||
13 | <refmeta> | |
14 | <refentrytitle>systemd-hibernate-resume-generator</refentrytitle> | |
15 | <manvolnum>8</manvolnum> | |
16 | </refmeta> | |
17 | ||
18 | <refnamediv> | |
19 | <refname>systemd-hibernate-resume-generator</refname> | |
20 | <refpurpose>Unit generator for resume= kernel parameter</refpurpose> | |
21 | </refnamediv> | |
22 | ||
23 | <refsynopsisdiv> | |
12b42c76 | 24 | <para><filename>/usr/lib/systemd/system-generators/systemd-hibernate-resume-generator</filename></para> |
798d3a52 ZJS |
25 | </refsynopsisdiv> |
26 | ||
27 | <refsect1> | |
28 | <title>Description</title> | |
29 | ||
e83419d0 ZJS |
30 | <para><command>systemd-hibernate-resume-generator</command> is a |
31 | generator that initiates the procedure to resume the system from hibernation. | |
32 | It instantiates the | |
798d3a52 ZJS |
33 | <citerefentry><refentrytitle>systemd-hibernate-resume@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> |
34 | unit according to the value of <option>resume=</option> parameter | |
e83419d0 ZJS |
35 | specified on the kernel command line, which will instruct the kernel |
36 | to resume the system from the hibernation image on that device.</para> | |
798d3a52 ZJS |
37 | </refsect1> |
38 | ||
39 | <refsect1> | |
40 | <title>Kernel Command Line</title> | |
41 | ||
42 | <para><filename>systemd-hibernate-resume-generator</filename> | |
43 | understands the following kernel command line parameters:</para> | |
44 | ||
45 | <variablelist class='kernel-commandline-options'> | |
46 | ||
47 | <varlistentry> | |
48 | <term><varname>resume=</varname></term> | |
49 | ||
50 | <listitem><para>Takes a path to the resume device. Both | |
51 | persistent block device paths like | |
52 | <filename>/dev/disk/by-foo/bar</filename> and | |
3ba3a79d | 53 | <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>-style |
798d3a52 ZJS |
54 | specifiers like <literal>FOO=bar</literal> are |
55 | supported.</para></listitem> | |
56 | </varlistentry> | |
57 | ||
e83419d0 ZJS |
58 | <varlistentry> |
59 | <term><varname>noresume</varname></term> | |
60 | ||
61 | <listitem><para>Do not try to resume from hibernation. If this parameter is | |
62 | present, <varname>resume=</varname> is ignored.</para></listitem> | |
63 | </varlistentry> | |
798d3a52 ZJS |
64 | </variablelist> |
65 | </refsect1> | |
66 | ||
67 | <refsect1> | |
68 | <title>See Also</title> | |
69 | <para> | |
70 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
71 | <citerefentry><refentrytitle>systemd-hibernate-resume@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
72 | <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry> | |
73 | </para> | |
74 | </refsect1> | |
d2c68822 IS |
75 | |
76 | </refentry> |