chiark / gitweb /
doc: reword "shared per-thread" wording
[elogind.git] / man / systemd-run.xml
index 707d88d76699623224f34441ee81729b771e52e2..4b67b7b5cadcf90a678d585940ea38550db37043 100644 (file)
@@ -60,7 +60,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
   <refsect1>
     <title>Description</title>
 
-    <para><command>systemd-run</command> may be used create and start
+    <para><command>systemd-run</command> may be used to create and start
     a transient <filename>.service</filename> or a
     <filename>.scope</filename> unit and run the specified
     <replaceable>COMMAND</replaceable> in it.</para>
@@ -112,6 +112,36 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         </listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><option>--system</option></term>
+
+        <listitem>
+          <para>Talk to the service manager of the system. This is the
+          implied default.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+              <term><option>-H</option></term>
+              <term><option>--host=</option></term>
+
+              <listitem><para>Execute the operation
+              remotely. Specify a hostname, or
+              username and hostname separated by <literal>@</literal>,
+              to connect to. This will use SSH to
+              talk to the remote machine manager
+              instance.</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+              <term><option>-M</option></term>
+              <term><option>--machine=</option></term>
+
+              <listitem><para>Execute the operation on a
+              local container. Specify a container
+              name to connect to.</para></listitem>
+      </varlistentry>
+
       <varlistentry>
         <term><option>--scope</option></term>
 
@@ -151,7 +181,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       <varlistentry>
         <term><option>--remain-after-exit</option></term>
 
-        <listitem><para>After the service's process terminated keep
+        <listitem><para>After the service's process has terminated, keep
         the service around until it is explicitly stopped. This is
         useful to collect runtime information about the service after
         it finished running. Also see
@@ -160,6 +190,18 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         </para>
         </listitem>
       </varlistentry>
+
+      <varlistentry>
+        <term><option>--send-sighup</option></term>
+
+        <listitem><para>When terminating the scope unit, send a SIGHUP
+        immediately after SIGTERM. This is useful to indicate to
+        shells and shell-like processes that the connection has been
+        severed. Also see <varname>SendSIGHUP=</varname> in
+        <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+        </para>
+        </listitem>
+      </varlistentry>
     </variablelist>
 
     <para>All command-line arguments after the first non-option
@@ -175,6 +217,22 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     code otherwise.</para>
   </refsect1>
 
+  <refsect1>
+    <title>Example</title>
+
+    <para>The following command will log the environment variables
+    provided by systemd to services:</para>
+
+    <programlisting># systemd-run env
+Running as unit run-19945.service.
+# journalctl -u run-19945.service
+Sep 08 07:37:21 bupkis systemd[1]: Starting /usr/bin/env...
+Sep 08 07:37:21 bupkis systemd[1]: Started /usr/bin/env.
+Sep 08 07:37:21 bupkis env[19948]: PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin
+Sep 08 07:37:21 bupkis env[19948]: LANG=en_US.UTF-8
+Sep 08 07:37:21 bupkis env[19948]: BOOT_IMAGE=/vmlinuz-3.11.0-0.rc5.git6.2.fc20.x86_64</programlisting>
+  </refsect1>
+
   <refsect1>
     <title>See Also</title>
     <para>
@@ -183,7 +241,8 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+      <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
     </para>
   </refsect1>