summaryrefslogtreecommitdiffstats
path: root/man/systemd-sleep.conf.xml (follow)
Commit message (Collapse)AuthorAgeFilesLines
* man: grammar fixes for introductory adverbs/phrasesJan Engelhardt2024-12-251-1/+1
|
* sleep: add HibernateOnACPower= option (#33846)Marc Reisner2024-08-051-0/+17
| | | * Add HibernateOnACPower= systemd-sleep configuration option
* sleep: rename SleepMemMode= to MemorySleepMode=Mike Yuan2024-04-051-1/+1
| | | | Addresses https://github.com/systemd/systemd/pull/31986#discussion_r1554053623
* sleep: add SleepMemMode= setting for configuring /sys/power/mem_sleepMike Yuan2024-03-281-0/+18
| | | | | | | | The setting is used when /sys/power/state is set to 'mem' (common for suspend) or /sys/power/disk is set to 'suspend' (hybrid-sleep). We default to kernel choice here, i.e. respect what's set through 'mem_sleep_default=' kernel cmdline option.
* man/systemd-sleep: reorder optionsMike Yuan2024-03-281-12/+12
|
* man: document all the new pathsZbigniew Jędrzejewski-Szmek2024-03-071-0/+2
|
* tree-wide: link to docs.kernel.org for kernel documentationnl67202024-01-221-2/+2
| | | | | https://www.kernel.org/ links to https://docs.kernel.org/ for the documentation. These URLs are shorter and nicer looking.
* man/systemd-sleep.conf: document the operation of s2h more thoroughlyMike Yuan2024-01-141-13/+19
|
* man: use same version in public and system ident.David Tardon2023-12-251-1/+1
|
* man: use <simplelist> for 'See also' sectionsDavid Tardon2023-12-231-9/+9
| | | | | This is just a slight markup improvement; there should be no difference in rendering.
* man: use <simplelist> for file lists in synopsisZbigniew Jędrzejewski-Szmek2023-12-151-4/+6
| | | | | | | | | | | | | | | | | | With <para><filename>…</filename></para>, we get a separate "paragraph" for each line, i.e. entries separated by empty lines. This uses up a lot of space and was only done because docbook makes it hard to insert a newline. In some other places, <literallayout> was used, but then we cannot indent the source text (because the whitespace would end up in the final page). We can get the desired result with <simplelist>. With <simplelist> the items are indented in roff output, but not in html output. In some places this looks better then no indentation, and in others it would probably be better to have no indent. But this is a minor issue and we cannot control that. (I didn't convert all spots. There's a bunch of other man pages which have two lines, e.g. an executable and service file, and it doesn't matter there so much.)
* man: use meaningful titles for <ulink>sZbigniew Jędrzejewski-Szmek2023-11-061-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | As pointed out in https://github.com/systemd/systemd/issues/29814, we need to use phrases are are meaningful on their own, because the man page formatter creates a list at the bottom. With <ulink>see docs</ulink>, we end up with: NOTES: 1. see docs https://some.url/page 2. see docs https://some.url/page2 which is not very useful :( Also, the text inside the tag should not include punctuation. Python helper: from xml_helper import xml_parse for p in glob.glob('../man/*.xml'): t = xml_parse(p) ulinks = t.iterfind('.//ulink') for ulink in ulinks: if ulink.text is None: continue text = ' '.join(ulink.text.split()) print(f'{p}: {text}')
* man: drop obsolete reference to SuspendMode=Luca Boccassi2023-11-041-2/+1
| | | | Follow-up for 1f82c21dce
* sleep-config: make hybrid sleep always use 'suspend' disk modeMike Yuan2023-10-241-8/+2
| | | | | | | | | If user requests hybrid sleep, we should always use 'suspend' disk mode. If that's not supported, let's correctly report it so they can choose plain hibernation instead. HybridSleepMode= serves no purpose in this case and should be removed. Addresses https://github.com/systemd/systemd/pull/29681#discussion_r1369812785
* sleep-config: remove HibernateState= & HybridSleepState=, restrictMike Yuan2023-10-231-16/+10
| | | | | | | | | | SuspendState= not to include "disk" I don't know why these existed in the first place, but as I justified in the comments, it's simply not sensible to allow HibernateState= or HybridSleepState= to take values other than 'disk'. So let's just remove those options. Also, SuspendState= should not contain 'disk'.
* man: add version infoAbderrahim Kitouni2023-08-291-7/+25
| | | | | | | | 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.
* man: explain allowed values for /sys/power/{disk,state}Zbigniew Jędrzejewski-Szmek2023-05-171-24/+31
| | | | | | | Also fix the grammar: "neither" can only be used with two values, and here we have an inderminate number >= 1. Fixes #26460.
* sleep: fix default values unmatched with manualMike Yuan2023-03-171-1/+1
|
* sleep: introduce SuspendEstimationSec=Yu Watanabe2023-01-271-28/+30
| | | | | | | | | | | | | | | | | | | Before v252, HibernateDelaySec= specifies the maximum timespan that the system in suspend state, and the system hibernate after the timespan. However, after 96d662fa4c8cab24da57523c5e49e6ef3967fc13, the setting is repurposed as the default interval to measure battery charge level and estimate the battery discharging late. And if the system has enough battery capacity, then the system will stay in suspend state and not hibernate even if the time passed. See issue #25269. To keep the backward compatibility, let's introduce another setting SuspendEstimationSec= for controlling the interval to measure battery charge level, and make HibernateDelaySec= work as of v251. This also drops implementation details from the man page. Fixes #25269.
* sleep: doc update for multiple battery, acpi_btp support and freeze/thaw ↵Sonali Srivastava2022-08-261-13/+20
| | | | user.slice
* tree-wide: fix typoYu Watanabe2022-08-011-1/+1
|
* sleep: store battery discharge rate/hour with hashSonali Srivastava2022-07-201-6/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Estimated battery discharge rate per hour is stored in : /var/lib/systemd/sleep/battery_discharge_percentage_rate_per_hour This value is used to determine the initial suspend interval. In case this file is not available or value is invalid, HibernateDelaySec interval is used. After wakeup from initial suspend, this value is again estimated and written to file if value is in range of 1-199. Logs for reference : HibernateDelaySec=15min - Updated in /etc/systemd/sleep.conf Jul 14 19:17:58 localhost systemd-sleep[567]: Current battery charge percentage: 100% Jul 14 19:17:58 localhost systemd-sleep[567]: Failed to read discharge rate from /var/lib/systemd/sleep/batt ery_discharge_percentage_rate_per_hour: No such file or directory Jul 14 19:17:58 localhost systemd-sleep[567]: Set timerfd wake alarm for 15min Jul 14 19:33:00 localhost systemd-sleep[567]: Current battery charge percentage after wakeup: 90% Jul 14 19:33:00 localhost systemd-sleep[567]: Attempting to estimate battery discharge rate after wakeup from 15min sleep Jul 14 19:33:00 localhost systemd-sleep[567]: product_id does not exist: No such file or directory Jul 14 19:33:00 localhost systemd-sleep[567]: Estimated discharge rate 39 successfully updated to /var/lib/systemd/sleep/battery_discharge_percentage_rate_per_hour Jul 14 19:33:00 localhost systemd-sleep[567]: Current battery charge percentage: 90% Jul 14 19:33:00 localhost systemd-sleep[567]: product_id does not exist: No such file or directory Jul 14 19:33:00 localhost systemd-sleep[567]: Set timerfd wake alarm for 1h 48min 27s Jul 14 21:21:30 localhost systemd-sleep[567]: Current battery charge percentage after wakeup: 90% Jul 14 21:21:30 localhost systemd-sleep[567]: Battery was not discharged during suspension
* man: fix systemd-sleep.conf.xml whitespaceLuca Boccassi2021-07-071-1/+2
| | | | Follow-up for 33f899bd479534b0a920ce427cdf06739028f5ab
* Clarify the behaviour of suspend-then-sleep mode in the manual pages.Hamish Moffatt2021-07-071-6/+11
| | | | Fixes #20125.
* license: LGPL-2.1+ -> LGPL-2.1-or-laterYu Watanabe2020-11-091-1/+1
|
* man: fix some manvolnumAnita Zhang2020-07-111-1/+1
|
* tree-wide: drop quotes from around [section]Zbigniew Jędrzejewski-Szmek2020-07-061-1/+1
| | | | | | | For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
* man: document default HibernateDelaySec= settingLennart Poettering2019-07-291-5/+4
|
* man: use same header for all filesZbigniew Jędrzejewski-Szmek2019-03-141-2/+2
| | | | | | | 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
* man: standarize on one-line license headerZbigniew Jędrzejewski-Szmek2019-03-141-4/+1
| | | | | | No need to waste space, and uniformity is good. $ perl -i -0pe 's|\n+<!--\s*SPDX-License-Identifier: LGPL-2.1..\s*-->|\n<!-- SPDX-License-Identifier: LGPL-2.1+ -->|gms' man/*.xml
* man: move all config file options to one sectionZbigniew Jędrzejewski-Szmek2019-02-131-1/+1
| | | | | | We had "SYSTEM MANAGER DIRECTIVES" which was a misnomer already, because it also listed user manager stuff. Let's make this a more general section and move the items for other services there too (from "MISCELANENOUS").
* shared/sleep-config: add switches to kill specific sleep modesZbigniew Jędrzejewski-Szmek2018-10-081-0/+18
| | | | | | | | | | | | /etc/systemd/sleep.conf gains four new switches: AllowSuspend=, AllowHibernation=, AllowSuspendThenHibernate=, AllowHybridSleep=. Disabling specific modes was already possible by masking suspend.target, hibernate.target, suspend-then-hibernate.target, or hybrid-sleep.target. But this is not convenient for distributions, which want to set some defaults based on what they want to support. Having those available as configuration makes it easy to put a config file in /usr/lib/systemd/sleep.conf.d/ that overrides the defaults and gives instructions how to undo that override.
* man: drop mode line in file headersZbigniew Jędrzejewski-Szmek2018-07-031-1/+1
| | | | | This is already included in .dir-locals, so we don't need it in the files themselves.
* Merge pull request #9301 from keszybz/man-drop-authorgroupLennart Poettering2018-06-141-9/+0
|\ | | | | man: drop unused <authorgroup> tags from man sources
| * man: drop unused <authorgroup> tags from man sourcesZbigniew Jędrzejewski-Szmek2018-06-141-9/+0
| | | | | | | | | | | | | | | | | | | | | | | | Docbook styles required those to be present, even though the templates that we use did not show those names anywhere. But something changed semi-recently (I would suspect docbook templates, but there was only a minor version bump in recent years, and the changelog does not suggest anything related), and builds now work without those entries. Let's drop this dead weight. Tested with F26-F29, debian unstable. $ perl -i -0pe 's/\s*<authorgroup>.*<.authorgroup>//gms' man/*xml
* | Drop my copyright headersZbigniew Jędrzejewski-Szmek2018-06-141-2/+0
|/ | | | | | | perl -i -0pe 's/\s*Copyright © .... Zbigniew Jędrzejewski.*?\n/\n/gms' man/*xml git grep -e 'Copyright.*Jędrzejewski' -l | xargs perl -i -0pe 's/(#\n)?# +Copyright © [0-9, -]+ Zbigniew Jędrzejewski.*?\n//gms' git grep -e 'Copyright.*Jędrzejewski' -l | xargs perl -i -0pe 's/\s*\/\*\*\*\s+Copyright © [0-9, -]+ Zbigniew Jędrzejewski[^\n]*?\s*\*\*\*\/\s*/\n\n/gms' git grep -e 'Copyright.*Jędrzejewski' -l | xargs perl -i -0pe 's/\s+Copyright © [0-9, -]+ Zbigniew Jędrzejewski[^\n]*//gms'
* tree-wide: beautify remaining copyright statementsLennart Poettering2018-06-141-1/+1
| | | | | | Let's unify an beautify our remaining copyright statements, with a unicode ©. This means our copyright statements are now always formatted the same way. Yay.
* tree-wide: drop 'This file is part of systemd' blurbLennart Poettering2018-06-141-2/+0
| | | | | | | | | | | | | | | | This part of the copyright blurb stems from the GPL use recommendations: https://www.gnu.org/licenses/gpl-howto.en.html The concept appears to originate in times where version control was per file, instead of per tree, and was a way to glue the files together. Ultimately, we nowadays don't live in that world anymore, and this information is entirely useless anyway, as people are very welcome to copy these files into any projects they like, and they shouldn't have to change bits that are part of our copyright header for that. hence, let's just get rid of this old cruft, and shorten our codebase a bit.
* man: add a new page with a general description of common syntaxZbigniew Jędrzejewski-Szmek2018-04-181-1/+4
| | | | | | | | We have a common parser, but for the user it might be completely unobvious that the same general rules apply to all those files. Let's add a page about the basic syntax so that the more specific pages don't have to repeat those details.
* tree-wide: drop license boilerplateZbigniew Jędrzejewski-Szmek2018-04-061-13/+0
| | | | | | | | | | Files which are installed as-is (any .service and other unit files, .conf files, .policy files, etc), are left as is. My assumption is that SPDX identifiers are not yet that well known, so it's better to retain the extended header to avoid any doubt. I also kept any copyright lines. We can probably remove them, but it'd nice to obtain explicit acks from all involved authors before doing that.
* Rename suspend-to-hibernate to suspend-then-hibernateMario Limonciello2018-03-281-5/+5
| | | | | Per some discussion with Gnome folks, they would prefer this name as it's more descriptive of what's happening.
* Introduce suspend-to-hibernate (#8274)Mario Limonciello2018-03-081-5/+28
| | | | | | | | | | | | | | Suspend to Hibernate is a new sleep method that invokes suspend for a predefined period of time before automatically waking up and hibernating the system. It's similar to HybridSleep however there isn't a performance impact on every suspend cycle. It's intended to use with systems that may have a higher power drain in their supported suspend states to prevent battery and data loss over an extended suspend cycle. Signed-off-by: Mario Limonciello <mario.limonciello@dell.com>
* Add SPDX license identifiers to man pagesZbigniew Jędrzejewski-Szmek2017-11-191-0/+2
|
* man: revert dynamic paths for split-usr setupsTom Gundersen2015-06-181-8/+5
| | | | | | | | | | | | | | | | | | | | | | | 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.
* man: generate configured paths in manpagesFilipe Brandenburger2015-05-281-5/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In particular, use /lib/systemd instead of /usr/lib/systemd in distributions like Debian which still have not adopted a /usr merge setup. Use XML entities from man/custom-entities.ent to replace configured paths while doing XSLT processing of the original XML files. There was precedent of some files (such as systemd.generator.xml) which were already using this approach. This addresses most of the (manual) fixes from this patch: http://anonscm.debian.org/cgit/pkg-systemd/systemd.git/tree/debian/patches/Fix-paths-in-man-pages.patch?h=experimental-220 The idea of using generic XML entities was presented here: http://lists.freedesktop.org/archives/systemd-devel/2015-May/032240.html This patch solves almost all the issues, with the exception of: - Path to /bin/mount and /bin/umount. - Generic statements about preference of /lib over /etc. These will be handled separately by follow up patches. Tested: - With default configure settings, ran "make install" to two separate directories and compared the output to confirm they matched exactly. - Used a set of configure flags including $CONFFLAGS from Debian: http://anonscm.debian.org/cgit/pkg-systemd/systemd.git/tree/debian/rules Installed the tree and confirmed the paths use /lib/systemd instead of /usr/lib/systemd and that no other unexpected differences exist. - Confirmed that `make distcheck` still passes.
* man: fix indentation of copyright headersZbigniew Jędrzejewski-Szmek2015-03-141-12/+12
|
* Do not advertise .d snippets over main config fileZbigniew Jędrzejewski-Szmek2015-03-041-2/+1
| | | | | | | | | | For daemons which have a main configuration file, there's little reason for the administrator to use configuration snippets. They are useful for packagers which need to override settings, but we shouldn't advertise that as the main way of configuring those services. https://bugs.freedesktop.org/show_bug.cgi?id=89397
* man: boilerplate unificationZbigniew Jędrzejewski-Szmek2015-02-111-1/+0
|
* systemd-sleep: Support sleep.conf.d directories in the usual search pathsJosh Triplett2014-11-291-3/+12
|
* man: add emacs header to get correct indention in nxml-mode for the manpage ↵Lennart Poettering2014-11-211-1/+1
| | | | | | | | XML files that use 2ch indenting In the long run we really should figure out if we want to stick with 8ch or 2ch indenting, and not continue with half-and-half. For now, just make emacs aware of the files that use 2ch indenting.