shaba/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2025-01-25 10:04:04 +03:00
Code
systemd/man/systemd-hibernate-resume-generator.xml

101 lines
3.7 KiB
XML
Raw Normal View History

hibernate-resume-generator: add a generator for instantiating the resume unit. hibernate-resume-generator understands resume= kernel command line parameter and instantiates the systemd-resume@.service accordingly if it is passed. This enables resume from hibernation using device specified on the kernel command line, and it may be specified either as "/dev/disk/by-foo/bar" or "FOO=bar", not only "/dev/sdXY" which is understood by the in-kernel implementation. So now resume= is brought on par with root= in terms of possible ways to specify a device.
2014-08-27 00:17:45 +04:00
<?xml version="1.0"?>
<!--*-nxml-*-->
man: use same header for all files The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml
2019-03-14 14:40:58 +01:00
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
man: use same version in public and system ident.
2023-12-25 15:48:33 +01:00
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
license: LGPL-2.1+ -> LGPL-2.1-or-later
2020-11-09 13:23:58 +09:00
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
man: Add xinclude namespace This will be used by the next commit to add version information to the nodes.
2023-08-22 17:52:02 +01:00
<refentry id="systemd-hibernate-resume-generator" conditional='ENABLE_HIBERNATE'
xmlns:xi="http://www.w3.org/2001/XInclude">
hibernate-resume-generator: add a generator for instantiating the resume unit. hibernate-resume-generator understands resume= kernel command line parameter and instantiates the systemd-resume@.service accordingly if it is passed. This enables resume from hibernation using device specified on the kernel command line, and it may be specified either as "/dev/disk/by-foo/bar" or "FOO=bar", not only "/dev/sdXY" which is understood by the in-kernel implementation. So now resume= is brought on par with root= in terms of possible ways to specify a device.
2014-08-27 00:17:45 +04:00
Reindent man pages to 2ch
2015-02-03 21:14:13 -05:00
<refentryinfo>
<title>systemd-hibernate-resume-generator</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>systemd-hibernate-resume-generator</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd-hibernate-resume-generator</refname>
<refpurpose>Unit generator for resume= kernel parameter</refpurpose>
</refnamediv>
<refsynopsisdiv>
man: revert dynamic paths for split-usr setups This did not really work out as we had hoped. Trying to do this upstream introduced several problems that probably makes it better suited as a downstream patch after all. At any rate, it is not releaseable in the current state, so we at least need to revert this before the release. * by adjusting the path to binaries, but not do the same thing to the search path we end up with inconsistent man-pages. Adjusting the search path too would be quite messy, and it is not at all obvious that this is worth the effort, but at any rate it would have to be done before we could ship this. * this means that distributed man-pages does not make sense as they depend on config options, and for better or worse we are still distributing man pages, so that is something that definitely needs sorting out before we could ship with this patch. * we have long held that split-usr is only minimally supported in order to boot, and something we hope will eventually go away. So before we start adding even more magic/effort in order to make this work nicely, we should probably question if it makes sense at all.
2015-06-18 19:47:44 +02:00
<para><filename>/usr/lib/systemd/system-generators/systemd-hibernate-resume-generator</filename></para>
Reindent man pages to 2ch
2015-02-03 21:14:13 -05:00
</refsynopsisdiv>
<refsect1>
<title>Description</title>
hib-res-generator: add "noresume" This is an override parameter, to totally skip dehiberanation.
2018-09-26 07:31:10 +02:00
<para><command>systemd-hibernate-resume-generator</command> is a
generator that initiates the procedure to resume the system from hibernation.
hibernate-resume: rework to follow the logic of sleep.c and use main-func.h Preparation for #27247
2023-04-19 01:21:55 +08:00
It creates the
<citerefentry><refentrytitle>systemd-hibernate-resume.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
Reindent man pages to 2ch
2015-02-03 21:14:13 -05:00
unit according to the value of <option>resume=</option> parameter
hibernate-resume: support resuming through efivar HibernateLocation
2023-04-25 00:34:19 +08:00
specified on the kernel command line, or the value of EFI variable
<varname>HibernateLocation</varname>, which will instruct the kernel
hib-res-generator: add "noresume" This is an override parameter, to totally skip dehiberanation.
2018-09-26 07:31:10 +02:00
to resume the system from the hibernation image on that device.</para>
Reindent man pages to 2ch
2015-02-03 21:14:13 -05:00
</refsect1>
<refsect1>
<title>Kernel Command Line</title>
<para><filename>systemd-hibernate-resume-generator</filename>
understands the following kernel command line parameters:</para>
<variablelist class='kernel-commandline-options'>
<varlistentry>
<term><varname>resume=</varname></term>
<listitem><para>Takes a path to the resume device. Both
persistent block device paths like
man: do not index various /foobar/ paths For #17177.
2020-09-29 10:04:12 +02:00
<filename index="false">/dev/disk/by-foo/bar</filename> and
man: fix a bunch of links All hail linkchecker!
2015-03-13 21:22:39 -05:00
<citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>-style
Reindent man pages to 2ch
2015-02-03 21:14:13 -05:00
specifiers like <literal>FOO=bar</literal> are
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 17:52:36 +01:00
supported.</para>
<xi:include href="version-info.xml" xpointer="v217"/></listitem>
Reindent man pages to 2ch
2015-02-03 21:14:13 -05:00
</varlistentry>
hibernate-resume: rework to follow the logic of sleep.c and use main-func.h Preparation for #27247
2023-04-19 01:21:55 +08:00
<varlistentry>
<term><varname>resume_offset=</varname></term>
<listitem><para>Takes the page offset of the swap space from the resume device.
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 17:52:36 +01:00
Defaults to <literal>0</literal>.</para>
<xi:include href="version-info.xml" xpointer="v254"/></listitem>
hibernate-resume: rework to follow the logic of sleep.c and use main-func.h Preparation for #27247
2023-04-19 01:21:55 +08:00
</varlistentry>
hibernate-resume: add resumeflags= kernel option Adds the resumeflags= kernel command line option to allow setting a custom device timeout for the resume device (defaults to the same as the root device).
2019-06-05 18:59:05 -06:00
<varlistentry>
<term><varname>resumeflags=</varname></term>
<listitem><para>Takes the resume device mount options to
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 17:52:36 +01:00
use. Defaults <varname>rootflags=</varname> if not specified.</para>
<xi:include href="version-info.xml" xpointer="v243"/></listitem>
hibernate-resume: add resumeflags= kernel option Adds the resumeflags= kernel command line option to allow setting a custom device timeout for the resume device (defaults to the same as the root device).
2019-06-05 18:59:05 -06:00
</varlistentry>
hib-res-generator: add "noresume" This is an override parameter, to totally skip dehiberanation.
2018-09-26 07:31:10 +02:00
<varlistentry>
<term><varname>noresume</varname></term>
<listitem><para>Do not try to resume from hibernation. If this parameter is
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 17:52:36 +01:00
present, <varname>resume=</varname> is ignored.</para>
<xi:include href="version-info.xml" xpointer="v240"/></listitem>
hib-res-generator: add "noresume" This is an override parameter, to totally skip dehiberanation.
2018-09-26 07:31:10 +02:00
</varlistentry>
Reindent man pages to 2ch
2015-02-03 21:14:13 -05:00
</variablelist>
</refsect1>
<refsect1>
<title>See Also</title>
man: use <simplelist> for 'See also' sections This is just a slight markup improvement; there should be no difference in rendering.
2023-12-22 19:09:32 +01:00
<para><simplelist type="inline">
<member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd-hibernate-resume.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
</simplelist></para>
Reindent man pages to 2ch
2015-02-03 21:14:13 -05:00
</refsect1>
hibernate-resume-generator: add a generator for instantiating the resume unit. hibernate-resume-generator understands resume= kernel command line parameter and instantiates the systemd-resume@.service accordingly if it is passed. This enables resume from hibernation using device specified on the kernel command line, and it may be specified either as "/dev/disk/by-foo/bar" or "FOO=bar", not only "/dev/sdXY" which is understood by the in-kernel implementation. So now resume= is brought on par with root= in terms of possible ways to specify a device.
2014-08-27 00:17:45 +04:00
</refentry>
Copy Permalink