man/systemd-run.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 2013 Zbigniew Jędrzejewski-Szmek
   9
  10 systemd is free software; you can redistribute it and/or modify it
  11 under the terms of the GNU Lesser General Public License as published by
  12 the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  19
  20 You should have received a copy of the GNU Lesser General Public License
  21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="systemd-run">
  25
  26   <refentryinfo>
  27     <title>systemd-run</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-run</refentrytitle>
  42     <manvolnum>1</manvolnum>
  43   </refmeta>
  44
  45   <refnamediv>
  46     <refname>systemd-run</refname>
  47     <refpurpose>Run programs in transient scope or service units</refpurpose>
  48   </refnamediv>
  49
  50   <refsynopsisdiv>
  51     <cmdsynopsis>
  52       <command>systemd-run</command>
  53       <arg choice="opt" rep="repeat">OPTIONS</arg>
  54       <arg choice="plain"><replaceable>COMMAND</replaceable>
  55       <arg choice="opt" rep="repeat">ARGS</arg>
  56       </arg>
  57     </cmdsynopsis>
  58   </refsynopsisdiv>
  59
  60   <refsect1>
  61     <title>Description</title>
  62
  63     <para><command>systemd-run</command> may be used create and start
  64     a transient <filename>.service</filename> or a
  65     <filename>.scope</filename> unit and run the specified
  66     <replaceable>COMMAND</replaceable> in it.</para>
  67
  68     <para>If a command is run as transient service unit, it will be
  69     started and managed by the service manager like any other service,
  70     and thus show up in the output of <command>systemctl
  71     list-units</command> like any other unit. It will run in a clean
  72     and detached execution environment. <command>systemd-run</command>
  73     will start the service asynchronously in the background and
  74     immediately return.</para>
  75
  76     <para>If a command is run as transient scope unit, it will be
  77     started directly by <command>systemd-run</command> and thus
  78     inherit the execution environment of the caller. It is however
  79     managed by the service manager similar to normal services, and
  80     will also show up in the output of <command>systemctl
  81     list-units</command>. Execution in this case is synchronous, and
  82     execution will return only when the command finishes.</para>
  83   </refsect1>
  84
  85   <refsect1>
  86     <title>Options</title>
  87
  88     <para>The following options are understood:</para>
  89
  90     <variablelist>
  91       <varlistentry>
  92         <term><option>-h</option></term>
  93         <term><option>--help</option></term>
  94
  95         <listitem><para>Prints a short help
  96         text and exits.</para></listitem>
  97       </varlistentry>
  98
  99       <varlistentry>
 100         <term><option>--version</option></term>
 101
 102         <listitem><para>Prints a short version
 103         string and exits.</para></listitem>
 104       </varlistentry>
 105
 106       <varlistentry>
 107         <term><option>--user</option></term>
 108
 109         <listitem>
 110           <para>Talk to the service manager of the calling user,
 111           rather than the service manager of the system.</para>
 112         </listitem>
 113       </varlistentry>
 114
 115       <varlistentry>
 116         <term><option>--scope</option></term>
 117
 118         <listitem>
 119           <para>Create a transient <filename>.scope</filename> unit instead of
 120           the default transient <filename>.service</filename> unit.
 121           </para>
 122         </listitem>
 123       </varlistentry>
 124
 125       <varlistentry>
 126         <term><option>--unit=</option></term>
 127
 128         <listitem><para>Use this unit name instead of an automatically
 129         generated one.</para></listitem>
 130       </varlistentry>
 131
 132       <varlistentry>
 133         <term><option>--description=</option></term>
 134
 135         <listitem><para>Provide description for the unit. If not
 136         specified, the command itself will be used as a description.
 137         See <varname>Description=</varname> in
 138         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 139         </para></listitem>
 140       </varlistentry>
 141
 142       <varlistentry>
 143         <term><option>--slice=</option></term>
 144
 145         <listitem><para>Make the new <filename>.service</filename> or
 146         <filename>.scope</filename> unit part of the specified slice,
 147         instead of the <filename>system.slice</filename>.</para>
 148         </listitem>
 149       </varlistentry>
 150
 151       <varlistentry>
 152         <term><option>--remain-after-exit</option></term>
 153
 154         <listitem><para>After the service's process has terminated, keep
 155         the service around until it is explicitly stopped. This is
 156         useful to collect runtime information about the service after
 157         it finished running. Also see
 158         <varname>RemainAfterExit=</varname> in
 159         <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 160         </para>
 161         </listitem>
 162       </varlistentry>
 163
 164       <varlistentry>
 165         <term><option>--send-sighup</option></term>
 166
 167         <listitem><para>When terminating the scope unit, send a SIGHUP
 168         immediately after SIGTERM. This is useful to indicate to
 169         shells and shell-like processes that the connection has been
 170         severed. Also see <varname>SendSIGHUP=</varname> in
 171         <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 172         </para>
 173         </listitem>
 174       </varlistentry>
 175     </variablelist>
 176
 177     <para>All command-line arguments after the first non-option
 178     argument become part of the commandline of the launched
 179     process. If a command is run as service unit, its first argument
 180     needs to be an absolute binary path.</para>
 181   </refsect1>
 182
 183   <refsect1>
 184     <title>Exit status</title>
 185
 186     <para>On success, 0 is returned, a non-zero failure
 187     code otherwise.</para>
 188   </refsect1>
 189
 190   <refsect1>
 191     <title>Example</title>
 192
 193     <para>The following command will log the environment variables
 194     provided by systemd to services:</para>
 195
 196     <programlisting># systemd-run env
 197 Running as unit run-19945.service.
 198 # journalctl -u run-19945.service
 199 Sep 08 07:37:21 bupkis systemd[1]: Starting /usr/bin/env...
 200 Sep 08 07:37:21 bupkis systemd[1]: Started /usr/bin/env.
 201 Sep 08 07:37:21 bupkis env[19948]: PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin
 202 Sep 08 07:37:21 bupkis env[19948]: LANG=en_US.UTF-8
 203 Sep 08 07:37:21 bupkis env[19948]: BOOT_IMAGE=/vmlinuz-3.11.0-0.rc5.git6.2.fc20.x86_64
 204     </programlisting>
 205   </refsect1>
 206
 207   <refsect1>
 208     <title>See Also</title>
 209     <para>
 210       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 211       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 212       <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 213       <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 214       <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 215       <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 216     </para>
 217   </refsect1>
 218
 219 </refentry>