chiark / gitweb /
build-sys: update intructions for Makefile-man.am regeneration
[elogind.git] / man / systemctl.xml
1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5 <!--
6 This file is part of systemd.
7
8 Copyright 2010 Lennart Poettering
9
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
14
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
19
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 -->
23
24 <refentry id="systemctl"
25           xmlns:xi="http://www.w3.org/2001/XInclude">
26
27   <refentryinfo>
28     <title>systemctl</title>
29     <productname>systemd</productname>
30
31     <authorgroup>
32       <author>
33         <contrib>Developer</contrib>
34         <firstname>Lennart</firstname>
35         <surname>Poettering</surname>
36         <email>lennart@poettering.net</email>
37       </author>
38     </authorgroup>
39   </refentryinfo>
40
41   <refmeta>
42     <refentrytitle>systemctl</refentrytitle>
43     <manvolnum>1</manvolnum>
44   </refmeta>
45
46   <refnamediv>
47     <refname>systemctl</refname>
48     <refpurpose>Control the systemd system and service manager</refpurpose>
49   </refnamediv>
50
51   <refsynopsisdiv>
52     <cmdsynopsis>
53       <command>systemctl</command>
54       <arg choice="opt" rep="repeat">OPTIONS</arg>
55       <arg choice="plain">COMMAND</arg>
56       <arg choice="opt" rep="repeat">NAME</arg>
57     </cmdsynopsis>
58   </refsynopsisdiv>
59
60   <refsect1>
61     <title>Description</title>
62
63     <para><command>systemctl</command> may be used to
64     introspect and control the state of the
65     <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
66     system and service manager.</para>
67   </refsect1>
68
69   <refsect1>
70     <title>Options</title>
71
72     <para>The following options are understood:</para>
73
74     <variablelist>
75       <varlistentry>
76         <term><option>-t</option></term>
77         <term><option>--type=</option></term>
78
79         <listitem>
80           <para>The argument should be a comma-separated list of unit
81           types such as <option>service</option> and
82           <option>socket</option>.
83           </para>
84
85           <para>If one of the arguments is a unit type, when listing
86           units, limit display to certain unit types. Otherwise, units
87           of all types will be shown.</para>
88
89           <para>As a special case, if one of the arguments is
90           <option>help</option>, a list of allowed values will be
91           printed and the program will exit.</para>
92         </listitem>
93       </varlistentry>
94
95       <varlistentry>
96         <term><option>--state=</option></term>
97
98         <listitem>
99         <para>The argument should be a comma-separated list of unit LOAD,
100         SUB, or ACTIVE states. When listing units, show only those
101         in specified states.</para>
102         </listitem>
103       </varlistentry>
104
105       <varlistentry>
106         <term><option>-p</option></term>
107         <term><option>--property=</option></term>
108
109         <listitem>
110           <para>When showing unit/job/manager properties with the
111           <command>show</command> command, limit display to certain
112           properties as specified as argument. If not specified, all
113           set properties are shown. The argument should be a
114           comma-separated list of property names, such as
115           <literal>MainPID</literal>. If specified more than once, all
116           properties with the specified names are shown.</para>
117         </listitem>
118       </varlistentry>
119
120       <varlistentry>
121         <term><option>-a</option></term>
122         <term><option>--all</option></term>
123
124         <listitem>
125           <para>When listing units, show all loaded units, regardless
126           of their state, including inactive units. When showing
127           unit/job/manager properties, show all properties regardless
128           whether they are set or not.</para>
129           <para>To list all units installed on the system, use the
130           <command>list-unit-files</command> command instead.</para>
131         </listitem>
132       </varlistentry>
133
134       <varlistentry>
135         <term><option>--reverse</option></term>
136
137         <listitem>
138           <para>Show reverse dependencies between units with
139           <command>list-dependencies</command>, i.e. units with
140           dependencies of type <varname>Wants=</varname> or
141           <varname>Requires=</varname> on the given unit.
142           </para>
143         </listitem>
144       </varlistentry>
145
146       <varlistentry>
147         <term><option>--after</option></term>
148         <term><option>--before</option></term>
149
150         <listitem>
151           <para>Show which units are started after or before
152           with <command>list-dependencies</command>, respectively.
153           </para>
154         </listitem>
155       </varlistentry>
156
157       <varlistentry>
158         <term><option>-l</option></term>
159         <term><option>--full</option></term>
160
161         <listitem>
162           <para>Do not ellipsize unit names, process tree entries,
163           journal output, or truncate unit descriptions in the output
164           of <command>status</command>, <command>list-units</command>,
165           <command>list-jobs</command>, and
166           <command>list-timers</command>.</para>
167         </listitem>
168       </varlistentry>
169
170       <varlistentry>
171         <term><option>--show-types</option></term>
172
173         <listitem>
174           <para>When showing sockets, show the type of the socket.</para>
175         </listitem>
176       </varlistentry>
177
178       <varlistentry>
179         <term><option>--job-mode=</option></term>
180
181         <listitem>
182         <para>When queuing a new job, this option controls how to deal with
183         already queued jobs. It takes one of <literal>fail</literal>,
184         <literal>replace</literal>,
185         <literal>replace-irreversibly</literal>,
186         <literal>isolate</literal>,
187         <literal>ignore-dependencies</literal>,
188         <literal>ignore-requirements</literal> or
189         <literal>flush</literal>. Defaults to
190         <literal>replace</literal>, except when the
191         <command>isolate</command> command is used which implies the
192         <literal>isolate</literal> job mode.</para>
193
194         <para>If <literal>fail</literal> is specified and a requested
195         operation conflicts with a pending job (more specifically:
196         causes an already pending start job to be reversed into a stop
197         job or vice versa), cause the operation to fail.</para>
198
199         <para>If <literal>replace</literal> (the default) is
200         specified, any conflicting pending job will be replaced, as
201         necessary.</para>
202
203         <para>If <literal>replace-irreversibly</literal> is specified,
204         operate like <literal>replace</literal>, but also mark the new
205         jobs as irreversible. This prevents future conflicting
206         transactions from replacing these jobs. The jobs can still be
207         cancelled using the <command>cancel</command> command.</para>
208
209         <para><literal>isolate</literal> is only valid for start
210         operations and causes all other units to be stopped when the
211         specified unit is started. This mode is always used when the
212         <command>isolate</command> command is used.</para>
213
214         <para><literal>flush</literal> will cause all queued jobs to
215         be canceled when the new job is enqueued.</para>
216
217         <para>If <literal>ignore-dependencies</literal> is specified,
218         then all unit dependencies are ignored for this new job and
219         the operation is executed immediately. If passed, no required
220         units of the unit passed will be pulled in, and no ordering
221         dependencies will be honored. This is mostly a debugging and
222         rescue tool for the administrator and should not be used by
223         applications.</para>
224
225         <para><literal>ignore-requirements</literal> is similar to
226         <literal>ignore-dependencies</literal>, but only causes the
227         requirement dependencies to be ignored, the ordering
228         dependencies will still be honoured.</para>
229         </listitem>
230
231       </varlistentry>
232
233       <varlistentry>
234         <term><option>-i</option></term>
235         <term><option>--ignore-inhibitors</option></term>
236
237         <listitem>
238           <para>When system shutdown or a sleep state is requested,
239           ignore inhibitor locks. Applications can establish inhibitor
240           locks to avoid that certain important operations (such as CD
241           burning or suchlike) are interrupted by system shutdown or a
242           sleep state. Any user may take these locks and privileged
243           users may override these locks. If any locks are taken,
244           shutdown and sleep state requests will normally fail
245           (regardless of whether privileged or not) and a list of active locks
246           is printed. However, if <option>--ignore-inhibitors</option>
247           is specified, the locks are ignored and not printed, and the
248           operation attempted anyway, possibly requiring additional
249           privileges.</para>
250         </listitem>
251       </varlistentry>
252
253       <varlistentry>
254         <term><option>-q</option></term>
255         <term><option>--quiet</option></term>
256
257         <listitem>
258           <para>Suppress output to standard output in
259           <command>snapshot</command>,
260           <command>is-active</command>,
261           <command>is-failed</command>,
262           <command>enable</command> and
263         <command>disable</command>.</para>
264         </listitem>
265       </varlistentry>
266
267       <varlistentry>
268         <term><option>--no-block</option></term>
269
270         <listitem>
271           <para>Do not synchronously wait for the requested operation
272           to finish. If this is not specified, the job will be
273           verified, enqueued and <command>systemctl</command> will
274           wait until it is completed. By passing this argument, it is
275           only verified and enqueued.</para>
276         </listitem>
277       </varlistentry>
278
279       <varlistentry>
280         <term><option>--no-legend</option></term>
281
282         <listitem>
283           <para>Do not print the legend, i.e. the column headers and
284           the footer with hints.</para>
285         </listitem>
286       </varlistentry>
287
288       <xi:include href="user-system-options.xml" xpointer="user" />
289       <xi:include href="user-system-options.xml" xpointer="system" />
290
291       <varlistentry>
292         <term><option>--no-wall</option></term>
293
294         <listitem>
295           <para>Do not send wall message before halt, power-off,
296           reboot.</para>
297         </listitem>
298       </varlistentry>
299
300       <varlistentry>
301         <term><option>--global</option></term>
302
303         <listitem>
304           <para>When used with <command>enable</command> and
305           <command>disable</command>, operate on the global user
306           configuration directory, thus enabling or disabling a unit
307           file globally for all future logins of all users.</para>
308         </listitem>
309       </varlistentry>
310
311       <varlistentry>
312         <term><option>--no-reload</option></term>
313
314         <listitem>
315           <para>When used with <command>enable</command> and
316           <command>disable</command>, do not implicitly reload daemon
317           configuration after executing the changes.</para>
318         </listitem>
319       </varlistentry>
320
321       <varlistentry>
322         <term><option>--no-ask-password</option></term>
323
324         <listitem>
325           <para>When used with <command>start</command> and related
326           commands, disables asking for passwords. Background services
327           may require input of a password or passphrase string, for
328           example to unlock system hard disks or cryptographic
329           certificates. Unless this option is specified and the
330           command is invoked from a terminal,
331           <command>systemctl</command> will query the user on the
332           terminal for the necessary secrets. Use this option to
333           switch this behavior off. In this case, the password must be
334           supplied by some other means (for example graphical password
335           agents) or the service might fail. This also disables
336           querying the user for authentication for privileged
337           operations.</para>
338         </listitem>
339
340       </varlistentry>
341
342       <varlistentry>
343         <term><option>--kill-who=</option></term>
344
345         <listitem>
346           <para>When used with <command>kill</command>, choose which
347           processes to kill. Must be one of <option>main</option>,
348           <option>control</option> or <option>all</option> to select
349           whether to kill only the main process of the unit, the
350           control process or all processes of the unit. If omitted,
351           defaults to <option>all</option>.</para>
352         </listitem>
353
354       </varlistentry>
355
356       <varlistentry>
357         <term><option>-s</option></term>
358         <term><option>--signal=</option></term>
359
360         <listitem>
361           <para>When used with <command>kill</command>, choose which
362           signal to send to selected processes. Must be one of the
363           well known signal specifiers such as <constant>SIGTERM</constant>, <constant>SIGINT</constant> or
364           <constant>SIGSTOP</constant>. If omitted, defaults to
365           <option>SIGTERM</option>.</para>
366         </listitem>
367       </varlistentry>
368
369       <varlistentry>
370         <term><option>-f</option></term>
371         <term><option>--force</option></term>
372
373         <listitem>
374           <para>When used with <command>enable</command>, overwrite
375           any existing conflicting symlinks.</para>
376
377           <para>When used with <command>halt</command>,
378           <command>poweroff</command>, <command>reboot</command> or
379           <command>kexec</command>, execute the selected operation
380           without shutting down all units. However, all processes will
381           be killed forcibly and all file systems are unmounted or
382           remounted read-only. This is hence a drastic but relatively
383           safe option to request an immediate reboot. If
384           <option>--force</option> is specified twice for these
385           operations, they will be executed immediately without
386           terminating any processes or umounting any file
387           systems. Warning: specifying <option>--force</option> twice
388           with any of these operations might result in data
389           loss.</para>
390         </listitem>
391       </varlistentry>
392
393       <varlistentry>
394         <term><option>--root=</option></term>
395
396         <listitem>
397           <para>When used with
398           <command>enable</command>/<command>disable</command>/<command>is-enabled</command>
399           (and related commands), use alternative root path when
400           looking for unit files.</para>
401         </listitem>
402
403       </varlistentry>
404
405       <varlistentry>
406         <term><option>--runtime</option></term>
407
408         <listitem>
409           <para>When used with <command>enable</command>,
410           <command>disable</command>,
411           (and related commands), make changes only temporarily, so
412           that they are lost on the next reboot. This will have the
413           effect that changes are not made in subdirectories of
414           <filename>/etc</filename> but in <filename>/run</filename>,
415           with identical immediate effects, however, since the latter
416           is lost on reboot, the changes are lost too.</para>
417
418           <para>Similarly, when used with
419           <command>set-property</command>, make changes only
420           temporarily, so that they are lost on the next
421           reboot.</para>
422         </listitem>
423       </varlistentry>
424
425       <varlistentry>
426         <term><option>-n</option></term>
427         <term><option>--lines=</option></term>
428
429         <listitem>
430           <para>When used with <command>status</command>, controls the
431           number of journal lines to show, counting from the most
432           recent ones. Takes a positive integer argument. Defaults to
433           10.</para>
434         </listitem>
435       </varlistentry>
436
437       <varlistentry>
438         <term><option>-o</option></term>
439         <term><option>--output=</option></term>
440
441         <listitem>
442           <para>When used with <command>status</command>, controls the
443           formatting of the journal entries that are shown. For the
444           available choices, see
445           <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
446           Defaults to <literal>short</literal>.</para>
447         </listitem>
448       </varlistentry>
449
450       <varlistentry>
451         <term><option>--plain</option></term>
452
453         <listitem>
454           <para>When used with <command>list-dependencies</command>,
455           the output is printed as a list instead of a tree.</para>
456         </listitem>
457       </varlistentry>
458
459       <xi:include href="user-system-options.xml" xpointer="host" />
460       <xi:include href="user-system-options.xml" xpointer="machine" />
461
462       <xi:include href="standard-options.xml" xpointer="help" />
463       <xi:include href="standard-options.xml" xpointer="version" />
464       <xi:include href="standard-options.xml" xpointer="no-pager" />
465     </variablelist>
466   </refsect1>
467
468   <refsect1>
469     <title>Commands</title>
470
471     <para>The following commands are understood:</para>
472
473     <refsect2>
474       <title>Unit Commands</title>
475
476       <variablelist>
477         <varlistentry>
478           <term><command>list-units <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
479
480           <listitem>
481             <para>List known units (subject to limitations specified
482             with <option>-t</option>). If one or more
483             <replaceable>PATTERN</replaceable>s are specified, only
484             units matching one of them are shown.</para>
485
486             <para>This is the default command.</para>
487           </listitem>
488         </varlistentry>
489
490         <varlistentry>
491           <term><command>list-sockets <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
492
493           <listitem>
494             <para>List socket units ordered by listening address.
495             If one or more <replaceable>PATTERN</replaceable>s are
496             specified, only socket units matching one of them are
497             shown. Produces output similar to
498             <programlisting>
499 LISTEN           UNIT                        ACTIVATES
500 /dev/initctl     systemd-initctl.socket      systemd-initctl.service
501 ...
502 [::]:22          sshd.socket                 sshd.service
503 kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
504
505 5 sockets listed.</programlisting>
506             Note: because the addresses might contains spaces, this output
507             is not suitable for programmatic consumption.
508             </para>
509
510             <para>See also the options <option>--show-types</option>,
511             <option>--all</option>, and <option>--failed</option>.</para>
512           </listitem>
513         </varlistentry>
514
515         <varlistentry>
516           <term><command>list-timers <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
517
518           <listitem>
519             <para>List timer units ordered by the time they elapse
520             next. If one or more <replaceable>PATTERN</replaceable>s
521             are specified, only units matching one of them are shown.
522             </para>
523
524             <para>See also the options <option>--all</option> and
525             <option>--failed</option>.</para>
526           </listitem>
527         </varlistentry>
528
529         <varlistentry>
530           <term><command>start <replaceable>PATTERN</replaceable>...</command></term>
531
532           <listitem>
533             <para>Start (activate) one or more units specified on the
534             command line.</para>
535
536             <para>Note that glob patterns operate on a list of currently
537             loaded units. Units which are not active and are not in a
538             failed state usually are not loaded, and would not be
539             matched by any pattern. In addition, in case of
540             instantiated units, systemd is often unaware of the
541             instance name until the instance has been started. Therefore,
542             using glob patterns with <command>start</command>
543             has limited usefulness.</para>
544           </listitem>
545         </varlistentry>
546         <varlistentry>
547           <term><command>stop <replaceable>PATTERN</replaceable>...</command></term>
548
549           <listitem>
550             <para>Stop (deactivate) one or more units specified on the
551             command line.</para>
552           </listitem>
553         </varlistentry>
554         <varlistentry>
555           <term><command>reload <replaceable>PATTERN</replaceable>...</command></term>
556
557           <listitem>
558             <para>Asks all units listed on the command line to reload
559             their configuration. Note that this will reload the
560             service-specific configuration, not the unit configuration
561             file of systemd. If you want systemd to reload the
562             configuration file of a unit, use the
563             <command>daemon-reload</command> command. In other words:
564             for the example case of Apache, this will reload Apache's
565             <filename>httpd.conf</filename> in the web server, not the
566             <filename>apache.service</filename> systemd unit
567             file.</para>
568
569             <para>This command should not be confused with the
570             <command>daemon-reload</command> or <command>load</command>
571             commands.</para>
572           </listitem>
573
574         </varlistentry>
575         <varlistentry>
576           <term><command>restart <replaceable>PATTERN</replaceable>...</command></term>
577
578           <listitem>
579             <para>Restart one or more units specified on the command
580             line. If the units are not running yet, they will be
581             started.</para>
582           </listitem>
583         </varlistentry>
584         <varlistentry>
585           <term><command>try-restart <replaceable>PATTERN</replaceable>...</command></term>
586
587           <listitem>
588             <para>Restart one or more units specified on the command
589             line if the units are running. This does nothing if units are not
590             running.  Note that, for compatibility with Red Hat init
591             scripts, <command>condrestart</command> is equivalent to this
592             command.</para>
593           </listitem>
594         </varlistentry>
595         <varlistentry>
596           <term><command>reload-or-restart <replaceable>PATTERN</replaceable>...</command></term>
597
598           <listitem>
599             <para>Reload one or more units if they support it. If not,
600             restart them instead. If the units are not running yet, they
601             will be started.</para>
602           </listitem>
603         </varlistentry>
604         <varlistentry>
605           <term><command>reload-or-try-restart <replaceable>PATTERN</replaceable>...</command></term>
606
607           <listitem>
608             <para>Reload one or more units if they support it. If not,
609             restart them instead. This does nothing if the units are not
610             running. Note that, for compatibility with SysV init scripts,
611             <command>force-reload</command> is equivalent to this
612             command.</para>
613           </listitem>
614         </varlistentry>
615         <varlistentry>
616           <term><command>isolate <replaceable>NAME</replaceable></command></term>
617
618           <listitem>
619             <para>Start the unit specified on the command line and its
620             dependencies and stop all others.</para>
621
622             <para>This is similar to changing the runlevel in a
623             traditional init system. The <command>isolate</command>
624             command will immediately stop processes that are not enabled
625             in the new unit, possibly including the graphical
626             environment or terminal you are currently using.</para>
627
628             <para>Note that this is allowed only on units where
629             <option>AllowIsolate=</option> is enabled. See
630             <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
631             for details.</para>
632           </listitem>
633         </varlistentry>
634         <varlistentry>
635           <term><command>kill <replaceable>PATTERN</replaceable>...</command></term>
636
637           <listitem>
638             <para>Send a signal to one or more processes of the
639             unit. Use <option>--kill-who=</option> to select which
640             process to kill. Use <option>--kill-mode=</option> to select
641             the kill mode and <option>--signal=</option> to select the
642             signal to send.</para>
643           </listitem>
644         </varlistentry>
645         <varlistentry>
646           <term><command>is-active <replaceable>PATTERN</replaceable>...</command></term>
647
648           <listitem>
649             <para>Check whether any of the specified units are active
650             (i.e. running). Returns an exit code
651             <constant>0</constant> if at least one is active, or
652             non-zero otherwise. Unless <option>--quiet</option> is
653             specified, this will also print the current unit state to
654             standard output.</para>
655           </listitem>
656         </varlistentry>
657         <varlistentry>
658           <term><command>is-failed <replaceable>PATTERN</replaceable>...</command></term>
659
660           <listitem>
661             <para>Check whether any of the specified units are in a
662             "failed" state. Returns an exit code
663             <constant>0</constant> if at least one has failed,
664             non-zero otherwise. Unless <option>--quiet</option> is
665             specified, this will also print the current unit state to
666             standard output.</para>
667           </listitem>
668         </varlistentry>
669         <varlistentry>
670           <term><command>status</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...]</optional></term>
671
672           <listitem>
673             <para>Show terse runtime status information about one or
674             more units, followed by most recent log data from the
675             journal. If no units are specified, show all units (subject
676             to limitations specified with <option>-t</option>). If a PID
677             is passed, show information about the unit the process
678             belongs to.</para>
679
680             <para>This function is intended to generate human-readable
681             output. If you are looking for computer-parsable output,
682             use <command>show</command> instead. By default this
683             function only shows 10 lines of output and ellipsizes
684             lines to fit in the terminal window. This can be changes
685             with <option>--lines</option> and <option>--full</option>,
686             see above. In addition, <command>journalctl
687             --unit=<replaceable>NAME</replaceable></command> or
688             <command>journalctl
689             --user-unit=<replaceable>NAME</replaceable></command> use
690             a similar filter for messages and might be more
691             convenient.
692             </para>
693           </listitem>
694         </varlistentry>
695         <varlistentry>
696           <term><command>show</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>JOB</replaceable>...</optional></term>
697
698           <listitem>
699             <para>Show properties of one or more units, jobs, or the
700             manager itself. If no argument is specified, properties of
701             the manager will be shown. If a unit name is specified,
702             properties of the unit is shown, and if a job id is
703             specified, properties of the job is shown. By default, empty
704             properties are suppressed. Use <option>--all</option> to
705             show those too. To select specific properties to show, use
706             <option>--property=</option>. This command is intended to be
707             used whenever computer-parsable output is required. Use
708             <command>status</command> if you are looking for formatted
709             human-readable output.</para>
710           </listitem>
711         </varlistentry>
712         <varlistentry>
713           <term><command>cat <replaceable>PATTERN</replaceable>...</command></term>
714
715           <listitem>
716             <para>Show backing files of one or more units. Prints the
717             "fragment" and "drop-ins" (source files) of units. Each
718             file is preceded by a comment which includes the file
719             name.</para>
720           </listitem>
721         </varlistentry>
722         <varlistentry>
723           <term><command>set-property <replaceable>NAME</replaceable> <replaceable>ASSIGNMENT</replaceable>...</command></term>
724
725           <listitem>
726             <para>Set the specified unit properties at runtime where
727             this is supported. This allows changing configuration
728             parameter properties such as resource control settings at
729             runtime. Not all properties may be changed at runtime, but
730             many resource control settings (primarily those in
731             <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
732             may. The changes are applied instantly, and stored on disk
733             for future boots, unless <option>--runtime</option> is
734             passed, in which case the settings only apply until the
735             next reboot. The syntax of the property assignment follows
736             closely the syntax of assignments in unit files.</para>
737
738             <para>Example: <command>systemctl set-property foobar.service CPUShares=777</command></para>
739
740             <para>Note that this command allows changing multiple
741             properties at the same time, which is preferable over
742             setting them individually. Like unit file configuration
743             settings, assigning the empty list to list parameters will
744             reset the list.</para>
745           </listitem>
746         </varlistentry>
747
748         <varlistentry>
749           <term><command>help <replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...</command></term>
750
751           <listitem>
752             <para>Show manual pages for one or more units, if
753             available. If a PID is given, the manual pages for the unit
754             the process belongs to are shown.</para>
755           </listitem>
756         </varlistentry>
757
758         <varlistentry>
759           <term><command>reset-failed [<replaceable>PATTERN</replaceable>...]</command></term>
760
761           <listitem>
762             <para>Reset the <literal>failed</literal> state of the
763             specified units, or if no unit name is passed, reset the state of all
764             units. When a unit fails in some way (i.e. process exiting
765             with non-zero error code, terminating abnormally or timing
766             out), it will automatically enter the
767             <literal>failed</literal> state and its exit code and status
768             is recorded for introspection by the administrator until the
769             service is restarted or reset with this command.</para>
770           </listitem>
771         </varlistentry>
772
773         <varlistentry>
774           <term><command>list-dependencies <replaceable>NAME</replaceable></command></term>
775
776           <listitem>
777             <para>Shows required and wanted units of the specified
778             unit. If no unit is specified,
779             <filename>default.target</filename> is implied. Target units
780             are recursively expanded.  When <option>--all</option> is
781             passed, all other units are recursively expanded as
782             well.</para>
783           </listitem>
784         </varlistentry>
785       </variablelist>
786     </refsect2>
787
788     <refsect2>
789       <title>Unit File Commands</title>
790
791       <variablelist>
792         <varlistentry>
793           <term><command>list-unit-files <optional><replaceable>PATTERN...</replaceable></optional></command></term>
794
795           <listitem>
796             <para>List installed unit files. If one or more
797             <replaceable>PATTERN</replaceable>s are specified, only
798             units whose filename (just the last component of the path)
799             matches one of them are shown.</para>
800           </listitem>
801         </varlistentry>
802
803         <varlistentry>
804           <term><command>enable <replaceable>NAME</replaceable>...</command></term>
805
806           <listitem>
807             <para>Enable one or more unit files or unit file instances,
808             as specified on the command line. This will create a number
809             of symlinks as encoded in the <literal>[Install]</literal>
810             sections of the unit files. After the symlinks have been
811             created, the systemd configuration is reloaded (in a way that
812             is equivalent to <command>daemon-reload</command>) to ensure
813             the changes are taken into account immediately. Note that
814             this does <emphasis>not</emphasis> have the effect of also
815             starting any of the units being enabled. If this
816             is desired, a separate <command>start</command> command must
817             be invoked for the unit. Also note that in case of instance
818             enablement, symlinks named the same as instances are created in
819             the install location, however they all point to the same
820             template unit file.</para>
821
822             <para>This command will print the actions executed. This
823             output may be suppressed by passing <option>--quiet</option>.
824             </para>
825
826             <para>Note that this operation creates only the suggested
827             symlinks for the units. While this command is the
828             recommended way to manipulate the unit configuration
829             directory, the administrator is free to make additional
830             changes manually by placing or removing symlinks in the
831             directory. This is particularly useful to create
832             configurations that deviate from the suggested default
833             installation. In this case, the administrator must make sure
834             to invoke <command>daemon-reload</command> manually as
835             necessary to ensure the changes are taken into account.
836             </para>
837
838             <para>Enabling units should not be confused with starting
839             (activating) units, as done by the <command>start</command>
840             command. Enabling and starting units is orthogonal: units
841             may be enabled without being started and started without
842             being enabled. Enabling simply hooks the unit into various
843             suggested places (for example, so that the unit is
844             automatically started on boot or when a particular kind of
845             hardware is plugged in). Starting actually spawns the daemon
846             process (in case of service units), or binds the socket (in
847             case of socket units), and so on.</para>
848
849             <para>Depending on whether <option>--system</option>,
850             <option>--user</option>, <option>--runtime</option>,
851             or <option>--global</option> is specified, this enables the unit
852             for the system, for the calling user only, for only this boot of
853             the system, or for all future logins of all users, or only this
854             boot.  Note that in the last case, no systemd daemon
855             configuration is reloaded.</para>
856           </listitem>
857         </varlistentry>
858
859         <varlistentry>
860           <term><command>disable <replaceable>NAME</replaceable>...</command></term>
861
862           <listitem>
863             <para>Disables one or more units. This removes all symlinks
864             to the specified unit files from the unit configuration
865             directory, and hence undoes the changes made by
866             <command>enable</command>. Note however that this removes
867             all symlinks to the unit files (i.e. including manual
868             additions), not just those actually created by
869             <command>enable</command>. This call implicitly reloads the
870             systemd daemon configuration after completing the disabling
871             of the units. Note that this command does not implicitly
872             stop the units that are being disabled. If this is desired,
873             an additional <command>stop</command> command should be
874             executed afterwards.</para>
875
876             <para>This command will print the actions executed. This
877             output may be suppressed by passing <option>--quiet</option>.
878             </para>
879
880             <para>This command honors <option>--system</option>,
881             <option>--user</option>, <option>--runtime</option> and
882             <option>--global</option> in a similar way as
883             <command>enable</command>.</para>
884           </listitem>
885         </varlistentry>
886
887         <varlistentry>
888           <term><command>is-enabled <replaceable>NAME</replaceable>...</command></term>
889
890           <listitem>
891             <para>Checks whether any of the specified unit files are
892             enabled (as with <command>enable</command>). Returns an
893             exit code of 0 if at least one is enabled, non-zero
894             otherwise. Prints the current enable status (see table).
895             To suppress this output, use <option>--quiet</option>.
896             </para>
897
898             <table>
899               <title>
900                 <command>is-enabled</command> output
901               </title>
902
903               <tgroup cols='3'>
904                 <thead>
905                   <row>
906                     <entry>Printed string</entry>
907                     <entry>Meaning</entry>
908                     <entry>Return value</entry>
909                   </row>
910                 </thead>
911                 <tbody>
912                   <row>
913                     <entry><literal>enabled</literal></entry>
914                     <entry morerows='1'>Enabled through a symlink in <filename>.wants</filename> directory (permanently or just in <filename>/run</filename>)</entry>
915                     <entry morerows='1'>0</entry>
916                   </row>
917                   <row>
918                     <entry><literal>enabled-runtime</literal></entry>
919                   </row>
920                   <row>
921                     <entry><literal>linked</literal></entry>
922                     <entry morerows='1'>Made available through a symlink to the unit file (permanently or just in <filename>/run</filename>)</entry>
923                     <entry morerows='1'>1</entry>
924                   </row>
925                   <row>
926                     <entry><literal>linked-runtime</literal></entry>
927                   </row>
928                   <row>
929                     <entry><literal>masked</literal></entry>
930                     <entry morerows='1'>Disabled entirely (permanently or just in <filename>/run</filename>)</entry>
931                     <entry morerows='1'>1</entry>
932                   </row>
933                   <row>
934                     <entry><literal>masked-runtime</literal></entry>
935                   </row>
936                   <row>
937                     <entry><literal>static</literal></entry>
938                     <entry>Unit is not enabled, but has no provisions for enabling in [Install] section</entry>
939                     <entry>0</entry>
940                   </row>
941                   <row>
942                     <entry><literal>disabled</literal></entry>
943                     <entry>Unit is not enabled</entry>
944                     <entry>1</entry>
945                   </row>
946                 </tbody>
947               </tgroup>
948             </table>
949
950           </listitem>
951         </varlistentry>
952
953         <varlistentry>
954           <term><command>reenable <replaceable>NAME</replaceable>...</command></term>
955
956           <listitem>
957             <para>Reenable one or more unit files, as specified on the
958             command line. This is a combination of
959             <command>disable</command> and <command>enable</command> and
960             is useful to reset the symlinks a unit is enabled with to
961             the defaults configured in the <literal>[Install]</literal>
962             section of the unit file.</para>
963           </listitem>
964         </varlistentry>
965
966         <varlistentry>
967           <term><command>preset <replaceable>NAME</replaceable>...</command></term>
968
969           <listitem>
970             <para>Reset one or more unit files, as specified on the
971             command line, to the defaults configured in the preset
972             policy files. This has the same effect as
973             <command>disable</command> or <command>enable</command>,
974             depending how the unit is listed in the preset files. For
975             more information on the preset policy format, see
976             <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
977             For more information on the concept of presets, please
978             consult the
979             <ulink url="http://freedesktop.org/wiki/Software/systemd/Preset">Preset</ulink>
980             document.</para>
981           </listitem>
982         </varlistentry>
983
984         <varlistentry>
985           <term><command>mask <replaceable>NAME</replaceable>...</command></term>
986
987           <listitem>
988             <para>Mask one or more unit files, as specified on the
989             command line. This will link these units to
990             <filename>/dev/null</filename>, making it impossible to
991             start them. This is a stronger version of
992             <command>disable</command>, since it prohibits all kinds of
993             activation of the unit, including manual activation. Use
994             this option with care. This honors the
995             <option>--runtime</option> option to only mask temporarily
996             until the next reoobt of the system.</para>
997           </listitem>
998         </varlistentry>
999
1000         <varlistentry>
1001           <term><command>unmask <replaceable>NAME</replaceable>...</command></term>
1002
1003           <listitem>
1004             <para>Unmask one or more unit files, as specified on the
1005             command line. This will undo the effect of
1006             <command>mask</command>.</para>
1007           </listitem>
1008         </varlistentry>
1009
1010         <varlistentry>
1011           <term><command>link <replaceable>FILENAME</replaceable>...</command></term>
1012
1013           <listitem>
1014             <para>Link a unit file that is not in the unit file search
1015             paths into the unit file search path. This requires an
1016             absolute path to a unit file. The effect of this can be
1017             undone with <command>disable</command>. The effect of this
1018             command is that a unit file is available for
1019             <command>start</command> and other commands although it
1020             is not installed directly in the unit search path.</para>
1021           </listitem>
1022         </varlistentry>
1023
1024         <varlistentry>
1025           <term><command>get-default</command></term>
1026
1027           <listitem>
1028             <para>Get the default target specified
1029             via <filename>default.target</filename> link.</para>
1030           </listitem>
1031         </varlistentry>
1032
1033         <varlistentry>
1034           <term><command>set-default <replaceable>NAME</replaceable></command></term>
1035
1036           <listitem>
1037             <para>Set the default target to boot into. Command links
1038             <filename>default.target</filename> to the given unit.</para>
1039           </listitem>
1040         </varlistentry>
1041       </variablelist>
1042     </refsect2>
1043
1044     <refsect2>
1045       <title>Job Commands</title>
1046
1047       <variablelist>
1048         <varlistentry>
1049           <term><command>list-jobs <optional><replaceable>PATTERN...</replaceable></optional></command></term>
1050
1051           <listitem>
1052             <para>List jobs that are in progress. If one or more
1053             <replaceable>PATTERN</replaceable>s are specified, only
1054             jobs for units matching one of them are shown.</para>
1055           </listitem>
1056         </varlistentry>
1057         <varlistentry>
1058           <term><command>cancel <replaceable>JOB</replaceable>...</command></term>
1059
1060           <listitem>
1061             <para>Cancel one or more jobs specified on the command line
1062             by their numeric job IDs. If no job ID is specified, cancel
1063             all pending jobs.</para>
1064           </listitem>
1065         </varlistentry>
1066       </variablelist>
1067     </refsect2>
1068
1069     <refsect2>
1070       <title>Snapshot Commands</title>
1071
1072       <variablelist>
1073         <varlistentry>
1074           <term><command>snapshot <optional><replaceable>NAME</replaceable></optional></command></term>
1075
1076           <listitem>
1077             <para>Create a snapshot. If a snapshot name is specified,
1078             the new snapshot will be named after it. If none is
1079             specified, an automatic snapshot name is generated. In
1080             either case, the snapshot name used is printed to standard
1081             output, unless <option>--quiet</option> is specified.
1082             </para>
1083
1084             <para>A snapshot refers to a saved state of the systemd
1085             manager. It is implemented itself as a unit that is
1086             generated dynamically with this command and has dependencies
1087             on all units active at the time. At a later time, the user
1088             may return to this state by using the
1089             <command>isolate</command> command on the snapshot unit.
1090             </para>
1091
1092             <para>Snapshots are only useful for saving and restoring
1093             which units are running or are stopped, they do not
1094             save/restore any other state. Snapshots are dynamic and lost
1095             on reboot.</para>
1096           </listitem>
1097         </varlistentry>
1098         <varlistentry>
1099           <term><command>delete <replaceable>PATTERN</replaceable>...</command></term>
1100
1101           <listitem>
1102             <para>Remove a snapshot previously created with
1103             <command>snapshot</command>.</para>
1104           </listitem>
1105         </varlistentry>
1106       </variablelist>
1107     </refsect2>
1108
1109     <refsect2>
1110       <title>Environment Commands</title>
1111
1112       <variablelist>
1113         <varlistentry>
1114           <term><command>show-environment</command></term>
1115
1116           <listitem>
1117             <para>Dump the systemd manager environment block. The
1118             environment block will be dumped in straight-forward form
1119             suitable for sourcing into a shell script. This environment
1120             block will be passed to all processes the manager
1121             spawns.</para>
1122           </listitem>
1123         </varlistentry>
1124         <varlistentry>
1125           <term><command>set-environment <replaceable>VARIABLE=VALUE</replaceable>...</command></term>
1126
1127           <listitem>
1128             <para>Set one or more systemd manager environment variables,
1129             as specified on the command line.</para>
1130           </listitem>
1131         </varlistentry>
1132         <varlistentry>
1133           <term><command>unset-environment <replaceable>VARIABLE</replaceable>...</command></term>
1134
1135           <listitem>
1136             <para>Unset one or more systemd manager environment
1137             variables. If only a variable name is specified, it will be
1138             removed regardless of its value. If a variable and a value
1139             are specified, the variable is only removed if it has the
1140             specified value.</para>
1141           </listitem>
1142         </varlistentry>
1143         <varlistentry>
1144           <term><command>import-environment <replaceable>VARIABLE</replaceable>...</command></term>
1145
1146           <listitem>
1147             <para>Import all, one or more environment variables set on
1148             the client into the systemd manager environment block. If
1149             no arguments are passed, the entire environment block is
1150             imported. Otherwise, a list of one or more environment
1151             variable names should be passed, whose client-side values
1152             are then imported into the manager's environment
1153             block.</para>
1154           </listitem>
1155         </varlistentry>
1156       </variablelist>
1157     </refsect2>
1158
1159     <refsect2>
1160       <title>Manager Lifecycle Commands</title>
1161
1162       <variablelist>
1163         <varlistentry>
1164           <term><command>daemon-reload</command></term>
1165
1166           <listitem>
1167             <para>Reload systemd manager configuration. This will reload
1168             all unit files and recreate the entire dependency
1169             tree. While the daemon is being reloaded, all sockets systemd
1170             listens on on behalf of user configuration will stay
1171             accessible.</para> <para>This command should not be confused
1172             with the <command>load</command> or
1173             <command>reload</command> commands.</para>
1174           </listitem>
1175         </varlistentry>
1176         <varlistentry>
1177           <term><command>daemon-reexec</command></term>
1178
1179           <listitem>
1180             <para>Reexecute the systemd manager. This will serialize the
1181             manager state, reexecute the process and deserialize the
1182             state again. This command is of little use except for
1183             debugging and package upgrades. Sometimes, it might be
1184             helpful as a heavy-weight <command>daemon-reload</command>.
1185             While the daemon is being reexecuted, all sockets systemd listening
1186             on behalf of user configuration will stay accessible.
1187             </para>
1188           </listitem>
1189         </varlistentry>
1190       </variablelist>
1191     </refsect2>
1192
1193     <refsect2>
1194       <title>System Commands</title>
1195
1196       <variablelist>
1197         <varlistentry>
1198           <term><command>default</command></term>
1199
1200           <listitem>
1201             <para>Enter default mode. This is mostly equivalent to
1202             <command>isolate default.target</command>.</para>
1203           </listitem>
1204         </varlistentry>
1205         <varlistentry>
1206           <term><command>rescue</command></term>
1207
1208           <listitem>
1209             <para>Enter rescue mode. This is mostly equivalent to
1210             <command>isolate rescue.target</command>, but also prints a
1211             wall message to all users.</para>
1212           </listitem>
1213         </varlistentry>
1214         <varlistentry>
1215           <term><command>emergency</command></term>
1216
1217           <listitem>
1218             <para>Enter emergency mode. This is mostly equivalent to
1219             <command>isolate emergency.target</command>, but also prints
1220             a wall message to all users.</para>
1221           </listitem>
1222         </varlistentry>
1223         <varlistentry>
1224           <term><command>halt</command></term>
1225
1226           <listitem>
1227             <para>Shut down and halt the system. This is mostly equivalent to
1228             <command>start halt.target --irreversible</command>, but also
1229             prints a wall message to all users.  If combined with
1230             <option>--force</option>, shutdown of all running services is
1231             skipped, however all processes are killed and all file
1232             systems are unmounted or mounted read-only, immediately
1233             followed by the system halt.  If <option>--force</option> is
1234             specified twice, the operation is immediately executed
1235             without terminating any processes or unmounting any file
1236             systems. This may result in data loss.</para>
1237           </listitem>
1238         </varlistentry>
1239         <varlistentry>
1240           <term><command>poweroff</command></term>
1241
1242           <listitem>
1243             <para>Shut down and power-off the system. This is mostly
1244             equivalent to <command>start poweroff.target --irreversible</command>,
1245             but also prints a wall message to all users. If combined with
1246             <option>--force</option>, shutdown of all running services is
1247             skipped, however all processes are killed and all file
1248             systems are unmounted or mounted read-only, immediately
1249             followed by the powering off. If <option>--force</option> is
1250             specified twice, the operation is immediately executed
1251             without terminating any processes or unmounting any file
1252             systems. This may result in data loss.</para>
1253           </listitem>
1254         </varlistentry>
1255         <varlistentry>
1256           <term><command>reboot <optional><replaceable>arg</replaceable></optional></command></term>
1257
1258           <listitem>
1259             <para>Shut down and reboot the system. This is mostly
1260             equivalent to <command>start reboot.target --irreversible</command>,
1261             but also prints a wall message to all users. If combined with
1262             <option>--force</option>, shutdown of all running services is
1263             skipped, however all processes are killed and all file
1264             systems are unmounted or mounted read-only, immediately
1265             followed by the reboot. If <option>--force</option> is
1266             specified twice, the operation is immediately executed
1267             without terminating any processes or unmounting any file
1268             systems. This may result in data loss.</para>
1269
1270             <para>If the optional argument
1271             <replaceable>arg</replaceable> is given, it will be passed
1272             as the optional argument to the
1273             <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1274             system call. The value is architecture and firmware
1275             specific. As an example, <literal>recovery</literal> might
1276             be used to trigger system recovery, and
1277             <literal>fota</literal> might be used to trigger a
1278             <quote>firmware over the air</quote> update.</para>
1279           </listitem>
1280         </varlistentry>
1281         <varlistentry>
1282           <term><command>kexec</command></term>
1283
1284           <listitem>
1285             <para>Shut down and reboot the system via kexec. This is
1286             mostly equivalent to <command>start kexec.target --irreversible</command>,
1287             but also prints a wall message to all users. If combined
1288             with <option>--force</option>, shutdown of all running
1289             services is skipped, however all processes are killed and
1290             all file systems are unmounted or mounted read-only,
1291             immediately followed by the reboot.</para>
1292           </listitem>
1293         </varlistentry>
1294         <varlistentry>
1295           <term><command>exit</command></term>
1296
1297           <listitem>
1298             <para>Ask the systemd manager to quit. This is only
1299             supported for user service managers (i.e. in conjunction
1300             with the <option>--user</option> option) and will fail
1301             otherwise.</para>
1302           </listitem>
1303
1304         </varlistentry>
1305         <varlistentry>
1306           <term><command>suspend</command></term>
1307
1308           <listitem>
1309             <para>Suspend the system. This will trigger activation of
1310             the special <filename>suspend.target</filename> target.
1311             </para>
1312           </listitem>
1313         </varlistentry>
1314         <varlistentry>
1315           <term><command>hibernate</command></term>
1316
1317           <listitem>
1318             <para>Hibernate the system. This will trigger activation of
1319             the special <filename>hibernate.target</filename> target.
1320             </para>
1321           </listitem>
1322         </varlistentry>
1323         <varlistentry>
1324           <term><command>hybrid-sleep</command></term>
1325
1326           <listitem>
1327             <para>Hibernate and suspend the system. This will trigger
1328             activation of the special
1329             <filename>hybrid-sleep.target</filename> target.</para>
1330           </listitem>
1331         </varlistentry>
1332         <varlistentry>
1333           <term><command>switch-root <replaceable>ROOT</replaceable> <optional><replaceable>INIT</replaceable></optional></command></term>
1334
1335           <listitem>
1336             <para>Switches to a different root directory and executes a
1337             new system manager process below it. This is intended for
1338             usage in initial RAM disks ("initrd"), and will transition
1339             from the initrd's system manager process (a.k.a "init"
1340             process) to the main system manager process. This call takes two
1341             arguments: the directory that is to become the new root directory, and
1342             the path to the new system manager binary below it to
1343             execute as PID 1. If the latter is omitted or the empty
1344             string, a systemd binary will automatically be searched for
1345             and used as init. If the system manager path is omitted or
1346             equal to the empty string, the state of the initrd's system
1347             manager process is passed to the main system manager, which
1348             allows later introspection of the state of the services
1349             involved in the initrd boot.</para>
1350           </listitem>
1351         </varlistentry>
1352       </variablelist>
1353     </refsect2>
1354
1355     <refsect2>
1356       <title>Parameter Syntax</title>
1357
1358       <para>Unit ommands listed above take either a single unit name
1359       (designated as <replaceable>NAME</replaceable>), or multiple
1360       unit specifications (designated as
1361       <replaceable>PATTERN</replaceable>...). In the first case, the
1362       unit name with or without a suffix must be given. If the suffix
1363       is not specified, systemctl will append a suitable suffix,
1364       <literal>.service</literal> by default, and a type-specific
1365       suffix in case of commands which operate only on specific unit
1366       types. For example,
1367       <programlisting># systemctl start sshd</programlisting> and
1368       <programlisting># systemctl start sshd.service</programlisting>
1369       are equivalent, as are
1370       <programlisting># systemctl isolate snapshot-11</programlisting>
1371       and
1372       <programlisting># systemctl isolate snapshot-11.snapshot</programlisting>
1373       Note that (absolute) paths to device nodes are automatically
1374       converted to device unit names, and other (absolute) paths to
1375       mount unit names.
1376       <programlisting># systemctl status /dev/sda
1377 # systemctl status /home</programlisting>
1378       are equivalent to:
1379       <programlisting># systemctl status dev-sda.device
1380 # systemctl status home.mount</programlisting>
1381       In the second case, shell-style globs will be matched against
1382       currently loaded units; literal unit names, with or without
1383       a suffix, will be treated as in the first case. This means that
1384       literal unit names always refer to exactly one unit, but globs
1385       may match zero units and this is not considered an error.</para>
1386
1387       <para>Glob patterns use
1388       <citerefentry><refentrytitle>fnmatch</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1389       so normal shell-style globbing rules are used, and
1390       <literal>*</literal>, <literal>?</literal>,
1391       <literal>[]</literal> may be used. See
1392       <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1393       for more details. The patterns are matched against the names of
1394       currently loaded units, and patterns which do not match anything
1395       are silently skipped. For example:
1396       <programlisting># systemctl stop sshd@*.service</programlisting>
1397       will stop all <filename>sshd@.service</filename> instances.
1398       </para>
1399
1400       <para>For unit file commands, the specified
1401       <replaceable>NAME</replaceable> should be the full name of the
1402       unit file, or the absolute path to the unit file:
1403       <programlisting># systemctl enable foo.service</programlisting>
1404       or
1405       <programlisting># systemctl link /path/to/foo.service</programlisting>
1406       </para>
1407     </refsect2>
1408
1409   </refsect1>
1410
1411   <refsect1>
1412     <title>Exit status</title>
1413
1414     <para>On success, 0 is returned, a non-zero failure
1415     code otherwise.</para>
1416   </refsect1>
1417
1418   <xi:include href="less-variables.xml" />
1419
1420   <refsect1>
1421     <title>See Also</title>
1422     <para>
1423       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1424       <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1425       <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1426       <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1427       <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1428       <citerefentry><refentrytitle>systemd.resource-management</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1429       <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1430       <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1431       <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1432       <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1433     </para>
1434   </refsect1>
1435
1436 </refentry>