X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.unit.xml;h=14ec4561b2e925fc9ca74b758c16ef81b540d445;hp=e5d5968ab2227d0711504864ab6d73be38077c02;hb=b24a167b6f0f9a44686736734e6d0cec07e1efa3;hpb=69dd2852bb2c433b517d89792adb4461a4178aa1 diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index e5d5968ab..14ec4561b 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -182,13 +182,30 @@ %i specifier in many of the configuration options. Other specifiers that may be used are %n, %N, - %p, %P and - %I, for the full unit name, the - unescaped unit name, the prefix name, the unescaped - prefix name and the unescaped instance name, - respectively. The prefix name here refers to the - string before the @, i.e. "getty" in the example - above, where "tty3" is the instance name. + %p, %P, + %I and %f, for + the full unit name, the unescaped unit name, the + prefix name, the unescaped prefix name, the unescaped + instance name and the unescaped filename, + respectively. The unescaped filename is either the + unescaped instance name (if set) with / prepended (if + necessary), or the prefix name similarly prepended + with /. The prefix name here refers to the string + before the @, i.e. "getty" in the example above, where + "tty3" is the instance name. + + If a unit file is empty (i.e. has the file size + 0) or is symlinked to /dev/null + its configuration will not be loaded and it appears + with a load state of masked, and + cannot be activated. Use this as an effective way to + fully disable a unit, making it impossible to start it + even manually. + + The unit file format is covered by the + Interface + Stability Promise. @@ -264,7 +281,6 @@ services. - RequiresOverridable= @@ -323,6 +339,23 @@ details see above. + + BindTo= + + Configures requirement + dependencies, very similar in style to + Requires=, however + in addition to this behaviour it also + declares that this unit is stopped + when any of the units listed suddenly + disappears. Units can suddenly, + unexpectedly disappear if a service + terminates on its own choice, a device + is unplugged or a mount point + unmounted without involvement of + systemd. + + Conflicts= @@ -418,28 +451,9 @@ Lists one or more units that are activated when this - unit fails (i.e. enters maintenance - state). - - - - RecursiveStop= - - Takes a boolean - argument. If and - the unit stops without being requested - by the user, all units - depending on it will be stopped as - well. (e.g. if a service exits or - crashes on its own behalf, units using - it will be stopped) Note that normally - if a unit stops without a user request, - units depending on it will not be - terminated. Only if the user requested - shutdown of a unit, all units depending - on that unit will be shut down as well - and at the same time. Defaults to - . + unit enters the + 'failed' + state. @@ -461,20 +475,43 @@ - OnlyByDependency= + RefuseManualStart= + RefuseManualStop= Takes a boolean argument. If this unit can only be activated - indirectly. In this case explicit - start-up requested by the user is - denied, however if it is started as a + (resp. deactivated) indirectly. In + this case explicit start-up + (resp. termination) requested by the + user is denied, however if it is + started (resp. stopped) as a dependency of another unit, start-up - will succeed. This is mostly a safety - feature to ensure that the user does - not accidentally activate units that are - not intended to be activated - explicitly. This option defaults to + (resp. termination) will succeed. This + is mostly a safety feature to ensure + that the user does not accidentally + activate units that are not intended + to be activated explicitly, and not + accidentally deactivate units that are + not intended to be deactivated. + These options default to + . + + + + AllowIsolate= + + Takes a boolean + argument. If + this unit may be used with the + systemctl isolate + command. Otherwise this will be + refused. It probably is a good idea to + leave this disabled except for target + units that shall be used similar to + runlevels in SysV init systems, just + as a precaution to avoid unusable + system states. This option defaults to . @@ -506,20 +543,6 @@ ones. - - IgnoreDependencyFailure= - - Takes a boolean - argument. If and - a requirement dependency of this unit - fails to start up this unit will be - started nonetheless, ignoring that - failure. If - (the default) and a dependency unit - fails the unit will immediately fail - too and the job is removed. - - JobTimeoutSec= @@ -529,24 +552,82 @@ time. If this time limit is reached the job will be cancelled, the unit however will not change state or even - enter maintenance mode. This value - defaults to 0 (job timeouts disabled), - except for device units. NB: this - timeout is independent from any - unit-specific timeout (for example, - the timeout set with + enter the 'failed' + mode. This value defaults to 0 (job + timeouts disabled), except for device + units. NB: this timeout is independent + from any unit-specific timeout (for + example, the timeout set with Timeout= in service - units) as the job timeout has no effect - on the unit itself, only on the job - that might be pending for it. Or in - other words: unit-specific timeouts + units) as the job timeout has no + effect on the unit itself, only on the + job that might be pending for it. Or + in other words: unit-specific timeouts are useful to abort unit state changes, and revert them. The job timeout set with this option however - is useful to abort only the job waiting - for the unit state to change. + is useful to abort only the job + waiting for the unit state to + change. + + ConditionPathExists= + ConditionDirectoryNotEmpty= + ConditionKernelCommandLine= + ConditionNull= + + Before starting a unit + verify that the specified condition is + true. With + ConditionPathExists= + a file existance condition can be + checked before a unit is started. If + the specified absolute path name does + not exist startup of a unit will not + actually happen, however the unit is + still useful for ordering purposes in + this case. The condition is checked at + the time the queued start job is to be + executed. If the absolute path name + passed to + ConditionPathExists= + is prefixed with an exclamation mark + (!), the test is negated, and the unit + only started if the path does not + exist. ConditionDirectoryNotEmpty= + is similar to + ConditionPathExists= + but verifies whether a certain path is + exists and is a non-empty + directory. Similarly + ConditionKernelCommandLine= + may be used to check whether a + specific kernel command line option is + set (or if prefixed with the + exclamation mark unset). The argument + must either be a single word, or an + assignment (i.e. two words, separated + by the equality sign). In the former + case the kernel command line is + searched for the word appearing as is, + or as left hand side of an + assignment. In the latter case the + exact assignment is looked for with + right and left hand side + matching. Finally, + ConditionNull= may + be used to add a constant condition + check value to the unit. It takes a + boolean argument. If set to + false the condition + will always fail, otherwise + succeed. If multiple conditions are + specified the unit will be executed + if at least one of them applies + (i.e. a logical OR is + applied). + Unit file may include a [Install] section, which