diff options
author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2023-05-17 11:12:32 +0200 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2023-05-17 11:18:26 +0200 |
commit | 2f76f1cfaee2f775df8b367cb77aed751af45956 (patch) | |
tree | 65fc10b7423374a2f51b6fe326c705843a0cc0bf | |
parent | 42eccfec6e47a5436bd143ee357d2a2da620c2f2 (diff) | |
download | systemd-2f76f1cfaee2f775df8b367cb77aed751af45956.tar.gz |
man: explain allowed values for /sys/power/{disk,state}
Also fix the grammar: "neither" can only be used with two values, and
here we have an inderminate number >= 1.
Fixes #26460.
-rw-r--r-- | man/systemd-sleep.conf.xml | 55 |
1 files changed, 31 insertions, 24 deletions
diff --git a/man/systemd-sleep.conf.xml b/man/systemd-sleep.conf.xml index f8f1694b57..bdc4c3c193 100644 --- a/man/systemd-sleep.conf.xml +++ b/man/systemd-sleep.conf.xml @@ -138,21 +138,24 @@ <term><varname>HibernateMode=</varname></term> <term><varname>HybridSleepMode=</varname></term> - <listitem><para>The string to be written to - <filename>/sys/power/disk</filename> by, - respectively, + <listitem><para>The string to be written to <filename>/sys/power/disk</filename> by, respectively, <citerefentry><refentrytitle>systemd-suspend.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, or + <citerefentry><refentrytitle>systemd-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + or <citerefentry><refentrytitle>systemd-hybrid-sleep.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. - More than one value can be specified by separating - multiple values with whitespace. They will be tried - in turn, until one is written without error. If - neither succeeds, the operation will be aborted. - </para> - - <para><citerefentry><refentrytitle>systemd-suspend-then-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - uses the value of <varname>SuspendMode=</varname> when suspending and the value of <varname>HibernateMode=</varname> when hibernating. - </para></listitem> + More than one value can be specified by separating multiple values with whitespace. They will be + tried in turn, until one is written without error. If none of the writes succeed, the operation will + be aborted.</para> + + <para>The allowed set of values is determined by the kernel and is shown in the file itself (use + <command>cat /sys/power/disk</command> to display). See <ulink + url="https://www.kernel.org/doc/html/latest/admin-guide/pm/sleep-states.html#basic-sysfs-interfaces-for-system-suspend-and-hibernation">the + kernel documentation</ulink> for more details.</para> + + <para> + <citerefentry><refentrytitle>systemd-suspend-then-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + uses the value of <varname>SuspendMode=</varname> when suspending and the value of + <varname>HibernateMode=</varname> when hibernating.</para></listitem> </varlistentry> <varlistentry> @@ -160,21 +163,25 @@ <term><varname>HibernateState=</varname></term> <term><varname>HybridSleepState=</varname></term> - <listitem><para>The string to be written to - <filename>/sys/power/state</filename> by, - respectively, + <listitem><para>The string to be written to <filename>/sys/power/state</filename> by, respectively, <citerefentry><refentrytitle>systemd-suspend.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, or + <citerefentry><refentrytitle>systemd-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + or <citerefentry><refentrytitle>systemd-hybrid-sleep.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. - More than one value can be specified by separating - multiple values with whitespace. They will be tried - in turn, until one is written without error. If - neither succeeds, the operation will be aborted. + More than one value can be specified by separating multiple values with whitespace. They will be + tried in turn, until one is written without error. If none of the writes succeed, the operation will + be aborted. </para> - <para><citerefentry><refentrytitle>systemd-suspend-then-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - uses the value of <varname>SuspendState=</varname> when suspending and the value of <varname>HibernateState=</varname> when hibernating. - </para></listitem> + <para>The allowed set of values is determined by the kernel and is shown in the file itself (use + <command>cat /sys/power/state</command> to display). See <ulink + url="https://www.kernel.org/doc/html/latest/admin-guide/pm/sleep-states.html#basic-sysfs-interfaces-for-system-suspend-and-hibernation">the + kernel documentation</ulink> for more details.</para> + + <para> + <citerefentry><refentrytitle>systemd-suspend-then-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + uses the value of <varname>SuspendState=</varname> when suspending and the value of + <varname>HibernateState=</varname> when hibernating.</para></listitem> </varlistentry> <varlistentry> |