chiark / gitweb /
bb52230856f413bf4bdd5a4e105771e1354a86ea
[elogind.git] / man / systemd-install.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 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.
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   General Public License for more details.
19
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/>.
22 -->
23
24 <refentry id="systemd-install">
25
26         <refentryinfo>
27                 <title>systemd-install</title>
28                 <productname>systemd</productname>
29
30                 <authorgroup>
31                         <author>
32                                 <contrib>Developer</contrib>
33                                 <firstname>Lennart</firstname>
34                                 <surname>Poettering</surname>
35                                 <email>lennart@poettering.net</email>
36                         </author>
37                 </authorgroup>
38         </refentryinfo>
39
40         <refmeta>
41                 <refentrytitle>systemd-install</refentrytitle>
42                 <manvolnum>1</manvolnum>
43         </refmeta>
44
45         <refnamediv>
46                 <refname>systemd-install</refname>
47                 <refpurpose>Enable or disable a systemd unit
48                 definition file</refpurpose>
49         </refnamediv>
50
51         <refsynopsisdiv>
52                 <cmdsynopsis>
53                         <command>systemd-install <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="plain">enable</arg> <arg choice="opt" rep="repeat">NAME</arg></command>
54                 </cmdsynopsis>
55                 <cmdsynopsis>
56                         <command>systemd-install <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="plain">disable</arg> <arg choice="opt" rep="repeat">NAME</arg></command>
57                 </cmdsynopsis>
58                 <cmdsynopsis>
59                         <command>systemd-install <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="plain">test</arg> <arg choice="opt" rep="repeat">NAME</arg></command>
60                 </cmdsynopsis>
61         </refsynopsisdiv>
62
63         <refsect1>
64                 <title>Description</title>
65
66                 <para><command>systemd-install</command> enables or
67                 disables systemd units, or checks whether they are
68                 enabled.</para>
69         </refsect1>
70
71         <refsect1>
72                 <title>Options</title>
73
74                 <para>The following options are understood:</para>
75
76                 <variablelist>
77                         <varlistentry>
78                                 <term><option>--help</option></term>
79
80                                 <listitem><para>Prints a short help
81                                 text and exits.</para></listitem>
82                         </varlistentry>
83
84                         <varlistentry>
85                                 <term><option>--force</option></term>
86
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>
93                         </varlistentry>
94
95                         <varlistentry>
96                                 <term><option>--system</option></term>
97
98                                 <listitem><para>Enable/disable a
99                                 system service.</para></listitem>
100                         </varlistentry>
101
102                         <varlistentry>
103                                 <term><option>--session</option></term>
104
105                                 <listitem><para>Enable/disable a
106                                 session service for the calling
107                                 user.</para></listitem>
108                         </varlistentry>
109
110                         <varlistentry>
111                                 <term><option>--global</option></term>
112
113                                 <listitem><para>Enable/disable a
114                                 session service for all
115                                 users.</para></listitem>
116                         </varlistentry>
117                 </variablelist>
118
119                 <para>The following commands are understood:</para>
120
121                 <variablelist>
122                         <varlistentry>
123                                 <term><command>enable</command></term>
124
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>
129                         </varlistentry>
130
131                         <varlistentry>
132                                 <term><command>disable</command></term>
133
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>
138                         </varlistentry>
139
140                         <varlistentry>
141                                 <term><command>test</command></term>
142
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>
149                         </varlistentry>
150                 </variablelist>
151
152         </refsect1>
153
154         <refsect1>
155                 <title>Exit status</title>
156
157                 <para>On success 0 is returned, a non-zero failure
158                 code otherwise.</para>
159         </refsect1>
160
161         <refsect1>
162                 <title>See Also</title>
163                 <para>
164                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
165                         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
166                         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
167                 </para>
168         </refsect1>
169
170 </refentry>