busctl: add --timeout= option to specify method call timeout

[elogind.git] / man / busctl.xml

diff --git a/man/busctl.xml b/man/busctl.xml
index e9b758aed50110da97b14ad58ced776d09dea751..c47a329feaede438ae64cf00f3e09f078d7d0e70 100644 (file)
--- a/man/busctl.xml
+++ b/man/busctl.xml
@@ -156,12 +156,14 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <term><option>--quiet</option></term>
 
         <listitem>
-          <para>When used with the <command>call</command> command suppresses
-          display of the response message.</para>
+          <para>When used with the <command>call</command> command
+          suppresses display of the response message payload. Note that even
+          if this option is specified errors returned will still be
+          printed and the tool will indicate success or failure with
+          the process exit code.</para>
         </listitem>
       </varlistentry>
 
-
       <varlistentry>
         <term><option>--verbose</option></term>
 
@@ -172,6 +174,64 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         </listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><option>--expect-reply=</option><replaceable>BOOL</replaceable></term>
+
+        <listitem>
+          <para>When used with the <command>call</command> command
+          specifies whether <command>busctl</command> shall wait for
+          completion of the method call, output the returned method
+          response data, and return success or failure via the process
+          exit code. If this is set to <literal>no</literal> the
+          method call will be issued but no response is expected, the
+          tool terminates immediately, and thus no response can be
+          shown, and no success or failure is returned via the exit
+          code. To only suppress output of the reply message payload
+          use <option>--quiet</option> above. Defaults to
+          <literal>yes</literal>.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--auto-start=</option><replaceable>BOOL</replaceable></term>
+
+        <listitem>
+          <para>When used with the <command>call</command> command specifies
+          whether the method call should implicitly activate the
+          called service should it not be running yet but is
+          configured to be auto-started. Defaults to
+          <literal>yes</literal>.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--allow-interactive-authorization=</option><replaceable>BOOL</replaceable></term>
+
+        <listitem>
+          <para>When used with the <command>call</command> command
+          specifies whether the services may enforce interactive
+          authorization while executing the operation, if the security
+          policy is configured for this. Defaults to
+          <literal>yes</literal>.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--timeout=</option><replaceable>SECS</replaceable></term>
+
+        <listitem>
+          <para>When used with the <command>call</command> command
+          specifies the maximum time to wait for method call
+          completion. If no time unit is specified assumes
+          seconds. The usual other units are understood, too (ms, us,
+          s, min, h, d, w, month, y). Note that this timeout does not
+          apply if <option>--expect-reply=no</option> is used as the
+          tool does not wait for any reply message then. When not
+          specified or when set to 0 the default of
+          <literal>25s</literal> is assumed.</para>
+        </listitem>
+      </varlistentry>
+
       <xi:include href="user-system-options.xml" xpointer="user" />
       <xi:include href="user-system-options.xml" xpointer="system" />
       <xi:include href="user-system-options.xml" xpointer="host" />