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           xmlns:xi="http://www.w3.org/2001/XInclude">
  26
  27   <refentryinfo>
  28     <title>systemd-run</title>
  29     <productname>systemd</productname>
  30
  31     <authorgroup>
  32       <author>
  33         <contrib>Developer</contrib>
  34         <firstname>Lennart</firstname>
  35         <surname>Poettering</surname>
  36         <email>lennart@poettering.net</email>
  37       </author>
  38     </authorgroup>
  39   </refentryinfo>
  40
  41   <refmeta>
  42     <refentrytitle>systemd-run</refentrytitle>
  43     <manvolnum>1</manvolnum>
  44   </refmeta>
  45
  46   <refnamediv>
  47     <refname>systemd-run</refname>
  48     <refpurpose>Run programs in transient scope or service units</refpurpose>
  49   </refnamediv>
  50
  51   <refsynopsisdiv>
  52     <cmdsynopsis>
  53       <command>systemd-run</command>
  54       <arg choice="opt" rep="repeat">OPTIONS</arg>
  55       <arg choice="plain"><replaceable>COMMAND</replaceable>
  56       <arg choice="opt" rep="repeat">ARGS</arg>
  57       </arg>
  58     </cmdsynopsis>
  59   </refsynopsisdiv>
  60
  61   <refsect1>
  62     <title>Description</title>
  63
  64     <para><command>systemd-run</command> may be used to create and start
  65     a transient <filename>.service</filename> or a
  66     <filename>.scope</filename> unit and run the specified
  67     <replaceable>COMMAND</replaceable> in it.</para>
  68
  69     <para>If a command is run as transient service unit, it will be
  70     started and managed by the service manager like any other service,
  71     and thus show up in the output of <command>systemctl
  72     list-units</command> like any other unit. It will run in a clean
  73     and detached execution environment. <command>systemd-run</command>
  74     will start the service asynchronously in the background and
  75     immediately return.</para>
  76
  77     <para>If a command is run as transient scope unit, it will be
  78     started directly by <command>systemd-run</command> and thus
  79     inherit the execution environment of the caller. It is however
  80     managed by the service manager similar to normal services, and
  81     will also show up in the output of <command>systemctl
  82     list-units</command>. Execution in this case is synchronous, and
  83     execution will return only when the command finishes.</para>
  84   </refsect1>
  85
  86   <refsect1>
  87     <title>Options</title>
  88
  89     <para>The following options are understood:</para>
  90
  91     <variablelist>
  92       <varlistentry>
  93               <term><option>-H</option></term>
  94               <term><option>--host=</option></term>
  95
  96               <listitem><para>Execute the operation
  97               remotely. Specify a hostname, or
  98               username and hostname separated by <literal>@</literal>,
  99               to connect to. This will use SSH to
 100               talk to the remote machine manager
 101               instance.</para></listitem>
 102       </varlistentry>
 103
 104       <varlistentry>
 105               <term><option>-M</option></term>
 106               <term><option>--machine=</option></term>
 107
 108               <listitem><para>Execute the operation on a
 109               local container. Specify a container
 110               name to connect to.</para></listitem>
 111       </varlistentry>
 112
 113       <varlistentry>
 114         <term><option>--scope</option></term>
 115
 116         <listitem>
 117           <para>Create a transient <filename>.scope</filename> unit instead of
 118           the default transient <filename>.service</filename> unit.
 119           </para>
 120         </listitem>
 121       </varlistentry>
 122
 123       <varlistentry>
 124         <term><option>--unit=</option></term>
 125
 126         <listitem><para>Use this unit name instead of an automatically
 127         generated one.</para></listitem>
 128       </varlistentry>
 129
 130       <varlistentry>
 131         <term><option>--description=</option></term>
 132
 133         <listitem><para>Provide description for the unit. If not
 134         specified, the command itself will be used as a description.
 135         See <varname>Description=</varname> in
 136         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 137         </para></listitem>
 138       </varlistentry>
 139
 140       <varlistentry>
 141         <term><option>--slice=</option></term>
 142
 143         <listitem><para>Make the new <filename>.service</filename> or
 144         <filename>.scope</filename> unit part of the specified slice,
 145         instead of the <filename>system.slice</filename>.</para>
 146         </listitem>
 147       </varlistentry>
 148
 149       <varlistentry>
 150         <term><option>--remain-after-exit</option></term>
 151
 152         <listitem><para>After the service's process has terminated, keep
 153         the service around until it is explicitly stopped. This is
 154         useful to collect runtime information about the service after
 155         it finished running. Also see
 156         <varname>RemainAfterExit=</varname> in
 157         <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 158         </para>
 159         </listitem>
 160       </varlistentry>
 161
 162       <varlistentry>
 163         <term><option>--send-sighup</option></term>
 164
 165         <listitem><para>When terminating the scope unit, send a SIGHUP
 166         immediately after SIGTERM. This is useful to indicate to
 167         shells and shell-like processes that the connection has been
 168         severed. Also see <varname>SendSIGHUP=</varname> in
 169         <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 170         </para>
 171         </listitem>
 172       </varlistentry>
 173
 174       <xi:include href="user-system-options.xml" xpointer="user" />
 175       <xi:include href="user-system-options.xml" xpointer="system" />
 176
 177       <xi:include href="standard-options.xml" xpointer="help" />
 178       <xi:include href="standard-options.xml" xpointer="version" />
 179     </variablelist>
 180
 181     <para>All command-line arguments after the first non-option
 182     argument become part of the commandline of the launched
 183     process. If a command is run as service unit, its first argument
 184     needs to be an absolute binary path.</para>
 185   </refsect1>
 186
 187   <refsect1>
 188     <title>Exit status</title>
 189
 190     <para>On success, 0 is returned, a non-zero failure
 191     code otherwise.</para>
 192   </refsect1>
 193
 194   <refsect1>
 195     <title>Example</title>
 196
 197     <para>The following command will log the environment variables
 198     provided by systemd to services:</para>
 199
 200     <programlisting># systemd-run env
 201 Running as unit run-19945.service.
 202 # journalctl -u run-19945.service
 203 Sep 08 07:37:21 bupkis systemd[1]: Starting /usr/bin/env...
 204 Sep 08 07:37:21 bupkis systemd[1]: Started /usr/bin/env.
 205 Sep 08 07:37:21 bupkis env[19948]: PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin
 206 Sep 08 07:37:21 bupkis env[19948]: LANG=en_US.UTF-8
 207 Sep 08 07:37:21 bupkis env[19948]: BOOT_IMAGE=/vmlinuz-3.11.0-0.rc5.git6.2.fc20.x86_64</programlisting>
 208   </refsect1>
 209
 210   <refsect1>
 211     <title>See Also</title>
 212     <para>
 213       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 214       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 215       <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 216       <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 217       <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 218       <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 219       <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 220     </para>
 221   </refsect1>
 222
 223 </refentry>