man: add explanation about transient path or socket units in systemd-run

1 files changed, 40 insertions, 21 deletions

diff --git a/man/systemd-run.xml b/man/systemd-run.xml
index 7bcea9bc30..4f47ef8191 100644
--- a/man/systemd-run.xml
+++ b/man/systemd-run.xml
@@ -47,7 +47,7 @@
 
   <refnamediv>
     <refname>systemd-run</refname>
-    <refpurpose>Run programs in transient scope units, service units, or timer-scheduled service units</refpurpose>
+    <refpurpose>Run programs in transient scope units, service units, or path-, socket-, or timer-triggered service units</refpurpose>
   </refnamediv>
 
   <refsynopsisdiv>
@@ -61,6 +61,20 @@
     <cmdsynopsis>
       <command>systemd-run</command>
       <arg choice="opt" rep="repeat">OPTIONS</arg>
+      <arg choice="opt" rep="repeat">PATH OPTIONS</arg>
+      <arg choice="req"><replaceable>COMMAND</replaceable></arg>
+      <arg choice="opt" rep="repeat">ARGS</arg>
+    </cmdsynopsis>
+    <cmdsynopsis>
+      <command>systemd-run</command>
+      <arg choice="opt" rep="repeat">OPTIONS</arg>
+      <arg choice="opt" rep="repeat">SOCKET OPTIONS</arg>
+      <arg choice="req"><replaceable>COMMAND</replaceable></arg>
+      <arg choice="opt" rep="repeat">ARGS</arg>
+    </cmdsynopsis>
+    <cmdsynopsis>
+      <command>systemd-run</command>
+      <arg choice="opt" rep="repeat">OPTIONS</arg>
       <arg choice="opt" rep="repeat">TIMER OPTIONS</arg>
       <arg choice="req"><replaceable>COMMAND</replaceable></arg>
       <arg choice="opt" rep="repeat">ARGS</arg>
@@ -72,8 +86,8 @@
 
     <para><command>systemd-run</command> may be used to create and start a transient <filename>.service</filename> or
     <filename>.scope</filename> unit and run the specified <replaceable>COMMAND</replaceable> in it. It may also be
-    used to create and start a transient <filename>.timer</filename> unit, that activates a
-    <filename>.service</filename> unit when elapsing.</para>
+    used to create and start a transient <filename>.path</filename>, <filename>.socket</filename>, or
+    <filename>.timer</filename> unit, that activates a <filename>.service</filename> unit when elapsing.</para>
 
     <para>If a command is run as transient service unit, it will be started and managed by the service manager like any
     other service, and thus shows up in the output of <command>systemctl list-units</command> like any other unit. It
@@ -88,12 +102,13 @@
     list-units</command>. Execution in this case is synchronous, and will return only when the command finishes. This
     mode is enabled via the <option>--scope</option> switch (see below). </para>
 
-    <para>If a command is run with timer options such as <option>--on-calendar=</option> (see below), a transient timer
-    unit is created alongside the service unit for the specified command. Only the transient timer unit is started
-    immediately, the transient service unit will be started when the timer elapses. If the <option>--unit=</option>
-    option is specified, the <replaceable>COMMAND</replaceable> may be omitted. In this case,
-    <command>systemd-run</command> creates only a <filename>.timer</filename> unit that invokes the specified unit when
-    elapsing.</para>
+    <para>If a command is run with path, socket, or timer options such as <option>--on-calendar=</option> (see below),
+    a transient path, socket, or timer unit is created alongside the service unit for the specified command. Only the
+    transient path, socket, or timer unit is started immediately, the transient service unit will be triggered by the
+    path, socket, or timer unit. If the <option>--unit=</option> option is specified, the
+    <replaceable>COMMAND</replaceable> may be omitted. In this case, <command>systemd-run</command> creates only a
+    <filename>.path</filename>, <filename>.socket</filename>, or <filename>.timer</filename> unit that triggers the
+    specified unit.</para>
   </refsect1>
 
   <refsect1>
@@ -140,8 +155,8 @@
       <varlistentry>
         <term><option>--description=</option></term>
 
-        <listitem><para>Provide a description for the service, scope or timer unit. If not specified, the command
-        itself will be used as a description. See <varname>Description=</varname> in
+        <listitem><para>Provide a description for the service, scope, path, socket, or timer unit. If not specified,
+        the command itself will be used as a description. See <varname>Description=</varname> in
         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
         </para></listitem>
       </varlistentry>
@@ -278,7 +293,8 @@
         command. See <varname>OnActiveSec=</varname>, <varname>OnBootSec=</varname>, <varname>OnStartupSec=</varname>,
         <varname>OnUnitActiveSec=</varname> and <varname>OnUnitInactiveSec=</varname> in
         <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
-        details. These options may not be combined with <option>--scope</option> or <option>--pty</option>.</para>
+        details. These options are shortcuts for <command>--timer-property=</command> with the relevant properties.
+        These options may not be combined with <option>--scope</option> or <option>--pty</option>.</para>
         </listitem>
       </varlistentry>
 
@@ -287,20 +303,23 @@
 
         <listitem><para>Defines a calendar timer for starting the specified command. See <varname>OnCalendar=</varname>
         in <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>. This
-        option may not be combined with <option>--scope</option> or <option>--pty</option>.</para>
+        option is a shortcut for <command>--timer-property=OnCalendar=</command>. This option may not be combined with
+        <option>--scope</option> or <option>--pty</option>.</para>
         </listitem>
       </varlistentry>
 
       <varlistentry>
+        <term><option>--path-property=</option></term>
+        <term><option>--socket-property=</option></term>
         <term><option>--timer-property=</option></term>
 
-        <listitem><para>Sets a property on the timer unit that is created. This option is similar to
-        <option>--property=</option> but applies to the transient timer unit rather than the transient service unit
-        created. This option only has an effect in conjunction with <option>--on-active=</option>,
-        <option>--on-boot=</option>, <option>--on-startup=</option>, <option>--on-unit-active=</option>,
-        <option>--on-unit-inactive=</option> or <option>--on-calendar=</option>. This option takes an assignment in the
-        same format as <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
-        <command>set-property</command> command.</para> </listitem>
+        <listitem><para>Sets a property on the path, socket, or timer unit that is created. This option is similar to
+        <option>--property=</option> but applies to the transient path, socket, or timer unit rather than the
+        transient service unit created. This option takes an assignment in the same format as
+        <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
+        <command>set-property</command> command. These options may not be combined with
+        <option>--scope</option> or <option>--pty</option>.</para>
+        </listitem>
       </varlistentry>
 
       <varlistentry>
@@ -323,7 +342,7 @@
         completed). On exit, terse information about the unit's runtime is shown, including total runtime (as well as
         CPU usage, if <option>--property=CPUAccounting=1</option> was set) and the exit code and status of the main
         process. This output may be suppressed with <option>--quiet</option>. This option may not be combined with
-        <option>--no-block</option>, <option>--scope</option> or the various timer options.</para></listitem>
+        <option>--no-block</option>, <option>--scope</option> or the various path, socket, or timer options.</para></listitem>
       </varlistentry>
 
       <varlistentry>