]>
Commit | Line | Data |
---|---|---|
c129bd5d | 1 | <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> |
d1ab0ca0 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
798d3a52 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ |
1a13e31d ZJS |
4 | <!ENTITY % entities SYSTEM "custom-entities.ent" > |
5 | %entities; | |
6 | ]> | |
d1ab0ca0 LP |
7 | |
8 | <!-- | |
9 | This file is part of systemd. | |
10 | ||
11 | Copyright 2010 Lennart Poettering | |
12 | ||
13 | systemd is free software; you can redistribute it and/or modify it | |
5430f7f2 LP |
14 | under the terms of the GNU Lesser General Public License as published by |
15 | the Free Software Foundation; either version 2.1 of the License, or | |
d1ab0ca0 LP |
16 | (at your option) any later version. |
17 | ||
18 | systemd is distributed in the hope that it will be useful, but | |
19 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
5430f7f2 | 21 | Lesser General Public License for more details. |
d1ab0ca0 | 22 | |
5430f7f2 | 23 | You should have received a copy of the GNU Lesser General Public License |
d1ab0ca0 LP |
24 | along with systemd; If not, see <http://www.gnu.org/licenses/>. |
25 | --> | |
26 | ||
27 | <refentry id="systemd.unit"> | |
28 | ||
798d3a52 ZJS |
29 | <refentryinfo> |
30 | <title>systemd.unit</title> | |
31 | <productname>systemd</productname> | |
32 | ||
33 | <authorgroup> | |
34 | <author> | |
35 | <contrib>Developer</contrib> | |
36 | <firstname>Lennart</firstname> | |
37 | <surname>Poettering</surname> | |
38 | <email>lennart@poettering.net</email> | |
39 | </author> | |
40 | </authorgroup> | |
41 | </refentryinfo> | |
42 | ||
43 | <refmeta> | |
44 | <refentrytitle>systemd.unit</refentrytitle> | |
45 | <manvolnum>5</manvolnum> | |
46 | </refmeta> | |
47 | ||
48 | <refnamediv> | |
49 | <refname>systemd.unit</refname> | |
50 | <refpurpose>Unit configuration</refpurpose> | |
51 | </refnamediv> | |
52 | ||
53 | <refsynopsisdiv> | |
54 | <para><filename><replaceable>service</replaceable>.service</filename>, | |
55 | <filename><replaceable>socket</replaceable>.socket</filename>, | |
56 | <filename><replaceable>device</replaceable>.device</filename>, | |
57 | <filename><replaceable>mount</replaceable>.mount</filename>, | |
58 | <filename><replaceable>automount</replaceable>.automount</filename>, | |
59 | <filename><replaceable>swap</replaceable>.swap</filename>, | |
60 | <filename><replaceable>target</replaceable>.target</filename>, | |
61 | <filename><replaceable>path</replaceable>.path</filename>, | |
62 | <filename><replaceable>timer</replaceable>.timer</filename>, | |
798d3a52 ZJS |
63 | <filename><replaceable>slice</replaceable>.slice</filename>, |
64 | <filename><replaceable>scope</replaceable>.scope</filename></para> | |
65 | ||
12b42c76 | 66 | <para><literallayout><filename>/etc/systemd/system/*</filename> |
13219b7f | 67 | <filename>/run/systemd/system/*</filename> |
12b42c76 | 68 | <filename>/usr/lib/systemd/system/*</filename> |
f6e1bd2c | 69 | <filename>…</filename> |
798d3a52 | 70 | </literallayout></para> |
13219b7f | 71 | |
f6e1bd2c | 72 | <para><literallayout><filename>~/.config/systemd/user/*</filename> |
12b42c76 | 73 | <filename>/etc/systemd/user/*</filename> |
aa08982d | 74 | <filename>$XDG_RUNTIME_DIR/systemd/user/*</filename> |
13219b7f | 75 | <filename>/run/systemd/user/*</filename> |
f6e1bd2c | 76 | <filename>~/.local/share/systemd/user/*</filename> |
12b42c76 | 77 | <filename>/usr/lib/systemd/user/*</filename> |
f6e1bd2c | 78 | <filename>…</filename> |
798d3a52 ZJS |
79 | </literallayout></para> |
80 | </refsynopsisdiv> | |
81 | ||
82 | <refsect1> | |
83 | <title>Description</title> | |
84 | ||
85 | <para>A unit configuration file encodes information about a | |
86 | service, a socket, a device, a mount point, an automount point, a | |
87 | swap file or partition, a start-up target, a watched file system | |
88 | path, a timer controlled and supervised by | |
89 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
36b4a7ba | 90 | a resource management slice or |
798d3a52 ZJS |
91 | a group of externally created processes. The syntax is inspired by |
92 | <ulink | |
93 | url="http://standards.freedesktop.org/desktop-entry-spec/latest/">XDG | |
94 | Desktop Entry Specification</ulink> <filename>.desktop</filename> | |
95 | files, which are in turn inspired by Microsoft Windows | |
96 | <filename>.ini</filename> files.</para> | |
97 | ||
98 | <para>This man page lists the common configuration options of all | |
99 | the unit types. These options need to be configured in the [Unit] | |
100 | or [Install] sections of the unit files.</para> | |
101 | ||
102 | <para>In addition to the generic [Unit] and [Install] sections | |
103 | described here, each unit may have a type-specific section, e.g. | |
104 | [Service] for a service unit. See the respective man pages for | |
105 | more information: | |
106 | <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
107 | <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
108 | <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
109 | <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
110 | <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
111 | <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
112 | <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
113 | <citerefentry><refentrytitle>systemd.path</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
114 | <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
36b4a7ba | 115 | <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>, |
798d3a52 ZJS |
116 | <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>. |
117 | </para> | |
118 | ||
119 | <para>Various settings are allowed to be specified more than once, | |
120 | in which case the interpretation depends on the setting. Often, | |
121 | multiple settings form a list, and setting to an empty value | |
122 | "resets", which means that previous assignments are ignored. When | |
123 | this is allowed, it is mentioned in the description of the | |
124 | setting. Note that using multiple assignments to the same value | |
125 | makes the unit file incompatible with parsers for the XDG | |
126 | <filename>.desktop</filename> file format.</para> | |
127 | ||
128 | <para>Unit files are loaded from a set of paths determined during | |
129 | compilation, described in the next section.</para> | |
130 | ||
131 | <para>Unit files may contain additional options on top of those | |
132 | listed here. If systemd encounters an unknown option, it will | |
133 | write a warning log message but continue loading the unit. If an | |
134 | option or section name is prefixed with <option>X-</option>, it is | |
135 | ignored completely by systemd. Options within an ignored section | |
136 | do not need the prefix. Applications may use this to include | |
137 | additional information in the unit files.</para> | |
138 | ||
139 | <para>Boolean arguments used in unit files can be written in | |
140 | various formats. For positive settings the strings | |
141 | <option>1</option>, <option>yes</option>, <option>true</option> | |
142 | and <option>on</option> are equivalent. For negative settings, the | |
143 | strings <option>0</option>, <option>no</option>, | |
144 | <option>false</option> and <option>off</option> are | |
145 | equivalent.</para> | |
146 | ||
bac150e9 ZJS |
147 | <para>Time span values encoded in unit files can be written in various formats. A stand-alone |
148 | number specifies a time in seconds. If suffixed with a time unit, the unit is honored. A | |
149 | concatenation of multiple values with units is supported, in which case the values are added | |
150 | up. Example: <literal>50</literal> refers to 50 seconds; <literal>2min 200ms</literal> refers to | |
151 | 2 minutes and 200 milliseconds, i.e. 120200 ms. The following time units are understood: | |
152 | <literal>s</literal>, <literal>min</literal>, <literal>h</literal>, <literal>d</literal>, | |
d923e42e | 153 | <literal>w</literal>, <literal>ms</literal>, <literal>us</literal>. For details see |
798d3a52 ZJS |
154 | <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> |
155 | ||
bac150e9 ZJS |
156 | <para>Empty lines and lines starting with <literal>#</literal> or <literal>;</literal> are |
157 | ignored. This may be used for commenting. Lines ending in a backslash are concatenated with the | |
158 | following line while reading and the backslash is replaced by a space character. This may be | |
159 | used to wrap long lines.</para> | |
160 | ||
161 | <para>Units can be aliased (have an alternative name), by creating a symlink from the new name | |
162 | to the existing name in one of the unit search paths. For example, | |
163 | <filename>systemd-networkd.service</filename> has the alias | |
164 | <filename>dbus-org.freedesktop.network1.service</filename>, created during installation as the | |
165 | symlink <filename>/usr/lib/systemd/system/dbus-org.freedesktop.network1.service</filename>. In | |
166 | addition, unit files may specify aliases through the <varname>Alias=</varname> directive in the | |
167 | [Install] section; those aliases are only effective when the unit is enabled. When the unit is | |
168 | enabled, symlinks will be created for those names, and removed when the unit is disabled. For | |
169 | example, <filename>reboot.target</filename> specifies | |
170 | <varname>Alias=ctrl-alt-del.target</varname>, so when enabled it will be invoked whenever | |
171 | CTRL+ALT+DEL is pressed. Alias names may be used in commands like <command>enable</command>, | |
172 | <command>disable</command>, <command>start</command>, <command>stop</command>, | |
173 | <command>status</command>, …, and in unit dependency directives <varname>Wants=</varname>, | |
174 | <varname>Requires=</varname>, <varname>Before=</varname>, <varname>After=</varname>, …, with the | |
175 | limitation that aliases specified through <varname>Alias=</varname> are only effective when the | |
176 | unit is enabled. Aliases cannot be used with the <command>preset</command> command.</para> | |
177 | ||
178 | <para>Along with a unit file <filename>foo.service</filename>, the directory | |
179 | <filename>foo.service.wants/</filename> may exist. All unit files symlinked from such a | |
180 | directory are implicitly added as dependencies of type <varname>Wants=</varname> to the unit. | |
181 | This is useful to hook units into the start-up of other units, without having to modify their | |
182 | unit files. For details about the semantics of <varname>Wants=</varname>, see below. The | |
183 | preferred way to create symlinks in the <filename>.wants/</filename> directory of a unit file is | |
184 | with the <command>enable</command> command of the | |
798d3a52 | 185 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> |
bac150e9 ZJS |
186 | tool which reads information from the [Install] section of unit files (see below). A similar |
187 | functionality exists for <varname>Requires=</varname> type dependencies as well, the directory | |
188 | suffix is <filename>.requires/</filename> in this case.</para> | |
798d3a52 | 189 | |
be73bb48 | 190 | <para>Along with a unit file <filename>foo.service</filename>, a "drop-in" directory |
bac150e9 ZJS |
191 | <filename>foo.service.d/</filename> may exist. All files with the suffix |
192 | <literal>.conf</literal> from this directory will be parsed after the file itself is | |
193 | parsed. This is useful to alter or add configuration settings for a unit, without having to | |
194 | modify unit files. Each drop-in file must have appropriate section headers. Note that for | |
195 | instantiated units, this logic will first look for the instance <literal>.d/</literal> | |
196 | subdirectory and read its <literal>.conf</literal> files, followed by the template | |
197 | <literal>.d/</literal> subdirectory and the <literal>.conf</literal> files there. Also note that | |
2dd67817 | 198 | settings from the <literal>[Install]</literal> section are not honored in drop-in unit files, |
bac150e9 ZJS |
199 | and have no effect.</para> |
200 | ||
201 | <para>In addition to <filename>/etc/systemd/system</filename>, the drop-in <literal>.d</literal> | |
202 | directories for system services can be placed in <filename>/usr/lib/systemd/system</filename> or | |
203 | <filename>/run/systemd/system</filename> directories. Drop-in files in <filename>/etc</filename> | |
204 | take precedence over those in <filename>/run</filename> which in turn take precedence over those | |
205 | in <filename>/usr/lib</filename>. Drop-in files under any of these directories take precedence | |
8331eaab LW |
206 | over unit files wherever located. Multiple drop-in files with different names are applied in |
207 | lexicographic order, regardless of which of the directories they reside in.</para> | |
bac150e9 ZJS |
208 | |
209 | <!-- Note that we do not document .include here, as we consider it mostly obsolete, and want | |
210 | people to use .d/ drop-ins instead. --> | |
798d3a52 | 211 | |
bbe0b4a8 JL |
212 | <para>Note that while systemd offers a flexible dependency system |
213 | between units it is recommended to use this functionality only | |
214 | sparingly and instead rely on techniques such as bus-based or | |
215 | socket-based activation which make dependencies implicit, | |
216 | resulting in a both simpler and more flexible system.</para> | |
217 | ||
798d3a52 ZJS |
218 | <para>Some unit names reflect paths existing in the file system |
219 | namespace. Example: a device unit | |
220 | <filename>dev-sda.device</filename> refers to a device with the | |
221 | device node <filename noindex='true'>/dev/sda</filename> in the | |
222 | file system namespace. If this applies, a special way to escape | |
223 | the path name is used, so that the result is usable as part of a | |
b938cb90 | 224 | filename. Basically, given a path, "/" is replaced by "-", and all |
798d3a52 ZJS |
225 | other characters which are not ASCII alphanumerics are replaced by |
226 | C-style "\x2d" escapes (except that "_" is never replaced and "." | |
227 | is only replaced when it would be the first character in the | |
228 | escaped path). The root directory "/" is encoded as single dash, | |
229 | while otherwise the initial and ending "/" are removed from all | |
230 | paths during transformation. This escaping is reversible. Properly | |
231 | escaped paths can be generated using the | |
232 | <citerefentry><refentrytitle>systemd-escape</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
233 | command.</para> | |
234 | ||
235 | <para>Optionally, units may be instantiated from a | |
236 | template file at runtime. This allows creation of | |
237 | multiple units from a single configuration file. If | |
238 | systemd looks for a unit configuration file, it will | |
239 | first search for the literal unit name in the | |
240 | file system. If that yields no success and the unit | |
241 | name contains an <literal>@</literal> character, systemd will look for a | |
242 | unit template that shares the same name but with the | |
243 | instance string (i.e. the part between the <literal>@</literal> character | |
244 | and the suffix) removed. Example: if a service | |
245 | <filename>getty@tty3.service</filename> is requested | |
246 | and no file by that name is found, systemd will look | |
247 | for <filename>getty@.service</filename> and | |
248 | instantiate a service from that configuration file if | |
249 | it is found.</para> | |
250 | ||
251 | <para>To refer to the instance string from within the | |
252 | configuration file you may use the special <literal>%i</literal> | |
253 | specifier in many of the configuration options. See below for | |
254 | details.</para> | |
255 | ||
256 | <para>If a unit file is empty (i.e. has the file size 0) or is | |
257 | symlinked to <filename>/dev/null</filename>, its configuration | |
258 | will not be loaded and it appears with a load state of | |
259 | <literal>masked</literal>, and cannot be activated. Use this as an | |
260 | effective way to fully disable a unit, making it impossible to | |
261 | start it even manually.</para> | |
262 | ||
263 | <para>The unit file format is covered by the | |
264 | <ulink | |
28a0ad81 | 265 | url="https://www.freedesktop.org/wiki/Software/systemd/InterfaceStabilityPromise">Interface |
798d3a52 ZJS |
266 | Stability Promise</ulink>.</para> |
267 | ||
268 | </refsect1> | |
269 | ||
c129bd5d | 270 | <refsect1> |
45f09f93 JL |
271 | <title>Implicit Dependencies</title> |
272 | ||
273 | <para>A number of unit dependencies are implicitly established, | |
274 | depending on unit type and unit configuration. These implicit | |
275 | dependencies can make unit configuration file cleaner. For the | |
276 | implicit dependencies in each unit type, please refer to | |
277 | section "Implicit Dependencies" in respective man pages.</para> | |
278 | ||
279 | <para>For example, service units with <varname>Type=dbus</varname> | |
280 | automatically acquire dependencies of type <varname>Requires=</varname> | |
281 | and <varname>After=</varname> on <filename>dbus.socket</filename>. See | |
282 | <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
c129bd5d LP |
283 | for details.</para> |
284 | </refsect1> | |
285 | ||
45f09f93 JL |
286 | <refsect1> |
287 | <title>Default Dependencies</title> | |
288 | ||
289 | <para>Default dependencies are similar to implicit dependencies, | |
290 | but can be turned on and off by setting | |
291 | <varname>DefaultDependencies=</varname> to <varname>yes</varname> | |
292 | (the default) and <varname>no</varname>, while implicit dependencies | |
293 | are always in effect. See section "Default Dependencies" in respective | |
294 | man pages for the effect of enabling | |
295 | <varname>DefaultDependencies=</varname> in each unit types.</para> | |
296 | ||
297 | <para>For example, target units will complement all configured | |
298 | dependencies of type type <varname>Wants=</varname> or | |
299 | <varname>Requires=</varname> with dependencies of type | |
300 | <varname>After=</varname>. See | |
301 | <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
302 | for details. Note that this behavior can be turned off by setting | |
303 | <varname>DefaultDependencies=no</varname>.</para> | |
304 | </refsect1> | |
305 | ||
798d3a52 | 306 | <refsect1> |
f757855e | 307 | <title>Unit File Load Path</title> |
798d3a52 ZJS |
308 | |
309 | <para>Unit files are loaded from a set of paths determined during | |
310 | compilation, described in the two tables below. Unit files found | |
311 | in directories listed earlier override files with the same name in | |
312 | directories lower in the list.</para> | |
313 | ||
aa3e4400 EV |
314 | <para>When the variable <varname>$SYSTEMD_UNIT_PATH</varname> is set, |
315 | the contents of this variable overrides the unit load path. If | |
798d3a52 ZJS |
316 | <varname>$SYSTEMD_UNIT_PATH</varname> ends with an empty component |
317 | (<literal>:</literal>), the usual unit load path will be appended | |
318 | to the contents of the variable.</para> | |
319 | ||
320 | <table> | |
321 | <title> | |
322 | Load path when running in system mode (<option>--system</option>). | |
323 | </title> | |
324 | ||
325 | <tgroup cols='2'> | |
326 | <colspec colname='path' /> | |
327 | <colspec colname='expl' /> | |
328 | <thead> | |
329 | <row> | |
330 | <entry>Path</entry> | |
331 | <entry>Description</entry> | |
332 | </row> | |
333 | </thead> | |
334 | <tbody> | |
335 | <row> | |
12b42c76 | 336 | <entry><filename>/etc/systemd/system</filename></entry> |
798d3a52 ZJS |
337 | <entry>Local configuration</entry> |
338 | </row> | |
339 | <row> | |
340 | <entry><filename>/run/systemd/system</filename></entry> | |
341 | <entry>Runtime units</entry> | |
342 | </row> | |
343 | <row> | |
12b42c76 | 344 | <entry><filename>/usr/lib/systemd/system</filename></entry> |
798d3a52 ZJS |
345 | <entry>Units of installed packages</entry> |
346 | </row> | |
347 | </tbody> | |
348 | </tgroup> | |
349 | </table> | |
350 | ||
351 | <table> | |
352 | <title> | |
353 | Load path when running in user mode (<option>--user</option>). | |
354 | </title> | |
355 | ||
356 | <tgroup cols='2'> | |
357 | <colspec colname='path' /> | |
358 | <colspec colname='expl' /> | |
359 | <thead> | |
360 | <row> | |
361 | <entry>Path</entry> | |
362 | <entry>Description</entry> | |
363 | </row> | |
364 | </thead> | |
365 | <tbody> | |
366 | <row> | |
367 | <entry><filename>$XDG_CONFIG_HOME/systemd/user</filename></entry> | |
368 | <entry>User configuration (only used when $XDG_CONFIG_HOME is set)</entry> | |
369 | </row> | |
370 | <row> | |
371 | <entry><filename>$HOME/.config/systemd/user</filename></entry> | |
372 | <entry>User configuration (only used when $XDG_CONFIG_HOME is not set)</entry> | |
373 | </row> | |
374 | <row> | |
12b42c76 | 375 | <entry><filename>/etc/systemd/user</filename></entry> |
798d3a52 ZJS |
376 | <entry>Local configuration</entry> |
377 | </row> | |
378 | <row> | |
379 | <entry><filename>$XDG_RUNTIME_DIR/systemd/user</filename></entry> | |
380 | <entry>Runtime units (only used when $XDG_RUNTIME_DIR is set)</entry> | |
381 | </row> | |
382 | <row> | |
383 | <entry><filename>/run/systemd/user</filename></entry> | |
384 | <entry>Runtime units</entry> | |
385 | </row> | |
386 | <row> | |
387 | <entry><filename>$XDG_DATA_HOME/systemd/user</filename></entry> | |
388 | <entry>Units of packages that have been installed in the home directory (only used when $XDG_DATA_HOME is set)</entry> | |
389 | </row> | |
390 | <row> | |
391 | <entry><filename>$HOME/.local/share/systemd/user</filename></entry> | |
392 | <entry>Units of packages that have been installed in the home directory (only used when $XDG_DATA_HOME is not set)</entry> | |
393 | </row> | |
394 | <row> | |
12b42c76 | 395 | <entry><filename>/usr/lib/systemd/user</filename></entry> |
798d3a52 ZJS |
396 | <entry>Units of packages that have been installed system-wide</entry> |
397 | </row> | |
398 | </tbody> | |
399 | </tgroup> | |
400 | </table> | |
401 | ||
402 | <para>Additional units might be loaded into systemd ("linked") | |
403 | from directories not on the unit load path. See the | |
404 | <command>link</command> command for | |
405 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. | |
b1c1a519 ZC |
406 | Also, some units are dynamically created via a |
407 | <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>. | |
798d3a52 ZJS |
408 | </para> |
409 | </refsect1> | |
410 | ||
411 | <refsect1> | |
412 | <title>[Unit] Section Options</title> | |
413 | ||
a8eaaee7 | 414 | <para>The unit file may include a [Unit] section, which carries |
798d3a52 ZJS |
415 | generic information about the unit that is not dependent on the |
416 | type of unit:</para> | |
417 | ||
418 | <variablelist class='unit-directives'> | |
419 | ||
420 | <varlistentry> | |
421 | <term><varname>Description=</varname></term> | |
422 | <listitem><para>A free-form string describing the unit. This | |
423 | is intended for use in UIs to show descriptive information | |
424 | along with the unit name. The description should contain a | |
425 | name that means something to the end user. <literal>Apache2 | |
426 | Web Server</literal> is a good example. Bad examples are | |
427 | <literal>high-performance light-weight HTTP server</literal> | |
428 | (too generic) or <literal>Apache2</literal> (too specific and | |
429 | meaningless for people who do not know | |
430 | Apache).</para></listitem> | |
431 | </varlistentry> | |
432 | ||
433 | <varlistentry> | |
434 | <term><varname>Documentation=</varname></term> | |
435 | <listitem><para>A space-separated list of URIs referencing | |
436 | documentation for this unit or its configuration. Accepted are | |
437 | only URIs of the types <literal>http://</literal>, | |
438 | <literal>https://</literal>, <literal>file:</literal>, | |
439 | <literal>info:</literal>, <literal>man:</literal>. For more | |
440 | information about the syntax of these URIs, see <citerefentry | |
441 | project='man-pages'><refentrytitle>uri</refentrytitle><manvolnum>7</manvolnum></citerefentry>. | |
442 | The URIs should be listed in order of relevance, starting with | |
443 | the most relevant. It is a good idea to first reference | |
444 | documentation that explains what the unit's purpose is, | |
445 | followed by how it is configured, followed by any other | |
446 | related documentation. This option may be specified more than | |
447 | once, in which case the specified list of URIs is merged. If | |
448 | the empty string is assigned to this option, the list is reset | |
449 | and all prior assignments will have no | |
450 | effect.</para></listitem> | |
451 | </varlistentry> | |
452 | ||
453 | <varlistentry> | |
454 | <term><varname>Requires=</varname></term> | |
455 | ||
62d3ca24 LP |
456 | <listitem><para>Configures requirement dependencies on other units. If this unit gets activated, the units |
457 | listed here will be activated as well. If one of the other units gets deactivated or its activation fails, this | |
458 | unit will be deactivated. This option may be specified more than once or multiple space-separated units may be | |
459 | specified in one option in which case requirement dependencies for all listed names will be created. Note that | |
460 | requirement dependencies do not influence the order in which services are started or stopped. This has to be | |
461 | configured independently with the <varname>After=</varname> or <varname>Before=</varname> options. If a unit | |
462 | <filename>foo.service</filename> requires a unit <filename>bar.service</filename> as configured with | |
463 | <varname>Requires=</varname> and no ordering is configured with <varname>After=</varname> or | |
464 | <varname>Before=</varname>, then both units will be started simultaneously and without any delay between them | |
465 | if <filename>foo.service</filename> is activated. Often, it is a better choice to use <varname>Wants=</varname> | |
466 | instead of <varname>Requires=</varname> in order to achieve a system that is more robust when dealing with | |
467 | failing services.</para> | |
468 | ||
469 | <para>Note that this dependency type does not imply that the other unit always has to be in active state when | |
470 | this unit is running. Specifically: failing condition checks (such as <varname>ConditionPathExists=</varname>, | |
471 | <varname>ConditionPathExists=</varname>, … — see below) do not cause the start job of a unit with a | |
472 | <varname>Requires=</varname> dependency on it to fail. Also, some unit types may deactivate on their own (for | |
473 | example, a service process may decide to exit cleanly, or a device may be unplugged by the user), which is not | |
474 | propagated to units having a <varname>Requires=</varname> dependency. Use the <varname>BindsTo=</varname> | |
475 | dependency type together with <varname>After=</varname> to ensure that a unit may never be in active state | |
476 | without a specific other unit also in active state (see below).</para> | |
477 | ||
478 | <para>Note that dependencies of this type may also be configured outside of the unit configuration file by | |
479 | adding a symlink to a <filename>.requires/</filename> directory accompanying the unit file. For details, see | |
798d3a52 ZJS |
480 | above.</para></listitem> |
481 | </varlistentry> | |
482 | ||
798d3a52 ZJS |
483 | <varlistentry> |
484 | <term><varname>Requisite=</varname></term> | |
798d3a52 | 485 | |
f32b43bd | 486 | <listitem><para>Similar to <varname>Requires=</varname>. |
798d3a52 ZJS |
487 | However, if the units listed here are not started already, |
488 | they will not be started and the transaction will fail | |
489 | immediately. </para></listitem> | |
490 | </varlistentry> | |
491 | ||
492 | <varlistentry> | |
493 | <term><varname>Wants=</varname></term> | |
494 | ||
495 | <listitem><para>A weaker version of | |
496 | <varname>Requires=</varname>. Units listed in this option will | |
497 | be started if the configuring unit is. However, if the listed | |
498 | units fail to start or cannot be added to the transaction, | |
499 | this has no impact on the validity of the transaction as a | |
500 | whole. This is the recommended way to hook start-up of one | |
501 | unit to the start-up of another unit.</para> | |
502 | ||
503 | <para>Note that dependencies of this type may also be | |
504 | configured outside of the unit configuration file by adding | |
505 | symlinks to a <filename>.wants/</filename> directory | |
506 | accompanying the unit file. For details, see | |
507 | above.</para></listitem> | |
508 | </varlistentry> | |
509 | ||
510 | <varlistentry> | |
511 | <term><varname>BindsTo=</varname></term> | |
512 | ||
62d3ca24 LP |
513 | <listitem><para>Configures requirement dependencies, very similar in style to |
514 | <varname>Requires=</varname>. However, this dependency type is stronger: in addition to the effect of | |
515 | <varname>Requires=</varname> it declares that if the unit bound to is stopped, this unit will be stopped | |
516 | too. This means a unit bound to another unit that suddenly enters inactive state will be stopped too. | |
517 | Units can suddenly, unexpectedly enter inactive state for different reasons: the main process of a service unit | |
518 | might terminate on its own choice, the backing device of a device unit might be unplugged or the mount point of | |
519 | a mount unit might be unmounted without involvement of the system and service manager.</para> | |
520 | ||
521 | <para>When used in conjunction with <varname>After=</varname> on the same unit the behaviour of | |
522 | <varname>BindsTo=</varname> is even stronger. In this case, the unit bound to strictly has to be in active | |
523 | state for this unit to also be in active state. This not only means a unit bound to another unit that suddenly | |
524 | enters inactive state, but also one that is bound to another unit that gets skipped due to a failed condition | |
525 | check (such as <varname>ConditionPathExists=</varname>, <varname>ConditionPathIsSymbolicLink=</varname>, … — | |
526 | see below) will be stopped, should it be running. Hence, in many cases it is best to combine | |
527 | <varname>BindsTo=</varname> with <varname>After=</varname>.</para></listitem> | |
798d3a52 ZJS |
528 | </varlistentry> |
529 | ||
530 | <varlistentry> | |
531 | <term><varname>PartOf=</varname></term> | |
532 | ||
533 | <listitem><para>Configures dependencies similar to | |
534 | <varname>Requires=</varname>, but limited to stopping and | |
535 | restarting of units. When systemd stops or restarts the units | |
536 | listed here, the action is propagated to this unit. Note that | |
537 | this is a one-way dependency — changes to this unit do not | |
538 | affect the listed units. </para></listitem> | |
539 | </varlistentry> | |
540 | ||
541 | <varlistentry> | |
542 | <term><varname>Conflicts=</varname></term> | |
543 | ||
544 | <listitem><para>A space-separated list of unit names. | |
545 | Configures negative requirement dependencies. If a unit has a | |
546 | <varname>Conflicts=</varname> setting on another unit, | |
547 | starting the former will stop the latter and vice versa. Note | |
548 | that this setting is independent of and orthogonal to the | |
549 | <varname>After=</varname> and <varname>Before=</varname> | |
550 | ordering dependencies.</para> | |
551 | ||
552 | <para>If a unit A that conflicts with a unit B is scheduled to | |
553 | be started at the same time as B, the transaction will either | |
554 | fail (in case both are required part of the transaction) or be | |
555 | modified to be fixed (in case one or both jobs are not a | |
556 | required part of the transaction). In the latter case, the job | |
557 | that is not the required will be removed, or in case both are | |
558 | not required, the unit that conflicts will be started and the | |
559 | unit that is conflicted is stopped.</para></listitem> | |
560 | </varlistentry> | |
561 | ||
562 | <varlistentry> | |
563 | <term><varname>Before=</varname></term> | |
564 | <term><varname>After=</varname></term> | |
565 | ||
2eb6ff5e LP |
566 | <listitem><para>These two settings expect a space-separated list of unit names. They configure ordering |
567 | dependencies between units. If a unit <filename>foo.service</filename> contains a setting | |
568 | <option>Before=bar.service</option> and both units are being started, <filename>bar.service</filename>'s | |
569 | start-up is delayed until <filename>foo.service</filename> has finished starting up. Note that this setting is | |
570 | independent of and orthogonal to the requirement dependencies as configured by <varname>Requires=</varname>, | |
571 | <varname>Wants=</varname> or <varname>BindsTo=</varname>. It is a common pattern to include a unit name in both | |
572 | the <varname>After=</varname> and <varname>Requires=</varname> options, in which case the unit listed will be | |
573 | started before the unit that is configured with these options. This option may be specified more than once, in | |
574 | which case ordering dependencies for all listed names are created. <varname>After=</varname> is the inverse of | |
575 | <varname>Before=</varname>, i.e. while <varname>After=</varname> ensures that the configured unit is started | |
576 | after the listed unit finished starting up, <varname>Before=</varname> ensures the opposite, that the | |
577 | configured unit is fully started up before the listed unit is started. Note that when two units with an | |
578 | ordering dependency between them are shut down, the inverse of the start-up order is applied. i.e. if a unit is | |
579 | configured with <varname>After=</varname> on another unit, the former is stopped before the latter if both are | |
580 | shut down. Given two units with any ordering dependency between them, if one unit is shut down and the other is | |
581 | started up, the shutdown is ordered before the start-up. It doesn't matter if the ordering dependency is | |
582 | <varname>After=</varname> or <varname>Before=</varname>, in this case. It also doesn't matter which of the two | |
583 | is shut down, as long as one is shut down and the other is started up. The shutdown is ordered before the | |
584 | start-up in all cases. If two units have no ordering dependencies between them, they are shut down or started | |
585 | up simultaneously, and no ordering takes place. It depends on the unit type when precisely a unit has finished | |
586 | starting up. Most importantly, for service units start-up is considered completed for the purpose of | |
587 | <varname>Before=</varname>/<varname>After=</varname> when all its configured start-up commands have been | |
588 | invoked and they either failed or reported start-up success.</para></listitem> | |
798d3a52 ZJS |
589 | </varlistentry> |
590 | ||
591 | <varlistentry> | |
592 | <term><varname>OnFailure=</varname></term> | |
593 | ||
594 | <listitem><para>A space-separated list of one or more units | |
595 | that are activated when this unit enters the | |
596 | <literal>failed</literal> state.</para></listitem> | |
597 | </varlistentry> | |
598 | ||
599 | <varlistentry> | |
600 | <term><varname>PropagatesReloadTo=</varname></term> | |
601 | <term><varname>ReloadPropagatedFrom=</varname></term> | |
602 | ||
603 | <listitem><para>A space-separated list of one or more units | |
604 | where reload requests on this unit will be propagated to, or | |
605 | reload requests on the other unit will be propagated to this | |
606 | unit, respectively. Issuing a reload request on a unit will | |
607 | automatically also enqueue a reload request on all units that | |
608 | the reload request shall be propagated to via these two | |
609 | settings.</para></listitem> | |
610 | </varlistentry> | |
611 | ||
612 | <varlistentry> | |
613 | <term><varname>JoinsNamespaceOf=</varname></term> | |
614 | ||
615 | <listitem><para>For units that start processes (such as | |
616 | service units), lists one or more other units whose network | |
617 | and/or temporary file namespace to join. This only applies to | |
618 | unit types which support the | |
619 | <varname>PrivateNetwork=</varname> and | |
620 | <varname>PrivateTmp=</varname> directives (see | |
621 | <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
622 | for details). If a unit that has this setting set is started, | |
623 | its processes will see the same <filename>/tmp</filename>, | |
80f524a4 | 624 | <filename>/var/tmp</filename> and network namespace as one |
798d3a52 ZJS |
625 | listed unit that is started. If multiple listed units are |
626 | already started, it is not defined which namespace is joined. | |
627 | Note that this setting only has an effect if | |
628 | <varname>PrivateNetwork=</varname> and/or | |
629 | <varname>PrivateTmp=</varname> is enabled for both the unit | |
630 | that joins the namespace and the unit whose namespace is | |
631 | joined.</para></listitem> | |
632 | </varlistentry> | |
633 | ||
634 | <varlistentry> | |
635 | <term><varname>RequiresMountsFor=</varname></term> | |
636 | ||
637 | <listitem><para>Takes a space-separated list of absolute | |
638 | paths. Automatically adds dependencies of type | |
639 | <varname>Requires=</varname> and <varname>After=</varname> for | |
640 | all mount units required to access the specified path.</para> | |
641 | ||
642 | <para>Mount points marked with <option>noauto</option> are not | |
88e328fd ZJS |
643 | mounted automatically through <filename>local-fs.target</filename>, |
644 | but are still honored for the purposes of this option, i.e. they | |
645 | will be pulled in by this unit.</para></listitem> | |
798d3a52 ZJS |
646 | </varlistentry> |
647 | ||
648 | <varlistentry> | |
649 | <term><varname>OnFailureJobMode=</varname></term> | |
650 | ||
651 | <listitem><para>Takes a value of | |
652 | <literal>fail</literal>, | |
653 | <literal>replace</literal>, | |
654 | <literal>replace-irreversibly</literal>, | |
655 | <literal>isolate</literal>, | |
656 | <literal>flush</literal>, | |
657 | <literal>ignore-dependencies</literal> or | |
658 | <literal>ignore-requirements</literal>. Defaults to | |
659 | <literal>replace</literal>. Specifies how the units listed in | |
660 | <varname>OnFailure=</varname> will be enqueued. See | |
661 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s | |
662 | <option>--job-mode=</option> option for details on the | |
663 | possible values. If this is set to <literal>isolate</literal>, | |
664 | only a single unit may be listed in | |
665 | <varname>OnFailure=</varname>..</para></listitem> | |
666 | </varlistentry> | |
667 | ||
668 | <varlistentry> | |
669 | <term><varname>IgnoreOnIsolate=</varname></term> | |
670 | ||
26adf774 ZJS |
671 | <listitem><para>Takes a boolean argument. If <option>true</option>, this unit |
672 | will not be stopped when isolating another unit. Defaults to | |
673 | <option>false</option> for service, target, socket, busname, timer, and path | |
674 | units, and <option>true</option> for slice, scope, device, swap, mount, and | |
675 | automount units.</para></listitem> | |
798d3a52 ZJS |
676 | </varlistentry> |
677 | ||
798d3a52 ZJS |
678 | <varlistentry> |
679 | <term><varname>StopWhenUnneeded=</varname></term> | |
680 | ||
681 | <listitem><para>Takes a boolean argument. If | |
682 | <option>true</option>, this unit will be stopped when it is no | |
b938cb90 | 683 | longer used. Note that, in order to minimize the work to be |
798d3a52 ZJS |
684 | executed, systemd will not stop units by default unless they |
685 | are conflicting with other units, or the user explicitly | |
686 | requested their shut down. If this option is set, a unit will | |
687 | be automatically cleaned up if no other active unit requires | |
688 | it. Defaults to <option>false</option>.</para></listitem> | |
689 | </varlistentry> | |
690 | ||
691 | <varlistentry> | |
692 | <term><varname>RefuseManualStart=</varname></term> | |
693 | <term><varname>RefuseManualStop=</varname></term> | |
694 | ||
695 | <listitem><para>Takes a boolean argument. If | |
696 | <option>true</option>, this unit can only be activated or | |
697 | deactivated indirectly. In this case, explicit start-up or | |
698 | termination requested by the user is denied, however if it is | |
699 | started or stopped as a dependency of another unit, start-up | |
700 | or termination will succeed. This is mostly a safety feature | |
701 | to ensure that the user does not accidentally activate units | |
702 | that are not intended to be activated explicitly, and not | |
703 | accidentally deactivate units that are not intended to be | |
704 | deactivated. These options default to | |
705 | <option>false</option>.</para></listitem> | |
706 | </varlistentry> | |
707 | ||
708 | <varlistentry> | |
709 | <term><varname>AllowIsolate=</varname></term> | |
710 | ||
711 | <listitem><para>Takes a boolean argument. If | |
712 | <option>true</option>, this unit may be used with the | |
713 | <command>systemctl isolate</command> command. Otherwise, this | |
714 | will be refused. It probably is a good idea to leave this | |
715 | disabled except for target units that shall be used similar to | |
716 | runlevels in SysV init systems, just as a precaution to avoid | |
717 | unusable system states. This option defaults to | |
718 | <option>false</option>.</para></listitem> | |
719 | </varlistentry> | |
720 | ||
721 | <varlistentry> | |
722 | <term><varname>DefaultDependencies=</varname></term> | |
723 | ||
724 | <listitem><para>Takes a boolean argument. If | |
725 | <option>true</option>, (the default), a few default | |
726 | dependencies will implicitly be created for the unit. The | |
727 | actual dependencies created depend on the unit type. For | |
728 | example, for service units, these dependencies ensure that the | |
729 | service is started only after basic system initialization is | |
730 | completed and is properly terminated on system shutdown. See | |
731 | the respective man pages for details. Generally, only services | |
732 | involved with early boot or late shutdown should set this | |
733 | option to <option>false</option>. It is highly recommended to | |
734 | leave this option enabled for the majority of common units. If | |
735 | set to <option>false</option>, this option does not disable | |
736 | all implicit dependencies, just non-essential | |
737 | ones.</para></listitem> | |
738 | </varlistentry> | |
739 | ||
740 | <varlistentry> | |
741 | <term><varname>JobTimeoutSec=</varname></term> | |
a2df3ea4 | 742 | <term><varname>JobRunningTimeoutSec=</varname></term> |
798d3a52 ZJS |
743 | <term><varname>JobTimeoutAction=</varname></term> |
744 | <term><varname>JobTimeoutRebootArgument=</varname></term> | |
745 | ||
a2df3ea4 MK |
746 | <listitem><para>When a job for this unit is queued, a time-out <varname>JobTimeoutSec=</varname> may be |
747 | configured. Similarly, <varname>JobRunningTimeoutSec=</varname> starts counting when the queued job is actually | |
748 | started. If either time limit is reached, the job will be cancelled, the unit however will not change state or | |
749 | even enter the <literal>failed</literal> mode. This value defaults to <literal>infinity</literal> (job timeouts | |
750 | disabled), except for device units (<varname>JobRunningTimeoutSec=</varname> defaults to | |
751 | <varname>DefaultTimeoutStartSec=</varname>). NB: this timeout is independent from any unit-specific timeout | |
752 | (for example, the timeout set with <varname>TimeoutStartSec=</varname> in service units) as the job timeout has | |
753 | no effect on the unit itself, only on the job that might be pending for it. Or in other words: unit-specific | |
754 | timeouts are useful to abort unit state changes, and revert them. The job timeout set with this option however | |
755 | is useful to abort only the job waiting for the unit state to change.</para> | |
798d3a52 | 756 | |
0aabe747 AJ |
757 | <para><varname>JobTimeoutAction=</varname> optionally configures an additional action to take when the time-out |
758 | is hit. It takes the same values as <varname>StartLimitAction=</varname>. Defaults to <option>none</option>. | |
759 | <varname>JobTimeoutRebootArgument=</varname> configures an optional reboot string to pass to the | |
798d3a52 ZJS |
760 | <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry> |
761 | system call.</para></listitem> | |
762 | </varlistentry> | |
763 | ||
6bf0f408 | 764 | <varlistentry> |
f0367da7 | 765 | <term><varname>StartLimitIntervalSec=</varname></term> |
6bf0f408 LP |
766 | <term><varname>StartLimitBurst=</varname></term> |
767 | ||
768 | <listitem><para>Configure unit start rate limiting. By default, units which are started more than 5 times | |
769 | within 10 seconds are not permitted to start any more times until the 10 second interval ends. With these two | |
f0367da7 LP |
770 | options, this rate limiting may be modified. Use <varname>StartLimitIntervalSec=</varname> to configure the |
771 | checking interval (defaults to <varname>DefaultStartLimitIntervalSec=</varname> in manager configuration file, | |
772 | set to 0 to disable any kind of rate limiting). Use <varname>StartLimitBurst=</varname> to configure how many | |
6bf0f408 LP |
773 | starts per interval are allowed (defaults to <varname>DefaultStartLimitBurst=</varname> in manager |
774 | configuration file). These configuration options are particularly useful in conjunction with the service | |
775 | setting <varname>Restart=</varname> (see | |
776 | <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>); however, | |
777 | they apply to all kinds of starts (including manual), not just those triggered by the | |
778 | <varname>Restart=</varname> logic. Note that units which are configured for <varname>Restart=</varname> and | |
779 | which reach the start limit are not attempted to be restarted anymore; however, they may still be restarted | |
780 | manually at a later point, from which point on, the restart logic is again activated. Note that | |
781 | <command>systemctl reset-failed</command> will cause the restart rate counter for a service to be flushed, | |
782 | which is useful if the administrator wants to manually start a unit and the start limit interferes with | |
7629ec46 | 783 | that. Note that this rate-limiting is enforced after any unit condition checks are executed, and hence unit |
07299350 LP |
784 | activations with failing conditions are not counted by this rate limiting. Slice, target, device and scope |
785 | units do not enforce this setting, as they are unit types whose activation may either never fail, or may | |
786 | succeed only a single time.</para></listitem> | |
6bf0f408 LP |
787 | </varlistentry> |
788 | ||
789 | <varlistentry> | |
790 | <term><varname>StartLimitAction=</varname></term> | |
791 | ||
792 | <listitem><para>Configure the action to take if the rate limit configured with | |
f0367da7 | 793 | <varname>StartLimitIntervalSec=</varname> and <varname>StartLimitBurst=</varname> is hit. Takes one of |
6bf0f408 LP |
794 | <option>none</option>, <option>reboot</option>, <option>reboot-force</option>, |
795 | <option>reboot-immediate</option>, <option>poweroff</option>, <option>poweroff-force</option> or | |
796 | <option>poweroff-immediate</option>. If <option>none</option> is set, hitting the rate limit will trigger no | |
797 | action besides that the start will not be permitted. <option>reboot</option> causes a reboot following the | |
798 | normal shutdown procedure (i.e. equivalent to <command>systemctl reboot</command>). | |
799 | <option>reboot-force</option> causes a forced reboot which will terminate all processes forcibly but should | |
800 | cause no dirty file systems on reboot (i.e. equivalent to <command>systemctl reboot -f</command>) and | |
801 | <option>reboot-immediate</option> causes immediate execution of the | |
802 | <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call, which | |
803 | might result in data loss. Similarly, <option>poweroff</option>, <option>poweroff-force</option>, | |
804 | <option>poweroff-immediate</option> have the effect of powering down the system with similar | |
805 | semantics. Defaults to <option>none</option>.</para></listitem> | |
806 | </varlistentry> | |
807 | ||
808 | <varlistentry> | |
809 | <term><varname>RebootArgument=</varname></term> | |
810 | <listitem><para>Configure the optional argument for the | |
811 | <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call if | |
812 | <varname>StartLimitAction=</varname> or a service's <varname>FailureAction=</varname> is a reboot action. This | |
813 | works just like the optional argument to <command>systemctl reboot</command> command.</para></listitem> | |
814 | </varlistentry> | |
815 | ||
798d3a52 ZJS |
816 | <varlistentry> |
817 | <term><varname>ConditionArchitecture=</varname></term> | |
818 | <term><varname>ConditionVirtualization=</varname></term> | |
819 | <term><varname>ConditionHost=</varname></term> | |
820 | <term><varname>ConditionKernelCommandLine=</varname></term> | |
821 | <term><varname>ConditionSecurity=</varname></term> | |
822 | <term><varname>ConditionCapability=</varname></term> | |
823 | <term><varname>ConditionACPower=</varname></term> | |
824 | <term><varname>ConditionNeedsUpdate=</varname></term> | |
825 | <term><varname>ConditionFirstBoot=</varname></term> | |
826 | <term><varname>ConditionPathExists=</varname></term> | |
827 | <term><varname>ConditionPathExistsGlob=</varname></term> | |
828 | <term><varname>ConditionPathIsDirectory=</varname></term> | |
829 | <term><varname>ConditionPathIsSymbolicLink=</varname></term> | |
830 | <term><varname>ConditionPathIsMountPoint=</varname></term> | |
831 | <term><varname>ConditionPathIsReadWrite=</varname></term> | |
832 | <term><varname>ConditionDirectoryNotEmpty=</varname></term> | |
833 | <term><varname>ConditionFileNotEmpty=</varname></term> | |
834 | <term><varname>ConditionFileIsExecutable=</varname></term> | |
c465a29f FS |
835 | <term><varname>ConditionUser=</varname></term> |
836 | <term><varname>ConditionGroup=</varname></term> | |
798d3a52 | 837 | |
7ca41557 | 838 | <!-- We do not document ConditionNull= |
b938cb90 | 839 | here, as it is not particularly |
798d3a52 ZJS |
840 | useful and probably just |
841 | confusing. --> | |
842 | ||
41448597 LP |
843 | <listitem><para>Before starting a unit, verify that the specified condition is true. If it is not true, the |
844 | starting of the unit will be (mostly silently) skipped, however all ordering dependencies of it are still | |
845 | respected. A failing condition will not result in the unit being moved into a failure state. The condition is | |
846 | checked at the time the queued start job is to be executed. Use condition expressions in order to silently skip | |
847 | units that do not apply to the local running system, for example because the kernel or runtime environment | |
848 | doesn't require its functionality. Use the various <varname>AssertArchitecture=</varname>, | |
849 | <varname>AssertVirtualization=</varname>, … options for a similar mechanism that puts the unit in a failure | |
850 | state and logs about the failed check (see below).</para> | |
798d3a52 ZJS |
851 | |
852 | <para><varname>ConditionArchitecture=</varname> may be used to | |
853 | check whether the system is running on a specific | |
854 | architecture. Takes one of | |
855 | <varname>x86</varname>, | |
856 | <varname>x86-64</varname>, | |
857 | <varname>ppc</varname>, | |
858 | <varname>ppc-le</varname>, | |
859 | <varname>ppc64</varname>, | |
860 | <varname>ppc64-le</varname>, | |
861 | <varname>ia64</varname>, | |
862 | <varname>parisc</varname>, | |
863 | <varname>parisc64</varname>, | |
864 | <varname>s390</varname>, | |
865 | <varname>s390x</varname>, | |
866 | <varname>sparc</varname>, | |
867 | <varname>sparc64</varname>, | |
868 | <varname>mips</varname>, | |
869 | <varname>mips-le</varname>, | |
870 | <varname>mips64</varname>, | |
871 | <varname>mips64-le</varname>, | |
872 | <varname>alpha</varname>, | |
873 | <varname>arm</varname>, | |
874 | <varname>arm-be</varname>, | |
875 | <varname>arm64</varname>, | |
876 | <varname>arm64-be</varname>, | |
877 | <varname>sh</varname>, | |
878 | <varname>sh64</varname>, | |
215a2db4 | 879 | <varname>m68k</varname>, |
798d3a52 | 880 | <varname>tilegx</varname>, |
27b09f1f AB |
881 | <varname>cris</varname>, |
882 | <varname>arc</varname>, | |
883 | <varname>arc-be</varname> to test | |
798d3a52 ZJS |
884 | against a specific architecture. The architecture is |
885 | determined from the information returned by | |
3ba3a79d | 886 | <citerefentry project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry> |
798d3a52 ZJS |
887 | and is thus subject to |
888 | <citerefentry><refentrytitle>personality</refentrytitle><manvolnum>2</manvolnum></citerefentry>. | |
889 | Note that a <varname>Personality=</varname> setting in the | |
890 | same unit file has no effect on this condition. A special | |
891 | architecture name <varname>native</varname> is mapped to the | |
892 | architecture the system manager itself is compiled for. The | |
893 | test may be negated by prepending an exclamation mark.</para> | |
894 | ||
895 | <para><varname>ConditionVirtualization=</varname> may be used | |
896 | to check whether the system is executed in a virtualized | |
897 | environment and optionally test whether it is a specific | |
898 | implementation. Takes either boolean value to check if being | |
899 | executed in any virtualized environment, or one of | |
900 | <varname>vm</varname> and | |
901 | <varname>container</varname> to test against a generic type of | |
902 | virtualization solution, or one of | |
903 | <varname>qemu</varname>, | |
904 | <varname>kvm</varname>, | |
905 | <varname>zvm</varname>, | |
906 | <varname>vmware</varname>, | |
907 | <varname>microsoft</varname>, | |
908 | <varname>oracle</varname>, | |
909 | <varname>xen</varname>, | |
910 | <varname>bochs</varname>, | |
911 | <varname>uml</varname>, | |
912 | <varname>openvz</varname>, | |
913 | <varname>lxc</varname>, | |
914 | <varname>lxc-libvirt</varname>, | |
915 | <varname>systemd-nspawn</varname>, | |
9fb16425 ILG |
916 | <varname>docker</varname>, |
917 | <varname>rkt</varname> to test | |
299a34c1 ZJS |
918 | against a specific implementation, or |
919 | <varname>private-users</varname> to check whether we are running in a user namespace. See | |
798d3a52 ZJS |
920 | <citerefentry><refentrytitle>systemd-detect-virt</refentrytitle><manvolnum>1</manvolnum></citerefentry> |
921 | for a full list of known virtualization technologies and their | |
922 | identifiers. If multiple virtualization technologies are | |
923 | nested, only the innermost is considered. The test may be | |
924 | negated by prepending an exclamation mark.</para> | |
925 | ||
926 | <para><varname>ConditionHost=</varname> may be used to match | |
927 | against the hostname or machine ID of the host. This either | |
928 | takes a hostname string (optionally with shell style globs) | |
929 | which is tested against the locally set hostname as returned | |
930 | by | |
931 | <citerefentry><refentrytitle>gethostname</refentrytitle><manvolnum>2</manvolnum></citerefentry>, | |
932 | or a machine ID formatted as string (see | |
933 | <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>). | |
934 | The test may be negated by prepending an exclamation | |
935 | mark.</para> | |
936 | ||
937 | <para><varname>ConditionKernelCommandLine=</varname> may be | |
938 | used to check whether a specific kernel command line option is | |
939 | set (or if prefixed with the exclamation mark unset). The | |
940 | argument must either be a single word, or an assignment (i.e. | |
941 | two words, separated <literal>=</literal>). In the former case | |
942 | the kernel command line is searched for the word appearing as | |
943 | is, or as left hand side of an assignment. In the latter case, | |
944 | the exact assignment is looked for with right and left hand | |
945 | side matching.</para> | |
946 | ||
947 | <para><varname>ConditionSecurity=</varname> may be used to | |
948 | check whether the given security module is enabled on the | |
b8e1d4d1 | 949 | system. Currently, the recognized values are |
798d3a52 ZJS |
950 | <varname>selinux</varname>, |
951 | <varname>apparmor</varname>, | |
952 | <varname>ima</varname>, | |
953 | <varname>smack</varname> and | |
954 | <varname>audit</varname>. The test may be negated by | |
955 | prepending an exclamation mark.</para> | |
956 | ||
957 | <para><varname>ConditionCapability=</varname> may be used to | |
958 | check whether the given capability exists in the capability | |
959 | bounding set of the service manager (i.e. this does not check | |
960 | whether capability is actually available in the permitted or | |
961 | effective sets, see | |
962 | <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> | |
963 | for details). Pass a capability name such as | |
964 | <literal>CAP_MKNOD</literal>, possibly prefixed with an | |
965 | exclamation mark to negate the check.</para> | |
966 | ||
967 | <para><varname>ConditionACPower=</varname> may be used to | |
968 | check whether the system has AC power, or is exclusively | |
969 | battery powered at the time of activation of the unit. This | |
970 | takes a boolean argument. If set to <varname>true</varname>, | |
971 | the condition will hold only if at least one AC connector of | |
972 | the system is connected to a power source, or if no AC | |
973 | connectors are known. Conversely, if set to | |
974 | <varname>false</varname>, the condition will hold only if | |
975 | there is at least one AC connector known and all AC connectors | |
976 | are disconnected from a power source.</para> | |
977 | ||
978 | <para><varname>ConditionNeedsUpdate=</varname> takes one of | |
979 | <filename>/var</filename> or <filename>/etc</filename> as | |
980 | argument, possibly prefixed with a <literal>!</literal> (for | |
981 | inverting the condition). This condition may be used to | |
982 | conditionalize units on whether the specified directory | |
983 | requires an update because <filename>/usr</filename>'s | |
984 | modification time is newer than the stamp file | |
985 | <filename>.updated</filename> in the specified directory. This | |
986 | is useful to implement offline updates of the vendor operating | |
987 | system resources in <filename>/usr</filename> that require | |
988 | updating of <filename>/etc</filename> or | |
989 | <filename>/var</filename> on the next following boot. Units | |
990 | making use of this condition should order themselves before | |
991 | <citerefentry><refentrytitle>systemd-update-done.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
7f3fdb7f | 992 | to make sure they run before the stamp file's modification |
798d3a52 ZJS |
993 | time gets reset indicating a completed update.</para> |
994 | ||
23254af1 LP |
995 | <para><varname>ConditionFirstBoot=</varname> takes a boolean argument. This condition may be used to |
996 | conditionalize units on whether the system is booting up with an unpopulated <filename>/etc</filename> | |
997 | directory (specifically: an <filename>/etc</filename> with no <filename>/etc/machine-id</filename>). This may | |
998 | be used to populate <filename>/etc</filename> on the first boot after factory reset, or when a new system | |
999 | instance boots up for the first time.</para> | |
798d3a52 ZJS |
1000 | |
1001 | <para>With <varname>ConditionPathExists=</varname> a file | |
1002 | existence condition is checked before a unit is started. If | |
1003 | the specified absolute path name does not exist, the condition | |
1004 | will fail. If the absolute path name passed to | |
1005 | <varname>ConditionPathExists=</varname> is prefixed with an | |
1006 | exclamation mark (<literal>!</literal>), the test is negated, | |
1007 | and the unit is only started if the path does not | |
1008 | exist.</para> | |
1009 | ||
1010 | <para><varname>ConditionPathExistsGlob=</varname> is similar | |
1011 | to <varname>ConditionPathExists=</varname>, but checks for the | |
1012 | existence of at least one file or directory matching the | |
1013 | specified globbing pattern.</para> | |
1014 | ||
1015 | <para><varname>ConditionPathIsDirectory=</varname> is similar | |
1016 | to <varname>ConditionPathExists=</varname> but verifies | |
1017 | whether a certain path exists and is a directory.</para> | |
1018 | ||
1019 | <para><varname>ConditionPathIsSymbolicLink=</varname> is | |
1020 | similar to <varname>ConditionPathExists=</varname> but | |
1021 | verifies whether a certain path exists and is a symbolic | |
1022 | link.</para> | |
1023 | ||
1024 | <para><varname>ConditionPathIsMountPoint=</varname> is similar | |
1025 | to <varname>ConditionPathExists=</varname> but verifies | |
1026 | whether a certain path exists and is a mount point.</para> | |
1027 | ||
1028 | <para><varname>ConditionPathIsReadWrite=</varname> is similar | |
1029 | to <varname>ConditionPathExists=</varname> but verifies | |
1030 | whether the underlying file system is readable and writable | |
1031 | (i.e. not mounted read-only).</para> | |
1032 | ||
1033 | <para><varname>ConditionDirectoryNotEmpty=</varname> is | |
1034 | similar to <varname>ConditionPathExists=</varname> but | |
1035 | verifies whether a certain path exists and is a non-empty | |
1036 | directory.</para> | |
1037 | ||
1038 | <para><varname>ConditionFileNotEmpty=</varname> is similar to | |
1039 | <varname>ConditionPathExists=</varname> but verifies whether a | |
1040 | certain path exists and refers to a regular file with a | |
1041 | non-zero size.</para> | |
1042 | ||
1043 | <para><varname>ConditionFileIsExecutable=</varname> is similar | |
1044 | to <varname>ConditionPathExists=</varname> but verifies | |
1045 | whether a certain path exists, is a regular file and marked | |
1046 | executable.</para> | |
1047 | ||
c465a29f | 1048 | <para><varname>ConditionUser=</varname> takes a numeric |
534bab66 FS |
1049 | <literal>UID</literal>, a UNIX user name, or the special value |
1050 | <literal>@system</literal>. This condition may be used to check | |
1051 | whether the service manager is running as the given user. The | |
1052 | special value <literal>@system</literal> can be used to check | |
1053 | if the user id is within the system user range. This option is not | |
c465a29f FS |
1054 | useful for system services, as the system manager exclusively |
1055 | runs as the root user, and thus the test result is constant.</para> | |
1056 | ||
1057 | <para><varname>ConditionGroup=</varname> is similar | |
1058 | to <varname>ConditionUser=</varname> but verifies that the | |
1059 | service manager's real or effective group, or any of its | |
534bab66 FS |
1060 | auxiliary groups match the specified group or GID. This setting |
1061 | does not have a special value <literal>@system</literal>.</para> | |
c465a29f | 1062 | |
798d3a52 ZJS |
1063 | <para>If multiple conditions are specified, the unit will be |
1064 | executed if all of them apply (i.e. a logical AND is applied). | |
1065 | Condition checks can be prefixed with a pipe symbol (|) in | |
1066 | which case a condition becomes a triggering condition. If at | |
1067 | least one triggering condition is defined for a unit, then the | |
1068 | unit will be executed if at least one of the triggering | |
1069 | conditions apply and all of the non-triggering conditions. If | |
1070 | you prefix an argument with the pipe symbol and an exclamation | |
1071 | mark, the pipe symbol must be passed first, the exclamation | |
1072 | second. Except for | |
1073 | <varname>ConditionPathIsSymbolicLink=</varname>, all path | |
1074 | checks follow symlinks. If any of these options is assigned | |
1075 | the empty string, the list of conditions is reset completely, | |
1076 | all previous condition settings (of any kind) will have no | |
1077 | effect.</para></listitem> | |
1078 | </varlistentry> | |
1079 | ||
1080 | <varlistentry> | |
1081 | <term><varname>AssertArchitecture=</varname></term> | |
1082 | <term><varname>AssertVirtualization=</varname></term> | |
1083 | <term><varname>AssertHost=</varname></term> | |
1084 | <term><varname>AssertKernelCommandLine=</varname></term> | |
1085 | <term><varname>AssertSecurity=</varname></term> | |
1086 | <term><varname>AssertCapability=</varname></term> | |
1087 | <term><varname>AssertACPower=</varname></term> | |
1088 | <term><varname>AssertNeedsUpdate=</varname></term> | |
1089 | <term><varname>AssertFirstBoot=</varname></term> | |
1090 | <term><varname>AssertPathExists=</varname></term> | |
1091 | <term><varname>AssertPathExistsGlob=</varname></term> | |
1092 | <term><varname>AssertPathIsDirectory=</varname></term> | |
1093 | <term><varname>AssertPathIsSymbolicLink=</varname></term> | |
1094 | <term><varname>AssertPathIsMountPoint=</varname></term> | |
1095 | <term><varname>AssertPathIsReadWrite=</varname></term> | |
1096 | <term><varname>AssertDirectoryNotEmpty=</varname></term> | |
1097 | <term><varname>AssertFileNotEmpty=</varname></term> | |
1098 | <term><varname>AssertFileIsExecutable=</varname></term> | |
c465a29f FS |
1099 | <term><varname>AssertUser=</varname></term> |
1100 | <term><varname>AssertGroup=</varname></term> | |
798d3a52 | 1101 | |
41448597 LP |
1102 | <listitem><para>Similar to the <varname>ConditionArchitecture=</varname>, |
1103 | <varname>ConditionVirtualization=</varname>, …, condition settings described above, these settings add | |
1104 | assertion checks to the start-up of the unit. However, unlike the conditions settings, any assertion setting | |
da25e029 ZJS |
1105 | that is not met results in failure of the start job (which means this is logged loudly). Use assertion |
1106 | expressions for units that cannot operate when specific requirements are not met, and when this is something | |
1107 | the administrator or user should look into.</para></listitem> | |
798d3a52 ZJS |
1108 | </varlistentry> |
1109 | ||
1110 | <varlistentry> | |
1111 | <term><varname>SourcePath=</varname></term> | |
1112 | <listitem><para>A path to a configuration file this unit has | |
1113 | been generated from. This is primarily useful for | |
1114 | implementation of generator tools that convert configuration | |
1115 | from an external configuration file format into native unit | |
1116 | files. This functionality should not be used in normal | |
1117 | units.</para></listitem> | |
1118 | </varlistentry> | |
32ee7d33 | 1119 | |
798d3a52 ZJS |
1120 | </variablelist> |
1121 | ||
1122 | </refsect1> | |
1123 | ||
1124 | <refsect1> | |
1125 | <title>[Install] Section Options</title> | |
1126 | ||
be73bb48 LP |
1127 | <para>Unit files may include an <literal>[Install]</literal> section, which carries installation information for |
1128 | the unit. This section is not interpreted by | |
1129 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> during runtime; it is | |
1130 | used by the <command>enable</command> and <command>disable</command> commands of the | |
1131 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> tool during | |
1132 | installation of a unit. Note that settings in the <literal>[Install]</literal> section may not appear in | |
1133 | <filename>.d/*.conf</filename> unit file drop-ins (see above).</para> | |
798d3a52 ZJS |
1134 | |
1135 | <variablelist class='unit-directives'> | |
1136 | <varlistentry> | |
1137 | <term><varname>Alias=</varname></term> | |
1138 | ||
f4bf8d2f LP |
1139 | <listitem><para>A space-separated list of additional names this unit shall be installed under. The names listed |
1140 | here must have the same suffix (i.e. type) as the unit file name. This option may be specified more than once, | |
1141 | in which case all listed names are used. At installation time, <command>systemctl enable</command> will create | |
1142 | symlinks from these names to the unit filename. Note that not all unit types support such alias names, and this | |
1143 | setting is not supported for them. Specifically, mount, slice, swap, and automount units do not support | |
1144 | aliasing.</para></listitem> | |
798d3a52 ZJS |
1145 | </varlistentry> |
1146 | ||
1147 | <varlistentry> | |
1148 | <term><varname>WantedBy=</varname></term> | |
1149 | <term><varname>RequiredBy=</varname></term> | |
1150 | ||
1151 | <listitem><para>This option may be used more than once, or a | |
1152 | space-separated list of unit names may be given. A symbolic | |
1153 | link is created in the <filename>.wants/</filename> or | |
1154 | <filename>.requires/</filename> directory of each of the | |
1155 | listed units when this unit is installed by <command>systemctl | |
1156 | enable</command>. This has the effect that a dependency of | |
1157 | type <varname>Wants=</varname> or <varname>Requires=</varname> | |
1158 | is added from the listed unit to the current unit. The primary | |
1159 | result is that the current unit will be started when the | |
1160 | listed unit is started. See the description of | |
1161 | <varname>Wants=</varname> and <varname>Requires=</varname> in | |
1162 | the [Unit] section for details.</para> | |
1163 | ||
1164 | <para><command>WantedBy=foo.service</command> in a service | |
1165 | <filename>bar.service</filename> is mostly equivalent to | |
1166 | <command>Alias=foo.service.wants/bar.service</command> in the | |
1167 | same file. In case of template units, <command>systemctl | |
1168 | enable</command> must be called with an instance name, and | |
1169 | this instance will be added to the | |
1170 | <filename>.wants/</filename> or | |
1171 | <filename>.requires/</filename> list of the listed unit. E.g. | |
1172 | <command>WantedBy=getty.target</command> in a service | |
1173 | <filename>getty@.service</filename> will result in | |
1174 | <command>systemctl enable getty@tty2.service</command> | |
1175 | creating a | |
1176 | <filename>getty.target.wants/getty@tty2.service</filename> | |
1177 | link to <filename>getty@.service</filename>. | |
1178 | </para></listitem> | |
1179 | </varlistentry> | |
1180 | ||
1181 | <varlistentry> | |
1182 | <term><varname>Also=</varname></term> | |
1183 | ||
1184 | <listitem><para>Additional units to install/deinstall when | |
1185 | this unit is installed/deinstalled. If the user requests | |
1186 | installation/deinstallation of a unit with this option | |
1187 | configured, <command>systemctl enable</command> and | |
1188 | <command>systemctl disable</command> will automatically | |
1189 | install/uninstall units listed in this option as well.</para> | |
1190 | ||
1191 | <para>This option may be used more than once, or a | |
1192 | space-separated list of unit names may be | |
1193 | given.</para></listitem> | |
1194 | </varlistentry> | |
1195 | ||
1196 | <varlistentry> | |
1197 | <term><varname>DefaultInstance=</varname></term> | |
1198 | ||
1199 | <listitem><para>In template unit files, this specifies for | |
1200 | which instance the unit shall be enabled if the template is | |
1201 | enabled without any explicitly set instance. This option has | |
1202 | no effect in non-template unit files. The specified string | |
1203 | must be usable as instance identifier.</para></listitem> | |
1204 | </varlistentry> | |
1205 | </variablelist> | |
1206 | ||
1207 | <para>The following specifiers are interpreted in the Install | |
1208 | section: %n, %N, %p, %i, %U, %u, %m, %H, %b, %v. For their meaning | |
1209 | see the next section. | |
1210 | </para> | |
1211 | </refsect1> | |
1212 | ||
1213 | <refsect1> | |
1214 | <title>Specifiers</title> | |
1215 | ||
1216 | <para>Many settings resolve specifiers which may be used to write | |
1217 | generic unit files referring to runtime or unit parameters that | |
1218 | are replaced when the unit files are loaded. The following | |
1219 | specifiers are understood:</para> | |
1220 | ||
1221 | <table> | |
1222 | <title>Specifiers available in unit files</title> | |
1223 | <tgroup cols='3' align='left' colsep='1' rowsep='1'> | |
1224 | <colspec colname="spec" /> | |
1225 | <colspec colname="mean" /> | |
1226 | <colspec colname="detail" /> | |
1227 | <thead> | |
1228 | <row> | |
1229 | <entry>Specifier</entry> | |
1230 | <entry>Meaning</entry> | |
1231 | <entry>Details</entry> | |
1232 | </row> | |
1233 | </thead> | |
1234 | <tbody> | |
1235 | <row> | |
1236 | <entry><literal>%n</literal></entry> | |
1237 | <entry>Full unit name</entry> | |
1238 | <entry></entry> | |
1239 | </row> | |
1240 | <row> | |
1241 | <entry><literal>%N</literal></entry> | |
1242 | <entry>Unescaped full unit name</entry> | |
1243 | <entry>Same as <literal>%n</literal>, but with escaping undone</entry> | |
1244 | </row> | |
1245 | <row> | |
1246 | <entry><literal>%p</literal></entry> | |
1247 | <entry>Prefix name</entry> | |
1248 | <entry>For instantiated units, this refers to the string before the <literal>@</literal> character of the unit name. For non-instantiated units, this refers to the name of the unit with the type suffix removed.</entry> | |
1249 | </row> | |
1250 | <row> | |
1251 | <entry><literal>%P</literal></entry> | |
1252 | <entry>Unescaped prefix name</entry> | |
1253 | <entry>Same as <literal>%p</literal>, but with escaping undone</entry> | |
1254 | </row> | |
1255 | <row> | |
1256 | <entry><literal>%i</literal></entry> | |
1257 | <entry>Instance name</entry> | |
1258 | <entry>For instantiated units: this is the string between the <literal>@</literal> character and the suffix of the unit name.</entry> | |
1259 | </row> | |
1260 | <row> | |
1261 | <entry><literal>%I</literal></entry> | |
1262 | <entry>Unescaped instance name</entry> | |
1263 | <entry>Same as <literal>%i</literal>, but with escaping undone</entry> | |
1264 | </row> | |
1265 | <row> | |
1266 | <entry><literal>%f</literal></entry> | |
1267 | <entry>Unescaped filename</entry> | |
d1562103 | 1268 | <entry>This is either the unescaped instance name (if applicable) with <filename>/</filename> prepended (if applicable), or the unescaped prefix name prepended with <filename>/</filename>.</entry> |
798d3a52 ZJS |
1269 | </row> |
1270 | <row> | |
798d3a52 ZJS |
1271 | <entry><literal>%t</literal></entry> |
1272 | <entry>Runtime directory</entry> | |
1273 | <entry>This is either <filename>/run</filename> (for the system manager) or the path <literal>$XDG_RUNTIME_DIR</literal> resolves to (for user managers).</entry> | |
1274 | </row> | |
1275 | <row> | |
1276 | <entry><literal>%u</literal></entry> | |
1277 | <entry>User name</entry> | |
79413b67 | 1278 | <entry>This is the name of the user running the service manager instance. In case of the system manager this resolves to <literal>root</literal>.</entry> |
798d3a52 ZJS |
1279 | </row> |
1280 | <row> | |
1281 | <entry><literal>%U</literal></entry> | |
1282 | <entry>User UID</entry> | |
79413b67 | 1283 | <entry>This is the numeric UID of the user running the service manager instance. In case of the system manager this resolves to <literal>0</literal>.</entry> |
798d3a52 ZJS |
1284 | </row> |
1285 | <row> | |
1286 | <entry><literal>%h</literal></entry> | |
1287 | <entry>User home directory</entry> | |
79413b67 | 1288 | <entry>This is the home directory of the user running the service manager instance. In case of the system manager this resolves to <literal>/root</literal>.</entry> |
798d3a52 ZJS |
1289 | </row> |
1290 | <row> | |
1291 | <entry><literal>%s</literal></entry> | |
1292 | <entry>User shell</entry> | |
79413b67 | 1293 | <entry>This is the shell of the user running the service manager instance. In case of the system manager this resolves to <literal>/bin/sh</literal>.</entry> |
798d3a52 ZJS |
1294 | </row> |
1295 | <row> | |
1296 | <entry><literal>%m</literal></entry> | |
1297 | <entry>Machine ID</entry> | |
1298 | <entry>The machine ID of the running system, formatted as string. See <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.</entry> | |
1299 | </row> | |
1300 | <row> | |
1301 | <entry><literal>%b</literal></entry> | |
1302 | <entry>Boot ID</entry> | |
1303 | <entry>The boot ID of the running system, formatted as string. See <citerefentry><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry> for more information.</entry> | |
1304 | </row> | |
1305 | <row> | |
1306 | <entry><literal>%H</literal></entry> | |
1307 | <entry>Host name</entry> | |
e5f270f5 | 1308 | <entry>The hostname of the running system at the point in time the unit configuration is loaded.</entry> |
798d3a52 ZJS |
1309 | </row> |
1310 | <row> | |
1311 | <entry><literal>%v</literal></entry> | |
1312 | <entry>Kernel release</entry> | |
1313 | <entry>Identical to <command>uname -r</command> output</entry> | |
1314 | </row> | |
1315 | <row> | |
1316 | <entry><literal>%%</literal></entry> | |
1317 | <entry>Single percent sign</entry> | |
1318 | <entry>Use <literal>%%</literal> in place of <literal>%</literal> to specify a single percent sign.</entry> | |
1319 | </row> | |
1320 | </tbody> | |
1321 | </tgroup> | |
1322 | </table> | |
1323 | ||
798d3a52 ZJS |
1324 | </refsect1> |
1325 | ||
1326 | <refsect1> | |
1327 | <title>Examples</title> | |
1328 | ||
1329 | <example> | |
1330 | <title>Allowing units to be enabled</title> | |
1331 | ||
1332 | <para>The following snippet (highlighted) allows a unit (e.g. | |
1333 | <filename>foo.service</filename>) to be enabled via | |
1334 | <command>systemctl enable</command>:</para> | |
1335 | ||
1336 | <programlisting>[Unit] | |
92b1e225 CS |
1337 | Description=Foo |
1338 | ||
1339 | [Service] | |
1340 | ExecStart=/usr/sbin/foo-daemon | |
1341 | ||
1342 | <emphasis>[Install]</emphasis> | |
1343 | <emphasis>WantedBy=multi-user.target</emphasis></programlisting> | |
1344 | ||
798d3a52 ZJS |
1345 | <para>After running <command>systemctl enable</command>, a |
1346 | symlink | |
12b42c76 | 1347 | <filename>/etc/systemd/system/multi-user.target.wants/foo.service</filename> |
798d3a52 ZJS |
1348 | linking to the actual unit will be created. It tells systemd to |
1349 | pull in the unit when starting | |
1350 | <filename>multi-user.target</filename>. The inverse | |
1351 | <command>systemctl disable</command> will remove that symlink | |
1352 | again.</para> | |
1353 | </example> | |
1354 | ||
1355 | <example> | |
1356 | <title>Overriding vendor settings</title> | |
1357 | ||
1358 | <para>There are two methods of overriding vendor settings in | |
1359 | unit files: copying the unit file from | |
12b42c76 TG |
1360 | <filename>/usr/lib/systemd/system</filename> to |
1361 | <filename>/etc/systemd/system</filename> and modifying the | |
798d3a52 ZJS |
1362 | chosen settings. Alternatively, one can create a directory named |
1363 | <filename><replaceable>unit</replaceable>.d/</filename> within | |
12b42c76 | 1364 | <filename>/etc/systemd/system</filename> and place a drop-in |
798d3a52 ZJS |
1365 | file <filename><replaceable>name</replaceable>.conf</filename> |
1366 | there that only changes the specific settings one is interested | |
1367 | in. Note that multiple such drop-in files are read if | |
8331eaab | 1368 | present, processed in lexicographic order of their filename.</para> |
798d3a52 ZJS |
1369 | |
1370 | <para>The advantage of the first method is that one easily | |
1371 | overrides the complete unit, the vendor unit is not parsed at | |
1372 | all anymore. It has the disadvantage that improvements to the | |
1373 | unit file by the vendor are not automatically incorporated on | |
1374 | updates.</para> | |
1375 | ||
1376 | <para>The advantage of the second method is that one only | |
1377 | overrides the settings one specifically wants, where updates to | |
1378 | the unit by the vendor automatically apply. This has the | |
1379 | disadvantage that some future updates by the vendor might be | |
1380 | incompatible with the local changes.</para> | |
1381 | ||
1382 | <para>Note that for drop-in files, if one wants to remove | |
1383 | entries from a setting that is parsed as a list (and is not a | |
1384 | dependency), such as <varname>ConditionPathExists=</varname> (or | |
1385 | e.g. <varname>ExecStart=</varname> in service units), one needs | |
1386 | to first clear the list before re-adding all entries except the | |
1387 | one that is to be removed. See below for an example.</para> | |
1388 | ||
1389 | <para>This also applies for user instances of systemd, but with | |
1390 | different locations for the unit files. See the section on unit | |
1391 | load paths for further details.</para> | |
1392 | ||
1393 | <para>Suppose there is a vendor-supplied unit | |
12b42c76 | 1394 | <filename>/usr/lib/systemd/system/httpd.service</filename> with |
798d3a52 ZJS |
1395 | the following contents:</para> |
1396 | ||
1397 | <programlisting>[Unit] | |
92b1e225 CS |
1398 | Description=Some HTTP server |
1399 | After=remote-fs.target sqldb.service | |
1400 | Requires=sqldb.service | |
1401 | AssertPathExists=/srv/webserver | |
1402 | ||
1403 | [Service] | |
1404 | Type=notify | |
1405 | ExecStart=/usr/sbin/some-fancy-httpd-server | |
1406 | Nice=5 | |
1407 | ||
1408 | [Install] | |
1409 | WantedBy=multi-user.target</programlisting> | |
1410 | ||
798d3a52 ZJS |
1411 | <para>Now one wants to change some settings as an administrator: |
1412 | firstly, in the local setup, <filename>/srv/webserver</filename> | |
e2acdb6b | 1413 | might not exist, because the HTTP server is configured to use |
798d3a52 ZJS |
1414 | <filename>/srv/www</filename> instead. Secondly, the local |
1415 | configuration makes the HTTP server also depend on a memory | |
1416 | cache service, <filename>memcached.service</filename>, that | |
1417 | should be pulled in (<varname>Requires=</varname>) and also be | |
1418 | ordered appropriately (<varname>After=</varname>). Thirdly, in | |
1419 | order to harden the service a bit more, the administrator would | |
1420 | like to set the <varname>PrivateTmp=</varname> setting (see | |
912f003f | 1421 | <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> |
798d3a52 ZJS |
1422 | for details). And lastly, the administrator would like to reset |
1423 | the niceness of the service to its default value of 0.</para> | |
1424 | ||
1425 | <para>The first possibility is to copy the unit file to | |
12b42c76 | 1426 | <filename>/etc/systemd/system/httpd.service</filename> and |
798d3a52 ZJS |
1427 | change the chosen settings:</para> |
1428 | ||
1429 | <programlisting>[Unit] | |
92b1e225 CS |
1430 | Description=Some HTTP server |
1431 | After=remote-fs.target sqldb.service <emphasis>memcached.service</emphasis> | |
1432 | Requires=sqldb.service <emphasis>memcached.service</emphasis> | |
1433 | AssertPathExists=<emphasis>/srv/www</emphasis> | |
1434 | ||
1435 | [Service] | |
1436 | Type=notify | |
1437 | ExecStart=/usr/sbin/some-fancy-httpd-server | |
1438 | <emphasis>Nice=0</emphasis> | |
1439 | <emphasis>PrivateTmp=yes</emphasis> | |
1440 | ||
1441 | [Install] | |
1442 | WantedBy=multi-user.target</programlisting> | |
1443 | ||
798d3a52 ZJS |
1444 | <para>Alternatively, the administrator could create a drop-in |
1445 | file | |
12b42c76 | 1446 | <filename>/etc/systemd/system/httpd.service.d/local.conf</filename> |
798d3a52 | 1447 | with the following contents:</para> |
92b1e225 | 1448 | |
798d3a52 | 1449 | <programlisting>[Unit] |
92b1e225 CS |
1450 | After=memcached.service |
1451 | Requires=memcached.service | |
1452 | # Reset all assertions and then re-add the condition we want | |
1453 | AssertPathExists= | |
1454 | AssertPathExists=/srv/www | |
1455 | ||
1456 | [Service] | |
1457 | Nice=0 | |
1458 | PrivateTmp=yes</programlisting> | |
1459 | ||
798d3a52 ZJS |
1460 | <para>Note that dependencies (<varname>After=</varname>, etc.) |
1461 | cannot be reset to an empty list, so dependencies can only be | |
1462 | added in drop-ins. If you want to remove dependencies, you have | |
1463 | to override the entire unit.</para> | |
0cf4c0d1 | 1464 | |
798d3a52 ZJS |
1465 | </example> |
1466 | </refsect1> | |
1467 | ||
1468 | <refsect1> | |
1469 | <title>See Also</title> | |
1470 | <para> | |
1471 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
1472 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
1473 | <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, | |
1474 | <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
1475 | <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
1476 | <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
1477 | <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
1478 | <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
1479 | <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
1480 | <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
1481 | <citerefentry><refentrytitle>systemd.path</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
1482 | <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
798d3a52 ZJS |
1483 | <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>, |
1484 | <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
1485 | <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>, | |
1486 | <citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
1487 | <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>, | |
1488 | <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>, | |
3ba3a79d | 1489 | <citerefentry project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>1</manvolnum></citerefentry> |
798d3a52 ZJS |
1490 | </para> |
1491 | </refsect1> | |
d1ab0ca0 LP |
1492 | |
1493 | </refentry> |