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 as volatile systemd 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
  64     create a transient <filename>.service</filename> unit
  65     or a <filename>.scope</filename> unit and launch the
  66     specified <replaceable>COMMAND</replaceable> as part
  67     of this unit.</para>
  68   </refsect1>
  69
  70   <refsect1>
  71     <title>Options</title>
  72
  73     <para>The following options are understood:</para>
  74
  75     <variablelist>
  76       <varlistentry>
  77         <term><option>-h</option></term>
  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>--version</option></term>
  86
  87         <listitem><para>Prints a short version
  88         string and exits.</para></listitem>
  89       </varlistentry>
  90
  91       <varlistentry>
  92         <term><option>--user</option></term>
  93
  94         <listitem>
  95           <para>Talk to the systemd manager of the calling
  96           user.</para>
  97         </listitem>
  98       </varlistentry>
  99
 100       <varlistentry>
 101         <term><option>--scope</option></term>
 102
 103         <listitem>
 104           <para>Create a <filename>.scope</filename> unit instead of
 105           the default transient <filename>.service</filename> unit.
 106           </para>
 107         </listitem>
 108       </varlistentry>
 109
 110       <varlistentry>
 111         <term><option>--unit=</option></term>
 112
 113         <listitem><para>Use this unit name instead of an automatically
 114         generated one.</para></listitem>
 115       </varlistentry>
 116
 117       <varlistentry>
 118         <term><option>--description=</option></term>
 119
 120         <listitem><para>Provide description for the unit. If not
 121         specified, the command itself will be used as a description.
 122         See <varname>Description=</varname> in
 123         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 124         </para></listitem>
 125       </varlistentry>
 126
 127       <varlistentry>
 128         <term><option>--slice=</option></term>
 129
 130         <listitem><para>Make the new <filename>.service</filename> or
 131         <filename>.scope</filename> unit part of the specified slice,
 132         instead of the <filename>system.slice</filename>.</para>
 133         </listitem>
 134       </varlistentry>
 135     </variablelist>
 136
 137     <para>All command-line arguments after the first non-option
 138     argument become part of the commandline of the launched
 139     process.</para>
 140   </refsect1>
 141
 142   <refsect1>
 143     <title>Exit status</title>
 144
 145     <para>On success, 0 is returned, a non-zero failure
 146     code otherwise.</para>
 147   </refsect1>
 148
 149   <refsect1>
 150     <title>See Also</title>
 151     <para>
 152       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 153       <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 154       <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 155       <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 156       <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 157     </para>
 158   </refsect1>
 159
 160 </refentry>