summaryrefslogtreecommitdiff
path: root/man/systemd.service.xml
AgeCommit message (Collapse)Author
2017-02-21man: use https:// in URLsAsciiWolf
2017-02-07man: add cross-referenceLucas Werkmeister
The third paragraph of the Description already linked to systemd.resource-control(5), but it was missing from the list of additional options for the [Service] section.
2017-02-06man: document that sd_notify() is racy in some casesLennart Poettering
2017-01-14Merge pull request #4879 from poettering/systemdZbigniew Jędrzejewski-Szmek
2016-12-24man: Align ExecStop= documentation with actual kill behavior (#4974)Felipe Sateler
The manpage claimed that ExecStop would be followed immediately by SIGKILL, whereas the actual behavior is to go through KillMode= and KillSignal= first. Fixes #4490
2016-12-21man: document that services need at least one of ExecStart= or ExecStop=Lennart Poettering
Fixes: #4521
2016-12-11man: use unicode ellipsis in more placesZbigniew Jędrzejewski-Szmek
As requested in https://github.com/systemd/systemd/pull/4864#pullrequestreview-12372557. docbook will substitute triple dots for the ellipsis in man output, so this has no effect on the troff output, only on HTML, making it infinitesimally nicer. In some places we show output from programs, which use dots, and those places should not be changed. In some tables, the alignment would change if dots were changed to the ellipsis which is only one character. Since docbook replaces the ellipsis automatically, we should leave those be. This patch changes all other places.
2016-12-11basic/extract-word,man: clarify "correction" of invalid escapesZbigniew Jędrzejewski-Szmek
Our warning message was misleading, because we wouldn't "correct" anything, we'd just ignore unkown escapes. Update the message. Also, print just the extracted word (which contains the offending sequences) in the message, instead of the whole line. Fixes #4697.
2016-11-29service: new NotifyAccess= value for control processes (#4212)Jouke Witteveen
Setting NotifyAccess=exec allows notifications coming directly from any control process.
2016-11-10man: mention start rate limiting in Restart= doc (#4637)Lucas Werkmeister
2016-10-28man: add a note that FDSTORE=1 requires epoll-compatible fdsZbigniew Jędrzejewski-Szmek
Let's say that this was not obvious from our man page.
2016-10-19man: document dependencies implied by Sockets= (#4412)Lucas Werkmeister
Fixes #4410. Also includes two minor improvements to the previous sentence.
2016-10-11man: document that Type=idle is subject to a 5s time-outLennart Poettering
Fixes: #4116
2016-08-11man: add "timeout" to status table (#3919)Zbigniew Jędrzejewski-Szmek
2016-08-04core: set $SERVICE_RESULT, $EXIT_CODE and $EXIT_STATUS in ↵Lennart Poettering
ExecStop=/ExecStopPost= commands This should simplify monitoring tools for services, by passing the most basic information about service result/exit information via environment variables, thus making it unnecessary to retrieve them explicitly via the bus.
2016-07-25core: change ExecStart=! syntax to ExecStart=+ (#3797)Lennart Poettering
As suggested by @mbiebl we already use the "!" special char in unit file assignments for negation, hence we should not use it in a different context for privileged execution. Let's use "+" instead.
2016-06-28man: clarify NotifyAccess overriding (#3620)Luca Bruno
Type=notify has a magic overriding case where a NotifyAccess=none is turned into a NotifyAccess=main for sanity purposes. This makes docs more clear about such behavior: https://github.com/systemd/systemd/blob/2787d83c28b7565ea6f80737170514e5e6186917/src/core/service.c#L650:L651
2016-06-10core/execute: add the magic character '!' to allow privileged execution (#3493)Alessandro Puccetti
This patch implements the new magic character '!'. By putting '!' in front of a command, systemd executes it with full privileges ignoring paramters such as User, Group, SupplementaryGroups, CapabilityBoundingSet, AmbientCapabilities, SecureBits, SystemCallFilter, SELinuxContext, AppArmorProfile, SmackProcessLabel, and RestrictAddressFamilies. Fixes partially https://github.com/systemd/systemd/issues/3414 Related to https://github.com/coreos/rkt/issues/2482 Testing: 1. Create a user 'bob' 2. Create the unit file /etc/systemd/system/exec-perm.service (You can use the example below) 3. sudo systemctl start ext-perm.service 4. Verify that the commands starting with '!' were not executed as bob, 4.1 Looking to the output of ls -l /tmp/exec-perm 4.2 Each file contains the result of the id command. ````````````````````````````````````````````````````````````````` [Unit] Description=ext-perm [Service] Type=oneshot TimeoutStartSec=0 User=bob ExecStartPre=!/usr/bin/sh -c "/usr/bin/rm /tmp/exec-perm*" ; /usr/bin/sh -c "/usr/bin/id > /tmp/exec-perm-start-pre" ExecStart=/usr/bin/sh -c "/usr/bin/id > /tmp/exec-perm-start" ; !/usr/bin/sh -c "/usr/bin/id > /tmp/exec-perm-star-2" ExecStartPost=/usr/bin/sh -c "/usr/bin/id > /tmp/exec-perm-start-post" ExecReload=/usr/bin/sh -c "/usr/bin/id > /tmp/exec-perm-reload" ExecStop=!/usr/bin/sh -c "/usr/bin/id > /tmp/exec-perm-stop" ExecStopPost=/usr/bin/sh -c "/usr/bin/id > /tmp/exec-perm-stop-post" [Install] WantedBy=multi-user.target] `````````````````````````````````````````````````````````````````
2016-04-12man: clarify that DefaultDependencies= is in the [Unit] sectionLennart Poettering
This hopefully reduces confusion resulting in issues like #2992.
2016-02-11Merge pull request #2590 from zonque/bus-endpoint-removalZbigniew Jędrzejewski-Szmek
Remove kdbus custom endpoint support
2016-02-12man: fix typosJakub Wilk
2016-02-11Remove kdbus custom endpoint supportDaniel Mack
This feature will not be used anytime soon, so remove a bit of cruft. The BusPolicy= config directive will stay around as compat noop.
2016-02-10man: document that ExecStartPost= is only run if ExecStart= succeededLennart Poettering
Fixes: #846
2016-02-10core: make the StartLimitXYZ= settings generic and apply to any kind of ↵Lennart Poettering
unit, not just services This moves the StartLimitBurst=, StartLimitInterval=, StartLimitAction=, RebootArgument= from the [Service] section into the [Unit] section of unit files, and thus support it in all unit types, not just in services. This way we can enforce the start limit much earlier, in particular before testing the unit conditions, so that repeated start-up failure due to failed conditions is also considered for the start limit logic. For compatibility the four options may also be configured in the [Service] section still, but we only document them in their new section [Unit]. This also renamed the socket unit failure code "service-failed-permanent" into "service-start-limit-hit" to express more clearly what it is about, after all it's only triggered through the start limit being hit. Finally, the code in busname_trigger_notify() and socket_trigger_notify() is altered to become more alike. Fixes: #2467
2016-02-03core: when a service's ExecStartPre= times out, skip ExecStop=Lennart Poettering
This makes sure we never run two control processes at the same time, we cannot keep track off. This introduces a slight change of behaviour but cleans up the definition of ExecStop= and ExecStopPost=. The former is now invoked only if the service managed to start-up correctly. The latter is called even if start-up failed half-way. Thus, ExecStopPost= may be used as clean-up step for both successful and failed start-up attempts, but ExecStop='s purpose is clearly defined as being responsible for shutting down the service and nothing else. The precise behaviour of this was not documented yet. This commit adds the necessary docs. Fixes: #1254
2016-02-01man: document the new RuntimeMaxSec= settingLennart Poettering
2016-01-29man: document special considerations when mixing templated service units and ↵Lennart Poettering
DefaultDependencies=no Fixes #2189.
2015-11-21man: update WatchdogSec sectionEvgeny Vereshchagin
* add info about sd_event_set_watchdog * add missing Restart values
2015-11-19man: fully document sd-event interfacesLennart Poettering
This completes the set of man pages for sd-event and contains some minor other fixes for other man pages too. The sd_event_set_name(3) man page is renamed to sd_event_source_set_description(3), which is the correct name of the concept today.
2015-11-13man: add note about sd_watchdog_enabledEvgeny Vereshchagin
2015-11-11man: document automatic dependenciesLennart Poettering
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.
2015-11-06doc: use expanded forms for written styleJan Engelhardt
2015-11-06doc: correct orthography, word forms and missing/extraneous wordsJan Engelhardt
2015-11-06doc: correct punctuation and improve typography in documentationJan Engelhardt
2015-10-07man: fix typo ('and' -> 'are')Michal Schmidt
2015-10-01man: minor wording improvements to USB FunctionFS documentationLennart Poettering
2015-09-30man: use "=" when referring to configuration file settingsZbigniew Jędrzejewski-Szmek
This convention is almost universal in systemd man pages, and makes it easier to visually parse the docs. Also fix some markup along the way.
2015-09-30man: add link to functionfs docsZbigniew Jędrzejewski-Szmek
Also reword some ungainly grammar constructs.
2015-09-22man: Add documentation for functionfs socket activationPawel Szewczyk
2015-08-11man: Describe when ExecStartFoo= commands are run in more detailRichard Maw
Previously it was just descibed that ExecStartPost= commands were started "after" the ExecStart= command(s). This hasn't specified after which event, which varies from after it has been started, after it has exited, after it has sent READY=1 or after it has taken the bus name, depending on Type=. This now describes that it happens after the *service* has "started", as defined by the Type=, and provides some clarification about precisely when this is. This may be unnecessary duplication, but it removes the ambiguity as to whether RemainAfterExit=no means that ExecStartPost= shouldn't be started because it means the service has stopped when the ExecStart= command terminates, not "started".
2015-08-07man: clarify that unknown escapes must be escapedZbigniew Jędrzejewski-Szmek
https://bugzilla.redhat.com/show_bug.cgi?id=1251334 is about a unit file which has Environment=TERM=linux PS1=system-upgrade:\w\$\x20 We used to allow that, but after recent tightening of parsing rules, we barf. Make it clear that this is intentional.
2015-06-27systemd.service.xml: document that systemd removes the PIDFileFelipe Sateler
2015-06-22man: remove links to outdated kdbus development repositoryKay Sievers
2015-06-18man: revert dynamic paths for split-usr setupsTom Gundersen
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-15man: document that ExecStop= needs a synchronous toolLennart Poettering
As requested in #199.
2015-05-28man: generate configured paths in manpagesFilipe Brandenburger
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.
2015-05-11treewide: Correct typos and spell plural of bus consistentTorstein Husebø
2015-03-09man: document that ExecStartPre= is not the place to start long-running ↵Lennart Poettering
processes
2015-02-10man: boilerplate unificationZbigniew Jędrzejewski-Szmek
2015-02-03Reindent man pages to 2chZbigniew Jędrzejewski-Szmek