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">
6 This file is part of systemd.
8 Copyright 2010 Lennart Poettering
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
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 General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
24 <refentry id="systemd-install">
27 <title>systemd-install</title>
28 <productname>systemd</productname>
32 <contrib>Developer</contrib>
33 <firstname>Lennart</firstname>
34 <surname>Poettering</surname>
35 <email>lennart@poettering.net</email>
41 <refentrytitle>systemd-install</refentrytitle>
42 <manvolnum>1</manvolnum>
46 <refname>systemd-install</refname>
47 <refpurpose>Enable or disable a systemd unit
48 definition file</refpurpose>
53 <command>systemd-install <arg choice="opt" rep="repeat">options</arg> <arg choice="plain">enable</arg> <arg choice="opt" rep="repeat">name</arg></command>
56 <command>systemd-install <arg choice="opt" rep="repeat">options</arg> <arg choice="plain">disable</arg> <arg choice="opt" rep="repeat">name</arg></command>
59 <command>systemd-install <arg choice="opt" rep="repeat">options</arg> <arg choice="plain">test</arg> <arg choice="opt" rep="repeat">name</arg></command>
64 <title>Description</title>
66 <para><command>systemd-install</command> enables or
67 disables systemd units, or checks whether they are
72 <title>Options</title>
74 <para>The following options are understood:</para>
78 <term><option>--help</option></term>
80 <listitem><para>Prints a short help
81 text and exits.</para></listitem>
85 <term><option>--force</option></term>
87 <listitem><para>Enable/disable a
88 service even if it conflicts
89 with/contradicts another service. This
90 might have the effect of disabling
91 another service that was
92 enabled.</para></listitem>
96 <term><option>--system</option></term>
98 <listitem><para>Enable/disable a
99 system service.</para></listitem>
103 <term><option>--session</option></term>
105 <listitem><para>Enable/disable a
106 session service for the calling
107 user.</para></listitem>
111 <term><option>--global</option></term>
113 <listitem><para>Enable/disable a
114 session service for all
115 users.</para></listitem>
119 <para>The following verbs are understood:</para>
123 <term><command>enable</command></term>
125 <listitem><para>Enable a unit. This
126 will create a number of symlinks as
127 encoded in the [Install] section of a
128 unit file.</para></listitem>
132 <term><command>disable</command></term>
134 <listitem><para>Disable a unit. This
135 will removed a number of symlinks as
136 encoded in the [Install] section of a
137 unit file.</para></listitem>
141 <term><command>test</command></term>
143 <listitem><para>Checks whether any of
144 the units specified are
145 installed. This will check for the
146 existance of a number of symlinks as
147 encoded in the [Install] section of a
148 unit file.</para></listitem>
155 <title>Exit status</title>
157 <para>On success 0 is returned, a non-zero failure
158 code otherwise.</para>
162 <title>See Also</title>
164 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
165 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>