<listitem><para>A Varlink service reference starting with the <literal>ssh-unix:</literal> string, followed
by an SSH host specification, followed by <literal>:</literal>, followed by an absolute
<constant>AF_UNIX</constant> socket path. (This requires OpenSSH 9.4 or newer on the server side,
- abstract namespace sockets are not supported.)</para></listitem>
+ and abstract namespace sockets are not supported.)</para></listitem>
<listitem><para>A Varlink service reference starting with the <literal>ssh-exec:</literal> string,
followed by an SSH host specification, followed by <literal>:</literal>, followed by a command line. In
<varlistentry>
<term><command>info</command> <replaceable>ADDRESS</replaceable></term>
- <listitem><para>Show brief information about the specified service, including vendor name and list of
+ <listitem><para>Shows brief information about the specified service, including vendor name and list of
implemented interfaces. Expects a service address in one of the formats described above.</para>
<xi:include href="version-info.xml" xpointer="v255"/></listitem>
<varlistentry>
<term><command>list-interfaces</command> <replaceable>ADDRESS</replaceable></term>
- <listitem><para>Show list of interfaces implemented by the specified service. Expects a service
+ <listitem><para>Shows a list of interfaces implemented by the specified service. Expects a service
address in one of the formats described above.</para>
<xi:include href="version-info.xml" xpointer="v255"/></listitem>
<varlistentry>
<term><command>list-methods</command> <replaceable>ADDRESS</replaceable> [<replaceable>INTERFACE…</replaceable>]</term>
- <listitem><para>Show list of methods implemented by the specified service. Expects a service address
+ <listitem><para>Shows a list of methods implemented by the specified service. Expects a service address
in one of the formats described above as well as one or more interface names. If no interface name is
specified, lists all methods of all interfaces implemented by the service, otherwise just the methods
in the specified interfaces.</para>
<varlistentry>
<term><command>introspect</command> <replaceable>ADDRESS</replaceable> [<replaceable>INTERFACE…</replaceable>]</term>
- <listitem><para>Show the interface definitions of the specified interfaces provided by the specified
+ <listitem><para>Shows the interface definitions of the specified interfaces provided by the specified
service. Expects a service address in one of the formats described above and optionally one or more
Varlink interface names. If no interface names are specified, shows all provided interfaces by the
service.</para>
<varlistentry>
<term><command>call</command> <replaceable>ADDRESS</replaceable> <replaceable>METHOD</replaceable> [<replaceable>ARGUMENTS</replaceable>]</term>
- <listitem><para>Call the specified method of the specified service. Expects a service address in the
+ <listitem><para>Calls the specified method of the specified service. Expects a service address in the
format described above, a fully qualified Varlink method name, and a JSON arguments object. If the
arguments object is not specified, it is read from STDIN instead. To pass an empty list of
parameters, specify the empty object <literal>{}</literal>.</para>
- <para>The reply parameters are written as JSON object to STDOUT.</para>
+ <para>The reply parameters are written as JSON objects to STDOUT.</para>
<xi:include href="version-info.xml" xpointer="v255"/></listitem>
</varlistentry>
<varlistentry>
<term><command>help</command></term>
- <listitem><para>Show command syntax help.</para>
+ <listitem><para>Shows command syntax help.</para>
<xi:include href="version-info.xml" xpointer="v255"/></listitem>
</varlistentry>
<term><option>--more</option></term>
<listitem><para>When used with <command>call</command>: expect multiple method replies. If this flag
- is set the method call is sent with the <constant>more</constant> flag set, which tells the service
+ is set, the method call is sent with the <constant>more</constant> flag set, which tells the service
to generate multiple replies, if needed. The command remains running until the service sends a reply
message that indicates it is the last in the series (or if the configured timeout is reached, see
below). This flag should be set only for method calls that support this mechanism.</para>
- <para>If this mode is enabled output is automatically switched to JSON-SEQ mode, so that individual
+ <para>If this mode is enabled, output is automatically switched to JSON-SEQ mode, so that individual
reply objects can be easily discerned.</para>
- <para>This switch has no effect on the method call timeout applied by default: regardless of
+ <para>This switch has no effect on the method call timeout applied by default. Regardless of
whether <option>--more</option> is specified or not, the default timeout will be 45s. Use
<option>--timeout=</option> (see below) to change or disable the timeout. When invoking a method
- call that continuously returns updates it is typically desirable to disable the timeout with
+ call that continuously returns updates, it is typically desirable to disable the timeout with
<option>--timeout=infinity</option>. On the other hand, when invoking a <option>--more</option>
- method call for the purpose of enumerating objects (which likely will complete quickly) it is
+ method call for the purpose of enumerating objects (which likely will complete quickly), it is
typically beneficial to leave the timeout logic enabled, for robustness reasons.</para>
<xi:include href="version-info.xml" xpointer="v255"/></listitem>
<varlistentry>
<term><option>--collect</option></term>
- <listitem><para>This is similar to <option>--more</option> but collects all responses in a JSON
- array, and prints it, rather than in JSON_SEQ mode.</para>
+ <listitem><para>This is similar to <option>--more</option>, but collects all responses in a JSON
+ array, and prints it, rather than in JSON-SEQ mode.</para>
<xi:include href="version-info.xml" xpointer="v256"/></listitem>
</varlistentry>
<term><option>--oneway</option></term>
<listitem><para>When used with <command>call</command>: do not expect a method reply. If this flag
- is set the method call is sent with the <constant>oneway</constant> flag set (the command exits
+ is set, the method call is sent with the <constant>oneway</constant> flag set (the command exits
immediately after), which tells the service not to generate a reply.</para>
<xi:include href="version-info.xml" xpointer="v255"/></listitem>
<term><option>--json=<replaceable>MODE</replaceable></option></term>
<listitem>
- <para>Selects the JSON output formatting, one of <literal>pretty</literal> (for nicely indented,
- colorized output) or <literal>short</literal> (for terse output with minimal whitespace and no
- newlines), defaults to <literal>short</literal>.</para>
+ <para>Selects the JSON output formatting, either <literal>pretty</literal> for nicely indented,
+ colorized output, or <literal>short</literal> for terse output with minimal whitespace and no
+ newlines. Defaults to <literal>short</literal>.</para>
<xi:include href="version-info.xml" xpointer="v255"/>
</listitem>
<term><option>-j</option></term>
<listitem>
- <para>Equivalent to <option>--json=pretty</option> when invoked interactively from a terminal. Otherwise
- equivalent to <option>--json=short</option>, in particular when the output is piped to some other
+ <para>Equivalent to <option>--json=pretty</option> when invoked interactively from a terminal. Otherwise,
+ it is equivalent to <option>--json=short</option>, in particular when the output is piped to some other
program.</para>
<xi:include href="version-info.xml" xpointer="v255"/>
<term><option>--graceful=</option></term>
<listitem>
- <para>Takes a qualified Varlink error name (i.e. an interface name, suffixed by an error name,
- separated by a dot; e.g. <literal>org.varlink.service.InvalidParameter</literal>). Ensures that if
- a method call fails with the specified error this will be treated as success, i.e. will cause the
+ <para>Takes a qualified Varlink error name, i.e. an interface name, suffixed by an error name,
+ separated by a dot, e.g. <literal>org.varlink.service.InvalidParameter</literal>. Ensures that, if
+ a method call fails with the specified error, this will be treated as success, i.e. will cause the
<command>varlinkctl</command> invocation to exit with a zero exit status. This option may be used more
than once in order to treat multiple different errors as successes.</para>
<listitem>
<para>Expects a timeout in seconds as parameter. By default, a timeout of 45s is enforced. To turn
- off the timeout specify <literal>infinity</literal> or an empty string.</para>
+ off the timeout, specify <literal>infinity</literal> or an empty string.</para>
<xi:include href="version-info.xml" xpointer="v257"/>
</listitem>
projects / thirdparty / systemd.git / commitdiff
