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
  70                 <para>This command is useful to apply or undo the
  71                 installation instructions encoded in the [Install]
  72                 section of unit files. See
  73                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  74                 for more information.</para>
  75         </refsect1>
  76
  77         <refsect1>
  78                 <title>Options</title>
  79
  80                 <para>The following options are understood:</para>
  81
  82                 <variablelist>
  83                         <varlistentry>
  84                                 <term><option>--help</option></term>
  85
  86                                 <listitem><para>Prints a short help
  87                                 text and exits.</para></listitem>
  88                         </varlistentry>
  89
  90                         <varlistentry>
  91                                 <term><option>--force</option></term>
  92
  93                                 <listitem><para>Enable/disable a
  94                                 service even if it conflicts
  95                                 with/contradicts another service. This
  96                                 might have the effect of disabling
  97                                 another service that was
  98                                 enabled.</para></listitem>
  99                         </varlistentry>
 100
 101                         <varlistentry>
 102                                 <term><option>--system</option></term>
 103
 104                                 <listitem><para>Enable/disable a
 105                                 system service.</para></listitem>
 106                         </varlistentry>
 107
 108                         <varlistentry>
 109                                 <term><option>--session</option></term>
 110
 111                                 <listitem><para>Enable/disable a
 112                                 session service for the calling
 113                                 user.</para></listitem>
 114                         </varlistentry>
 115
 116                         <varlistentry>
 117                                 <term><option>--global</option></term>
 118
 119                                 <listitem><para>Enable/disable a
 120                                 session service for all
 121                                 users.</para></listitem>
 122                         </varlistentry>
 123                 </variablelist>
 124
 125                 <para>The following commands are understood:</para>
 126
 127                 <variablelist>
 128                         <varlistentry>
 129                                 <term><command>enable</command></term>
 130
 131                                 <listitem><para>Enable a unit. This
 132                                 will create a number of symlinks as
 133                                 encoded in the [Install] section of a
 134                                 unit file.</para></listitem>
 135                         </varlistentry>
 136
 137                         <varlistentry>
 138                                 <term><command>disable</command></term>
 139
 140                                 <listitem><para>Disable a unit. This
 141                                 will removed a number of symlinks as
 142                                 encoded in the [Install] section of a
 143                                 unit file.</para></listitem>
 144                         </varlistentry>
 145
 146                         <varlistentry>
 147                                 <term><command>test</command></term>
 148
 149                                 <listitem><para>Checks whether any of
 150                                 the units specified are
 151                                 installed. This will check for the
 152                                 existence of a number of symlinks as
 153                                 encoded in the [Install] section of a
 154                                 unit file.</para></listitem>
 155                         </varlistentry>
 156                 </variablelist>
 157
 158         </refsect1>
 159
 160         <refsect1>
 161                 <title>Exit status</title>
 162
 163                 <para>On success 0 is returned, a non-zero failure
 164                 code otherwise.</para>
 165         </refsect1>
 166
 167         <refsect1>
 168                 <title>See Also</title>
 169                 <para>
 170                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 171                         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 172                         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 173                 </para>
 174         </refsect1>
 175
 176 </refentry>