summaryrefslogtreecommitdiff
path: root/man/systemd.swap.xml
Commit message (Collapse)AuthorAgeFilesLines
* man: mention pages with more settings at end of each option listZbigniew Jędrzejewski-Szmek2021-09-271-8/+6
| | | | | | | | | | | For some unit types we have hundreds of options, and the reader may easily miss that more options are described in other pages. We already mentioned this in the introduction and then at the top of the option list, but it can't hurt to repeat the information. Also, add an (almost empty) Options section for the unit types which don't have any custom options. It is nicer to have the same page structure in all cases, so people can jump between pages for different types more easily.
* man: document that automount units are privilegedLennart Poettering2020-12-091-0/+3
| | | | Fixes: #17886
* license: LGPL-2.1+ -> LGPL-2.1-or-laterYu Watanabe2020-11-091-1/+1
|
* tree-wide: drop quotes from around [section]Zbigniew Jędrzejewski-Szmek2020-07-061-3/+3
| | | | | | | 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.
* tree-wide: fixes for assorted grammar and spelling issuesZbigniew Jędrzejewski-Szmek2020-07-061-1/+1
| | | | Fixes #16363. Also includes some changes where I generalized the pattern.
* man: put all pages which mention a specifier in the indexZbigniew Jędrzejewski-Szmek2020-05-071-5/+7
| | | | | | I wasn't 100% convinced that this is the right thing to do, hence the separate commit. But e.g. for paths we index all mentions, so I think it's reasonable to do the same here.
* man: change noindex="true" to index="false"Zbigniew Jędrzejewski-Szmek2019-11-211-1/+1
| | | | We nowadays prefer positive options over negative.
* man: Add missing <literal> tags in various man pagesPhilip Withnall2019-06-121-3/+3
| | | | | | | A minor formatting improvement brought to you by the wonders of `git grep`. Signed-off-by: Philip Withnall <withnall@endlessm.com>
* codespell: fix spelling errorsBen Boeckel2019-04-291-1/+1
|
* man: use same header for all filesZbigniew Jędrzejewski-Szmek2019-03-141-1/+1
| | | | | | | 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: add referecne to systemd-system.confYu Watanabe2019-02-011-0/+1
|
* man: add missing descriptions of fstab options to systemd.swap(5)Zbigniew Jędrzejewski-Szmek2018-12-031-1/+23
|
* 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
* tree-wide: remove Lennart's copyright linesLennart Poettering2018-06-141-2/+0
| | | | | | | | | | | These lines are generally out-of-date, incomplete and unnecessary. With SPDX and git repository much more accurate and fine grained information about licensing and authorship is available, hence let's drop the per-file copyright notice. Of course, removing copyright lines of others is problematic, hence this commit only removes my own lines and leaves all others untouched. It might be nicer if sooner or later those could go away too, making git the only and accurate source of authorship information.
* 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: merge two sections into two subsections of one sectionZbigniew Jędrzejewski-Szmek2018-04-181-28/+32
| | | | Those are very close subjects that are a good fit for one section.
* 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.
* man: generalize "binary" to "program" (#7668)Alan Jenkins2017-12-161-1/+1
| | | | | | | | | | | Systemd services are permitted to be scripts, as well as binary executables. The same also applies to the underlying /sbin/mount and /sbin/swapon. It is not necessary for the user to consider what type of program file these are. Nor is it necessary with systemd-nspawn, to distinguish between init as a "binary" v.s. a user-specified "program". Also fix a couple of grammar nits in the modified sentences.
* Add SPDX license identifiers to man pagesZbigniew Jędrzejewski-Szmek2017-11-191-0/+2
|
* man: explicitly distinguish "implicit dependencies" and "default dependencies"John Lin2017-09-131-9/+20
| | | | Fixes: #6793
* Merge pull request #5255 from poettering/percent-escapeZbigniew Jędrzejewski-Szmek2017-02-091-16/+13
|\ | | | | fstab-generator: Options= applies specifier expansion
| * fstab-generator: also convert % → %% for What=Lennart Poettering2017-02-081-11/+9
| | | | | | | | Same reasons as the previous patch.
| * fstab-generator: Options= applies specifier expansionLennart Poettering2017-02-081-5/+4
| | | | | | | | | | | | | | Let's document that this is the case, and properly escape % when we generate Options= in the generator. Fixes: #5086
* | man: fix docs for swap's DefaultDependencies= (#5278)David Glasser2017-02-091-4/+4
|/ | | | | | | There was a missing dependency and one with the wrong type. Additionally, refer to DefaultDependencies= once instead of twice, without a vague reference in the first one that doesn't mention that the value matters. Fixes #5226.
* man: document that some unit types do not support unit aliases via symlinksLennart Poettering2016-04-291-7/+6
|
* man: clarify that DefaultDependencies= is in the [Unit] sectionLennart Poettering2016-04-121-6/+4
| | | | This hopefully reduces confusion resulting in issues like #2992.
* Typo fixesMichael Biebl2016-02-121-1/+1
|
* man: document automatic dependenciesLennart Poettering2015-11-111-10/+24
| | | | | | | | | | | For all units ensure there's an "Automatic Dependencies" section in the man page, and explain which dependencies are automatically added in all cases, and which ones are added on top if DefaultDependencies=yes is set. This is also done for systemd.exec(5), systemd.resource-control(5) and systemd.unit(5) as these pages describe common behaviour of various unit types.
* doc: correct orthography, word forms and missing/extraneous wordsJan Engelhardt2015-11-061-3/+3
|
* doc: correct punctuation and improve typography in documentationJan Engelhardt2015-11-061-3/+3
|
* man: revert dynamic paths for split-usr setupsTom Gundersen2015-06-181-4/+1
| | | | | | | | | | | | | | | | | | | | | | | 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: minor typo fixLennart Poettering2015-06-171-1/+1
|
* man: generate configured paths in manpagesFilipe Brandenburger2015-05-281-1/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* swap: use swapon -oKarel Zak2015-05-251-1/+2
| | | | | | | | | | | | | | | | This patch simplify swapon usage in systemd. The command swapon(8) since util-linux v2.26 supports "-o <list>". The idea is exactly the same like for mount(8). The -o specifies options in fstab-compatible way. For systemd it means that it does not have to care about things like "discard" or another swapon specific options. swapon -o <options-from-fstab> For backward compatibility the code cares about "Priority:" swap unit field (for a case when Priority: is set, but pri= in the Options: is missing). References: http://lists.freedesktop.org/archives/systemd-devel/2014-October/023576.html
* man: fix a bunch of linksZbigniew Jędrzejewski-Szmek2015-03-131-5/+5
| | | | All hail linkchecker!
* man: boilerplate unificationZbigniew Jędrzejewski-Szmek2015-02-101-1/+0
|
* Reindent man pages to 2chZbigniew Jędrzejewski-Szmek2015-02-031-233/+213
|
* man: remove "nofail" from systemd.swap(5)Zbigniew Jędrzejewski-Szmek2015-01-131-4/+1
| | | | As suggested by Marcos Felipe Rasia de Mello <marcosfrm@gmail.com>.
* swap: restore support for nofailZbigniew Jędrzejewski-Szmek2014-11-261-6/+34
| | | | | | | | | | | | | | | | systemd stops adding automatic dependencies on swap.target to swap units. If a dependency is required, it has to be added by unit configuration. fstab-generator did that already, except that now it is modified to create a Requires or Wants type dependency, depending on whether nofail is specified in /etc/fstab. This makes .swap units obey the nofail/noauto options more or less the same as .mount units. Documentation is extended to clarify that, and to make systemd.mount(5) and system.swap(5) more similar. The gist is not changed, because current behaviour actually matches existing documentation. https://bugs.freedesktop.org/show_bug.cgi?id=86488
* swap: replace Discard= setting by a more generic Options= settingLennart Poettering2014-10-281-8/+8
| | | | | | For now, it's systemd itself that parses the options string, but as soon as util-linux' swapon can take the option string directly with -o we should pass it on unmodified.
* man: fix typosJan Synacek2014-10-151-1/+1
|
* swap: introduce Discard propertyJan Synacek2014-09-291-0/+14
| | | | Process possible "discard" values from /etc/fstab.
* man: fix references to systemctl man page which is now in section 1Michael Biebl2014-09-061-1/+1
| | | | https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=760613
* man: correct references to DefaultTimeout*SecZbigniew Jędrzejewski-Szmek2014-08-071-3/+5
| | | | Noticed by thp on #systemd.
* man: improvements to comma placementJan Engelhardt2013-12-251-1/+1
| | | | | This is a recurring submission and includes corrections to: comma placement.
* man: wording and grammar updatesJan Engelhardt2013-11-071-1/+1
| | | | | This is a recurring submission and includes corrections to various issue spotted: comma setting, missing words/preposition choice.
* Configurable Timeouts/Restarts default valuesOleksii Shevchuk2013-11-051-2/+2
| | | | | | | https://bugs.freedesktop.org/show_bug.cgi?id=71132 Patch adds DefaultTimeoutStartSec, DefaultTimeoutStopSec, DefaultRestartSec configuration options to manager configuration file.
* man: drop references to "cgroup" wher appropriateLennart Poettering2013-09-271-3/+3
| | | | | | | | | | | Since cgroups are mostly now an implementation detail of systemd lets deemphasize it a bit in the man pages. This renames systemd.cgroup(5) to systemd.resource-control(5) and uses the term "resource control" rather than "cgroup" where appropriate. This leaves the word "cgroup" in at a couple of places though, like for example systemd-cgtop and systemd-cgls where cgroup stuff is at the core of what is happening.
* man: wording and grammar updatesJan Engelhardt2013-09-121-2/+2
| | | | | | | | | | | | This is a recurring submission and includes corrections to various issue spotted. I guess I can just skip over reporting ubiquitous comma placement fixes… Highligts in this particular commit: - the "unsigned" type qualifier is completed to form a full type "unsigned int" - alphabetic -> lexicographic (that way we automatically define how numbers get sorted)