chiark / gitweb /
man: fix typo
[elogind.git] / 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 to 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>-H</option></term>
117               <term><option>--host=</option></term>
118
119               <listitem><para>Execute operation
120               remotely. Specify a hostname, or
121               username and hostname separated by <literal>@</literal>,
122               to connect to. This will use SSH to
123               talk to the remote machine manager
124               instance.</para></listitem>
125       </varlistentry>
126
127       <varlistentry>
128               <term><option>-M</option></term>
129               <term><option>--machine=</option></term>
130
131               <listitem><para>Execute operation on a
132               local container. Specify a container
133               name to connect to.</para></listitem>
134       </varlistentry>
135
136       <varlistentry>
137         <term><option>--scope</option></term>
138
139         <listitem>
140           <para>Create a transient <filename>.scope</filename> unit instead of
141           the default transient <filename>.service</filename> unit.
142           </para>
143         </listitem>
144       </varlistentry>
145
146       <varlistentry>
147         <term><option>--unit=</option></term>
148
149         <listitem><para>Use this unit name instead of an automatically
150         generated one.</para></listitem>
151       </varlistentry>
152
153       <varlistentry>
154         <term><option>--description=</option></term>
155
156         <listitem><para>Provide description for the unit. If not
157         specified, the command itself will be used as a description.
158         See <varname>Description=</varname> in
159         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
160         </para></listitem>
161       </varlistentry>
162
163       <varlistentry>
164         <term><option>--slice=</option></term>
165
166         <listitem><para>Make the new <filename>.service</filename> or
167         <filename>.scope</filename> unit part of the specified slice,
168         instead of the <filename>system.slice</filename>.</para>
169         </listitem>
170       </varlistentry>
171
172       <varlistentry>
173         <term><option>--remain-after-exit</option></term>
174
175         <listitem><para>After the service's process has terminated, keep
176         the service around until it is explicitly stopped. This is
177         useful to collect runtime information about the service after
178         it finished running. Also see
179         <varname>RemainAfterExit=</varname> in
180         <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
181         </para>
182         </listitem>
183       </varlistentry>
184
185       <varlistentry>
186         <term><option>--send-sighup</option></term>
187
188         <listitem><para>When terminating the scope unit, send a SIGHUP
189         immediately after SIGTERM. This is useful to indicate to
190         shells and shell-like processes that the connection has been
191         severed. Also see <varname>SendSIGHUP=</varname> in
192         <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
193         </para>
194         </listitem>
195       </varlistentry>
196     </variablelist>
197
198     <para>All command-line arguments after the first non-option
199     argument become part of the commandline of the launched
200     process. If a command is run as service unit, its first argument
201     needs to be an absolute binary path.</para>
202   </refsect1>
203
204   <refsect1>
205     <title>Exit status</title>
206
207     <para>On success, 0 is returned, a non-zero failure
208     code otherwise.</para>
209   </refsect1>
210
211   <refsect1>
212     <title>Example</title>
213
214     <para>The following command will log the environment variables
215     provided by systemd to services:</para>
216
217     <programlisting># systemd-run env
218 Running as unit run-19945.service.
219 # journalctl -u run-19945.service
220 Sep 08 07:37:21 bupkis systemd[1]: Starting /usr/bin/env...
221 Sep 08 07:37:21 bupkis systemd[1]: Started /usr/bin/env.
222 Sep 08 07:37:21 bupkis env[19948]: PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin
223 Sep 08 07:37:21 bupkis env[19948]: LANG=en_US.UTF-8
224 Sep 08 07:37:21 bupkis env[19948]: BOOT_IMAGE=/vmlinuz-3.11.0-0.rc5.git6.2.fc20.x86_64
225     </programlisting>
226   </refsect1>
227
228   <refsect1>
229     <title>See Also</title>
230     <para>
231       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
232       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
233       <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
234       <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
235       <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
236       <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
237       <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
238     </para>
239   </refsect1>
240
241 </refentry>