summaryrefslogtreecommitdiff
path: root/man/systemd-install.xml
blob: 63832aa6b4eddfdfe4ef539ca63b7a7c7161f760 (plain)
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
<?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">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.</para>

                <para>This command is useful to apply or undo the
                installation instructions encoded in the [Install]
                section of unit files. See
                <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                for more information.</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>
                </variablelist>

                <para>The following commands are understood:</para>

                <variablelist>
                        <varlistentry>
                                <term><command>enable</command></term>

                                <listitem><para>Enable a unit. This
                                will create a number of symlinks as
                                encoded in the [Install] section of a
                                unit file.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>disable</command></term>

                                <listitem><para>Disable a unit. This
                                will removed a number of symlinks as
                                encoded in the [Install] section of a
                                unit file.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>test</command></term>

                                <listitem><para>Checks whether any of
                                the units specified are
                                installed. This will check for the
                                existence of a number of symlinks as
                                encoded in the [Install] section of a
                                unit file.</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>