1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
|
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of systemd.
Copyright 2010 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="systemd-install">
<refentryinfo>
<title>systemd-install</title>
<productname>systemd</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Lennart</firstname>
<surname>Poettering</surname>
<email>lennart@poettering.net</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>systemd-install</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd-install</refname>
<refpurpose>Enable or disable a systemd unit
definition file</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>systemd-install <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="plain">enable</arg> <arg choice="opt" rep="repeat">NAME</arg></command>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-install <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="plain">disable</arg> <arg choice="opt" rep="repeat">NAME</arg></command>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-install <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="plain">realize</arg> <arg choice="opt" rep="repeat">NAME</arg></command>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-install <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="plain">test</arg> <arg choice="opt" rep="repeat">NAME</arg></command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><command>systemd-install</command> enables or
disables systemd units, or checks whether they are
enabled, according to the installation suggestions
included in the unit files.</para>
<para>This command is useful to apply or undo the
installation instructions encoded in the <literal>[Install]</literal>
section of unit files. See
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for more information.</para>
<para>Enabling units (as with <command>systemd-install
enable</command>) should not be confused with
activating units (as with <command>systemctl
start</command>). The former simply installs the unit
files in the configuration tree, but does not start
them. The latter equals starting them, but does not
necessarily require them to be enabled.</para>
<para>Note that while
<command>systemd-install</command> is the recommended
tool to create or remove symlinks in the systemd
configuration directory the administrator can also
create links there manually, which is particularly
useful to use configurations that deviate from the
installation suggestions included in the unit
files.</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>--help</option></term>
<listitem><para>Prints a short help
text and exits.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--force</option></term>
<listitem><para>Enable/disable a
service even if it conflicts
with/contradicts another service. This
might have the effect of disabling
another service that was
enabled.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--system</option></term>
<listitem><para>Enable/disable a
system service.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--session</option></term>
<listitem><para>Enable/disable a
session service for the calling
user.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--global</option></term>
<listitem><para>Enable/disable a
session service for all
users.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--realize[=MODE]</option></term>
<listitem><para>After
enabling/disabling stop/restart/stop
the unit and reload manager
configuration. Optionally, takes one
of <option>no</option>,
<option>reload</option>,
<option>minimal</option>,
<option>maybe</option> or
<option>yes</option>. If
<option>no</option> is passed the
manager will not reload its
configuration and no service will be
started or stopped after
enabling/disabling of the unit
files. If <option>reload</option> is
passed the daemon configuration is
reloaded but the unit otherwise not
started/stopped/restarted. If
<option>minimal</option> is passed and
a unit is being enabled it will also
be restarted should it already be
running. If a unit is being disabled
it will be stopped should it be
running. In either case the daemon
configuration is
reloaded. <option>maybe</option> is
similar to this, but the unit will
also be started if it is being enabled
and any of the units listed in
<varname>WantedBy=</varname> in the
<literal>[Install]</literal> section
of the unit file is already
activated. Finally
<option>yes</option> starts the unit
unconditionally after enabling. This
setting defaults to
<option>no</option>. If
<option>--realize</option> is
specifieed but the mode value is
omitted defaults to
<option>minimal</option>. This option
has no effect when
<option>--global</option> or
<command>test</command> is used, or
when systemd is not running or the
command is executed in a
<citerefentry><refentrytitle>chroot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
environment. This option is implied if
the <command>realize</command> command
is used.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--all</option></term>
<listitem><para>If set makes sure that
all symlinks on the specified unit are
removed from the configuration
directory and its subdirectories, not
just those specified in the
<literal>[Install]</literal>
section.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--verbose</option></term>
<term><option>-v</option></term>
<listitem><para>Show what is done as
it is done.</para></listitem>
</varlistentry>
</variablelist>
<para>The following commands are understood:</para>
<variablelist>
<varlistentry>
<term><command>enable</command></term>
<listitem><para>Enable one or more
units. This will create a number of
symlinks as encoded in the
<literal>[Install]</literal> section
of a unit file.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>disable</command></term>
<listitem><para>Disable or more
units. This will remove a number of
symlinks as encoded in the
<literal>[Install]</literal> section
of a unit file.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>realize</command></term>
<listitem><para>Does not enable or
disable any unit. Checks whether any
of the units specified are enabled,
and then starts/stops/restarts the
units accordingly. This will check for
the existence of a number of symlinks
as encoded in the
<literal>[Install]</literal> section
of a unit file, and then executes the
action normally specified by
<option>--realize</option>. If
<option>--realize</option> is not
specified implies
<option>minimal</option> mode. To
override this mode specify
<option>--realize=</option> in
addition to
<command>realize</command>.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>test</command></term>
<listitem><para>Does not enable or
disable any unit. Checks whether any
of the units specified are
enabled. This will check for the
existence of a number of symlinks as
encoded in the
<literal>[Install]</literal> section
of a unit file, and return with an
exit code of 0 if a unit is enabled, 1
otherwise.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Exit status</title>
<para>On success 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>
|
