X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemd.service.xml;h=c0fc9a989ceb9d550cdf8df82dc1eaddbd528c69;hb=a9c72fe933efc9c77580fb4d7212e00f7a690c36;hp=7eaf9cbce3a316dc604bfde2e23ce96b3755403f;hpb=b3eaa6288107210a84d6d121036fb4b2f7283ee2;p=elogind.git diff --git a/man/systemd.service.xml b/man/systemd.service.xml index 7eaf9cbce..c0fc9a989 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -119,7 +119,7 @@ start-up type for this service unit. One of , , - , + , , . @@ -129,25 +129,27 @@ configured with ExecStart= is the main process of the service. In this - mode, communication channels must be - installed before the daemon is started - up (e.g. sockets set up by systemd, - via socket activation), as systemd - will immediately proceed starting - follow-up units. + mode, if the process offers + functionality to other processes on + the system its communication channels + should be installed before the daemon + is started up (e.g. sockets set up by + systemd, via socket activation), as + systemd will immediately proceed + starting follow-up units. If set to it is expected that the process configured with ExecStart= - will start up and call - fork(). The - parent process is expected to finish - when start-up is complete and all - communication channels set up. The - child continues to run as the main - daemon process. This is the behaviour - of traditional UNIX daemons. If this + will call fork() + as part of its start-up. The parent process is + expected to exit when start-up is + complete and all communication + channels set up. The child continues + to run as the main daemon + process. This is the behaviour of + traditional UNIX daemons. If this setting is used, it is recommended to also use the PIDFile= option, so @@ -158,11 +160,11 @@ exits. Behaviour of - is similar + is similar to , however it is expected that the process has to exit before systemd starts follow-up - units. ValidNoProcess= + units. RemainAfterExit= is particularly useful for this type of service. @@ -176,7 +178,7 @@ will proceed starting follow-up units after the D-Bus bus name has been acquired. Service units with this - option configured implicitly have + option configured implicitly gain dependencies on the dbus.target unit. @@ -193,17 +195,17 @@ notification message has been sent. If this option is used NotifyAccess= (see - below) must be set to open access to + below) should be set to open access to the notification socket provided by systemd. If NotifyAccess= is not - set, it will be implicitly set to + set, it will implicitly be set to . - ValidNoProcess= + RemainAfterExit= Takes a boolean value that specifies whether the service @@ -250,18 +252,48 @@ arguments for the process. It is mandatory to set this option for all services. This option may not be - specified more than once. Optionally, - if the absolute file name is prefixed - with @, the second - token will be passed as + specified more than once, except when + Type=oneshot is + used in which case more than one + ExecStart= line is + accepted which are then invoked one by + one, sequentially in the order they + appear in the unit file. + + Optionally, if the absolute file + name is prefixed with + @, the second token + will be passed as argv[0] to the executed process, followed by the - further arguments specified. Unless - Type=forking is set, - the process started via this command - line will be considered the main - process of the - daemon. + further arguments specified. If the + first token is prefixed with + - an exit code of + the command normally considered a + failure (i.e. non-zero exit status or + abormal exit due to signal) is ignored + and considered success. If both + - and + @ are used for the + same command the former must preceed + the latter. Unless + Type=forking is + set, the process started via this + command line will be considered the + main process of the daemon. The + command line accepts % specifiers as + described in + systemd.unit5. On + top of that basic environment variable + substitution is supported, where + ${FOO} is replaced + by the string value of the environment + variable of the same name. Also + $FOO may appear as + seperate word on the command line in + which case the variable is replaced by + its value split at + whitespaces. @@ -285,7 +317,9 @@ suitable for XDG .desktop files. Use of these settings is - optional. + optional. Specifier and environment + variable substitution is + supported. @@ -297,7 +331,17 @@ scheme as pointed out for ExecStartPre= above. Use of this setting is - optional. + optional. Specifier and environment + variable substitution is supported + here following the same scheme as for + ExecStart=. One + special environment variable is set: + if known $MAINPID is + set to the main process of the + daemon, and may be used for command + lines like the following: + /bin/kill -HUP + $(MAINPID). @@ -318,7 +362,11 @@ (see below). If this option is not specified the process is terminated right-away when service stop is - requested. + requested. Specifier and environment + variable substitution is supported + (including + $(MAINPID), see + above). @@ -333,7 +381,9 @@ out for ExecStartPre. Use of these settings is - optional. + optional. Specifier and environment + variable substitution is + supported.