2014-01-12 04:44:34 +00:00
|
|
|
<?xml version='1.0'?> <!--*-nxml-*-->
|
|
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
|
|
|
|
|
|
|
<!--
|
|
|
|
This file is part of systemd.
|
|
|
|
|
|
|
|
Copyright 2014 Zbigniew Jędrzejewski-Szmek
|
|
|
|
|
|
|
|
systemd is free software; you can redistribute it and/or modify it
|
|
|
|
under the terms of the GNU Lesser General Public License as published by
|
|
|
|
the Free Software Foundation; either version 2.1 of the License, or
|
|
|
|
(at your option) any later version.
|
|
|
|
|
|
|
|
systemd is distributed in the hope that it will be useful, but
|
|
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
Lesser General Public License for more details.
|
|
|
|
|
|
|
|
You should have received a copy of the GNU Lesser General Public License
|
|
|
|
along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
-->
|
|
|
|
|
2014-02-13 19:33:51 +00:00
|
|
|
<refentry id="busctl"
|
|
|
|
xmlns:xi="http://www.w3.org/2001/XInclude">
|
2014-01-12 04:44:34 +00:00
|
|
|
|
|
|
|
<refentryinfo>
|
|
|
|
<title>busctl</title>
|
|
|
|
<productname>systemd</productname>
|
|
|
|
|
|
|
|
<authorgroup>
|
|
|
|
<author>
|
|
|
|
<contrib>A monkey with a typewriter</contrib>
|
|
|
|
<firstname>Zbigniew</firstname>
|
|
|
|
<surname>Jędrzejewski-Szmek</surname>
|
|
|
|
<email>zbyszek@in.waw.pl</email>
|
|
|
|
</author>
|
|
|
|
</authorgroup>
|
|
|
|
</refentryinfo>
|
|
|
|
|
|
|
|
<refmeta>
|
|
|
|
<refentrytitle>busctl</refentrytitle>
|
|
|
|
<manvolnum>1</manvolnum>
|
|
|
|
</refmeta>
|
|
|
|
|
|
|
|
<refnamediv>
|
|
|
|
<refname>busctl</refname>
|
|
|
|
<refpurpose>Introspect the bus</refpurpose>
|
|
|
|
</refnamediv>
|
|
|
|
|
|
|
|
<refsynopsisdiv>
|
|
|
|
<cmdsynopsis>
|
|
|
|
<command>busctl</command>
|
|
|
|
<arg choice="opt" rep="repeat">OPTIONS</arg>
|
|
|
|
<arg choice="opt">COMMAND</arg>
|
|
|
|
<arg choice="opt" rep="repeat"><replaceable>NAME</replaceable></arg>
|
|
|
|
</cmdsynopsis>
|
|
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Description</title>
|
|
|
|
|
|
|
|
<para><command>busctl</command> may be used to
|
|
|
|
introspect and monitor the D-Bus bus.</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Options</title>
|
|
|
|
|
|
|
|
<para>The following options are understood:</para>
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>--address=<replaceable>ADDRESS</replaceable></option></term>
|
|
|
|
|
|
|
|
<listitem><para>Connect to the bus specified by
|
|
|
|
<replaceable>ADDRESS</replaceable> instead of using suitable
|
|
|
|
defaults for either the system or user bus (see
|
|
|
|
<option>--system</option> and <option>--user</option>
|
|
|
|
options).</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>--show-machine</option></term>
|
|
|
|
|
|
|
|
<listitem><para>When showing the list of endpoints, show a
|
|
|
|
column containing the names of containers they belong to.
|
|
|
|
See
|
|
|
|
<citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
|
|
|
|
</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>--unique</option></term>
|
|
|
|
|
|
|
|
<listitem><para>When showing the list of endpoints, show
|
|
|
|
only "unique" names (of the form
|
|
|
|
<literal>:<replaceable>number</replaceable>.<replaceable>number</replaceable></literal>).
|
|
|
|
</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>--acquired</option></term>
|
|
|
|
|
|
|
|
<listitem><para>The opposite of <option>--unique</option> —
|
|
|
|
only "well-known" names will be shown.</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>--activatable</option></term>
|
|
|
|
|
|
|
|
<listitem><para>When showing the list of endpoints, show
|
2014-02-17 02:37:18 +00:00
|
|
|
only endpoints which have actually not been activated yet,
|
2014-01-12 04:44:34 +00:00
|
|
|
but may be started automatically if accessed.</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>--match=<replaceable>MATCH</replaceable></option></term>
|
|
|
|
|
|
|
|
<listitem><para>When showing messages being exchanged, show only the
|
|
|
|
subset matching <replaceable>MATCH</replaceable>.</para></listitem>
|
|
|
|
<!-- TODO: link to sd_bus_add_match when it is written? -->
|
|
|
|
</varlistentry>
|
2014-02-13 19:33:51 +00:00
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>--no-legend</option></term>
|
|
|
|
|
|
|
|
<listitem>
|
|
|
|
<para>Do not print the legend,
|
|
|
|
i.e. the column headers and the
|
|
|
|
footer.</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2014-10-30 00:13:11 +00:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>--size=</option></term>
|
|
|
|
|
|
|
|
<listitem>
|
|
|
|
<para>When used with the <command>capture</command> command
|
|
|
|
specifies the maximum bus message size to capture
|
|
|
|
("snaplen"). Defaults to 4096 bytes.</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2014-11-10 18:24:48 +00:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>--list</option></term>
|
|
|
|
|
|
|
|
<listitem>
|
2014-11-14 12:11:45 +00:00
|
|
|
<para>When used with the <command>tree</command> command shows a
|
2014-11-10 18:24:48 +00:00
|
|
|
flat list of object paths instead of a tree.</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2014-11-14 12:11:10 +00:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>--quiet</option></term>
|
|
|
|
|
|
|
|
<listitem>
|
|
|
|
<para>When used with the <command>call</command> command suppresses
|
|
|
|
display of the response message.</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2014-02-13 19:40:40 +00:00
|
|
|
<xi:include href="user-system-options.xml" xpointer="user" />
|
|
|
|
<xi:include href="user-system-options.xml" xpointer="system" />
|
2014-02-21 00:47:03 +00:00
|
|
|
<xi:include href="user-system-options.xml" xpointer="host" />
|
|
|
|
<xi:include href="user-system-options.xml" xpointer="machine" />
|
2014-02-13 19:40:40 +00:00
|
|
|
|
2014-02-13 19:33:51 +00:00
|
|
|
<xi:include href="standard-options.xml" xpointer="help" />
|
|
|
|
<xi:include href="standard-options.xml" xpointer="version" />
|
|
|
|
<xi:include href="standard-options.xml" xpointer="no-pager" />
|
2014-01-12 04:44:34 +00:00
|
|
|
</variablelist>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Commands</title>
|
|
|
|
|
|
|
|
<para>The following commands are understood:</para>
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term><command>list</command></term>
|
|
|
|
|
2014-11-10 18:24:48 +00:00
|
|
|
<listitem><para>Show service names on the bus. This is the
|
|
|
|
default if no command is specified.</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2014-11-14 12:11:45 +00:00
|
|
|
<term><command>tree</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
|
2014-11-10 18:24:48 +00:00
|
|
|
|
|
|
|
<listitem><para>Shows an object tree of one or more
|
2014-11-14 12:11:45 +00:00
|
|
|
services. If <replaceable>SERVICE</replaceable> is specified,
|
2014-11-10 18:24:48 +00:00
|
|
|
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>
|
2014-01-12 04:44:34 +00:00
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2014-11-14 12:11:45 +00:00
|
|
|
<term><command>monitor</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
|
2014-01-12 04:44:34 +00:00
|
|
|
|
|
|
|
<listitem><para>Dump messages being exchanged. If
|
2014-11-14 12:11:45 +00:00
|
|
|
<replaceable>SERVICE</replaceable> is specified, show messages
|
2014-02-19 16:02:45 +00:00
|
|
|
to or from this endpoint. Otherwise, show all messages on the
|
2014-01-12 04:44:34 +00:00
|
|
|
bus.</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2014-10-30 00:13:11 +00:00
|
|
|
<varlistentry>
|
2014-11-14 12:11:45 +00:00
|
|
|
<term><command>capture</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
|
2014-10-30 00:13:11 +00:00
|
|
|
|
|
|
|
<listitem><para>Similar to <command>monitor</command> but
|
|
|
|
writes the output in pcap format (for details see the <ulink
|
|
|
|
url="http://wiki.wireshark.org/Development/LibpcapFileFormat">Libpcap
|
|
|
|
File Format</ulink> description. Make sure to redirect the
|
|
|
|
output to STDOUT to a file. Tools like
|
|
|
|
<citerefentry><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
|
|
|
may be used to dissect and view the generated
|
|
|
|
files.</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2014-01-12 04:44:34 +00:00
|
|
|
<varlistentry>
|
2014-11-14 12:11:45 +00:00
|
|
|
<term><command>status</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg></term>
|
2014-01-12 04:44:34 +00:00
|
|
|
|
|
|
|
<listitem><para>Show process information and credentials of a
|
2014-11-10 18:24:48 +00:00
|
|
|
bus service.</para></listitem>
|
2014-01-12 04:44:34 +00:00
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2014-11-14 12:11:10 +00:00
|
|
|
<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>PARAMETERS</replaceable></arg></arg></term>
|
|
|
|
|
2014-11-14 16:20:04 +00:00
|
|
|
<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 individual parameters,
|
|
|
|
individually formatted as textual arguments.</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="opt"><replaceable>INTERFACE</replaceable> <arg choice="opt" rep="repeat"><replaceable>PROPERTIES</replaceable></arg></arg></term>
|
|
|
|
|
|
|
|
<listitem><para>Retrieve the current value one or more object
|
|
|
|
properties. Takes a service name and object path. Optionally
|
|
|
|
takes an interface name and property name. If the property
|
|
|
|
name is omited, shows all properties on the selected
|
|
|
|
interface. If the interface is also omitted shows the
|
|
|
|
properties of all interfaces. Multiple properties may be
|
|
|
|
specified at once in which case their values will be shown one
|
|
|
|
after the other.</para></listitem>
|
2014-11-14 12:11:10 +00:00
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2014-01-12 04:44:34 +00:00
|
|
|
<term><command>help</command></term>
|
|
|
|
|
|
|
|
<listitem><para>Show command syntax help.</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>See Also</title>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
<citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
|
|
<ulink url="http://freedesktop.org/wiki/Software/dbus">D-Bus</ulink>,
|
|
|
|
<ulink url="https://code.google.com/p/d-bus/">kdbus</ulink>,
|
|
|
|
<citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
|
|
|
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
|
|
<citerefentry><refentrytitle>systemd-bus-proxyd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
2014-10-30 00:13:11 +00:00
|
|
|
<citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
|
|
<citerefentry><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
2014-01-12 04:44:34 +00:00
|
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
</refentry>
|