Move the Commands section above Options section
For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
This commit is contained in:
Zbigniew Jędrzejewski-Szmek
+120
-120
@@ -37,6 +37,126 @@
|
||||
introspect and monitor the D-Bus bus.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Commands</title>
|
||||
|
||||
<para>The following commands are understood:</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><command>list</command></term>
|
||||
|
||||
<listitem><para>Show all peers on the bus, by their service
|
||||
names. By default, shows both unique and well-known names, but
|
||||
this may be changed with the <option>--unique</option> and
|
||||
<option>--acquired</option> switches. This is the default
|
||||
operation if no command is specified.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>status</command> <arg choice="opt"><replaceable>SERVICE</replaceable></arg></term>
|
||||
|
||||
<listitem><para>Show process information and credentials of a
|
||||
bus service (if one is specified by its unique or well-known
|
||||
name), a process (if one is specified by its numeric PID), or
|
||||
the owner of the bus (if no parameter is
|
||||
specified).</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>monitor</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
|
||||
|
||||
<listitem><para>Dump messages being exchanged. If
|
||||
<replaceable>SERVICE</replaceable> is specified, show messages
|
||||
to or from this peer, identified by its well-known or unique
|
||||
name. Otherwise, show all messages on the bus. Use
|
||||
<keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo>
|
||||
to terminate the dump.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>capture</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
|
||||
|
||||
<listitem><para>Similar to <command>monitor</command> but
|
||||
writes the output in pcap format (for details, see the <ulink
|
||||
url="https://wiki.wireshark.org/Development/LibpcapFileFormat">Libpcap
|
||||
File Format</ulink> description). Make sure to redirect
|
||||
standard output to a file. Tools like
|
||||
<citerefentry project='die-net'><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||
may be used to dissect and view the resulting
|
||||
files.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>tree</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
|
||||
|
||||
<listitem><para>Shows an object tree of one or more
|
||||
services. If <replaceable>SERVICE</replaceable> is specified,
|
||||
show object tree of the specified services only. Otherwise,
|
||||
show all object trees of all services on the bus that acquired
|
||||
at least one well-known name.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>introspect</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="opt"><replaceable>INTERFACE</replaceable></arg></term>
|
||||
|
||||
<listitem><para>Show interfaces, methods, properties and
|
||||
signals of the specified object (identified by its path) on
|
||||
the specified service. If the interface argument is passed, the
|
||||
output is limited to members of the specified
|
||||
interface.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>call</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="plain"><replaceable>INTERFACE</replaceable></arg> <arg choice="plain"><replaceable>METHOD</replaceable></arg> <arg choice="opt"><replaceable>SIGNATURE</replaceable> <arg choice="opt" rep="repeat"><replaceable>ARGUMENT</replaceable></arg></arg></term>
|
||||
|
||||
<listitem><para>Invoke a method and show the response. Takes a
|
||||
service name, object path, interface name and method name. If
|
||||
parameters shall be passed to the method call, a signature
|
||||
string is required, followed by the arguments, individually
|
||||
formatted as strings. For details on the formatting used, see
|
||||
below. To suppress output of the returned data, use the
|
||||
<option>--quiet</option> option.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>emit</command> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="plain"><replaceable>INTERFACE</replaceable></arg> <arg choice="plain"><replaceable>SIGNAL</replaceable></arg> <arg choice="opt"><replaceable>SIGNATURE</replaceable> <arg choice="opt" rep="repeat"><replaceable>ARGUMENT</replaceable></arg></arg></term>
|
||||
|
||||
<listitem><para>Emit a signal. Takes a object path, interface name and method name. If parameters
|
||||
shall be passed, a signature string is required, followed by the arguments, individually formatted as
|
||||
strings. For details on the formatting used, see below. To specify the destination of the signal,
|
||||
use the <option>--destination=</option> option.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>get-property</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="plain"><replaceable>INTERFACE</replaceable></arg> <arg choice="plain" rep="repeat"><replaceable>PROPERTY</replaceable></arg></term>
|
||||
|
||||
<listitem><para>Retrieve the current value of one or more
|
||||
object properties. Takes a service name, object path,
|
||||
interface name and property name. Multiple properties may be
|
||||
specified at once, in which case their values will be shown one
|
||||
after the other, separated by newlines. The output is, by
|
||||
default, in terse format. Use <option>--verbose</option> for a
|
||||
more elaborate output format.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>set-property</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="plain"><replaceable>INTERFACE</replaceable></arg> <arg choice="plain"><replaceable>PROPERTY</replaceable></arg> <arg choice="plain"><replaceable>SIGNATURE</replaceable></arg> <arg choice="plain" rep="repeat"><replaceable>ARGUMENT</replaceable></arg></term>
|
||||
|
||||
<listitem><para>Set the current value of an object
|
||||
property. Takes a service name, object path, interface name,
|
||||
property name, property signature, followed by a list of
|
||||
parameters formatted as strings.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>help</command></term>
|
||||
|
||||
<listitem><para>Show command syntax help.</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Options</title>
|
||||
|
||||
@@ -275,126 +395,6 @@
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Commands</title>
|
||||
|
||||
<para>The following commands are understood:</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><command>list</command></term>
|
||||
|
||||
<listitem><para>Show all peers on the bus, by their service
|
||||
names. By default, shows both unique and well-known names, but
|
||||
this may be changed with the <option>--unique</option> and
|
||||
<option>--acquired</option> switches. This is the default
|
||||
operation if no command is specified.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>status</command> <arg choice="opt"><replaceable>SERVICE</replaceable></arg></term>
|
||||
|
||||
<listitem><para>Show process information and credentials of a
|
||||
bus service (if one is specified by its unique or well-known
|
||||
name), a process (if one is specified by its numeric PID), or
|
||||
the owner of the bus (if no parameter is
|
||||
specified).</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>monitor</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
|
||||
|
||||
<listitem><para>Dump messages being exchanged. If
|
||||
<replaceable>SERVICE</replaceable> is specified, show messages
|
||||
to or from this peer, identified by its well-known or unique
|
||||
name. Otherwise, show all messages on the bus. Use
|
||||
<keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo>
|
||||
to terminate the dump.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>capture</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
|
||||
|
||||
<listitem><para>Similar to <command>monitor</command> but
|
||||
writes the output in pcap format (for details, see the <ulink
|
||||
url="https://wiki.wireshark.org/Development/LibpcapFileFormat">Libpcap
|
||||
File Format</ulink> description). Make sure to redirect
|
||||
standard output to a file. Tools like
|
||||
<citerefentry project='die-net'><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||
may be used to dissect and view the resulting
|
||||
files.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>tree</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
|
||||
|
||||
<listitem><para>Shows an object tree of one or more
|
||||
services. If <replaceable>SERVICE</replaceable> is specified,
|
||||
show object tree of the specified services only. Otherwise,
|
||||
show all object trees of all services on the bus that acquired
|
||||
at least one well-known name.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>introspect</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="opt"><replaceable>INTERFACE</replaceable></arg></term>
|
||||
|
||||
<listitem><para>Show interfaces, methods, properties and
|
||||
signals of the specified object (identified by its path) on
|
||||
the specified service. If the interface argument is passed, the
|
||||
output is limited to members of the specified
|
||||
interface.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>call</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="plain"><replaceable>INTERFACE</replaceable></arg> <arg choice="plain"><replaceable>METHOD</replaceable></arg> <arg choice="opt"><replaceable>SIGNATURE</replaceable> <arg choice="opt" rep="repeat"><replaceable>ARGUMENT</replaceable></arg></arg></term>
|
||||
|
||||
<listitem><para>Invoke a method and show the response. Takes a
|
||||
service name, object path, interface name and method name. If
|
||||
parameters shall be passed to the method call, a signature
|
||||
string is required, followed by the arguments, individually
|
||||
formatted as strings. For details on the formatting used, see
|
||||
below. To suppress output of the returned data, use the
|
||||
<option>--quiet</option> option.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>emit</command> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="plain"><replaceable>INTERFACE</replaceable></arg> <arg choice="plain"><replaceable>SIGNAL</replaceable></arg> <arg choice="opt"><replaceable>SIGNATURE</replaceable> <arg choice="opt" rep="repeat"><replaceable>ARGUMENT</replaceable></arg></arg></term>
|
||||
|
||||
<listitem><para>Emit a signal. Takes a object path, interface name and method name. If parameters
|
||||
shall be passed, a signature string is required, followed by the arguments, individually formatted as
|
||||
strings. For details on the formatting used, see below. To specify the destination of the signal,
|
||||
use the <option>--destination=</option> option.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>get-property</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="plain"><replaceable>INTERFACE</replaceable></arg> <arg choice="plain" rep="repeat"><replaceable>PROPERTY</replaceable></arg></term>
|
||||
|
||||
<listitem><para>Retrieve the current value of one or more
|
||||
object properties. Takes a service name, object path,
|
||||
interface name and property name. Multiple properties may be
|
||||
specified at once, in which case their values will be shown one
|
||||
after the other, separated by newlines. The output is, by
|
||||
default, in terse format. Use <option>--verbose</option> for a
|
||||
more elaborate output format.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>set-property</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="plain"><replaceable>INTERFACE</replaceable></arg> <arg choice="plain"><replaceable>PROPERTY</replaceable></arg> <arg choice="plain"><replaceable>SIGNATURE</replaceable></arg> <arg choice="plain" rep="repeat"><replaceable>ARGUMENT</replaceable></arg></term>
|
||||
|
||||
<listitem><para>Set the current value of an object
|
||||
property. Takes a service name, object path, interface name,
|
||||
property name, property signature, followed by a list of
|
||||
parameters formatted as strings.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>help</command></term>
|
||||
|
||||
<listitem><para>Show command syntax help.</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Parameter Formatting</title>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user