1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 This file is part of systemd.
8 Copyright 2014 Zbigniew Jędrzejewski-Szmek
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
25 xmlns:xi="http://www.w3.org/2001/XInclude">
29 <productname>systemd</productname>
33 <contrib>A monkey with a typewriter</contrib>
34 <firstname>Zbigniew</firstname>
35 <surname>Jędrzejewski-Szmek</surname>
36 <email>zbyszek@in.waw.pl</email>
42 <refentrytitle>busctl</refentrytitle>
43 <manvolnum>1</manvolnum>
47 <refname>busctl</refname>
48 <refpurpose>Introspect the bus</refpurpose>
53 <command>busctl</command>
54 <arg choice="opt" rep="repeat">OPTIONS</arg>
55 <arg choice="opt">COMMAND</arg>
56 <arg choice="opt" rep="repeat"><replaceable>NAME</replaceable></arg>
61 <title>Description</title>
63 <para><command>busctl</command> may be used to
64 introspect and monitor the D-Bus bus.</para>
68 <title>Options</title>
70 <para>The following options are understood:</para>
74 <term><option>--address=<replaceable>ADDRESS</replaceable></option></term>
76 <listitem><para>Connect to the bus specified by
77 <replaceable>ADDRESS</replaceable> instead of using suitable
78 defaults for either the system or user bus (see
79 <option>--system</option> and <option>--user</option>
80 options).</para></listitem>
84 <term><option>--show-machine</option></term>
86 <listitem><para>When showing the list of endpoints, show a
87 column containing the names of containers they belong to.
89 <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
94 <term><option>--unique</option></term>
96 <listitem><para>When showing the list of endpoints, show
97 only "unique" names (of the form
98 <literal>:<replaceable>number</replaceable>.<replaceable>number</replaceable></literal>).
103 <term><option>--acquired</option></term>
105 <listitem><para>The opposite of <option>--unique</option> —
106 only "well-known" names will be shown.</para></listitem>
110 <term><option>--activatable</option></term>
112 <listitem><para>When showing the list of endpoints, show
113 only endpoints which have actually not been activated yet,
114 but may be started automatically if accessed.</para>
119 <term><option>--match=<replaceable>MATCH</replaceable></option></term>
121 <listitem><para>When showing messages being exchanged, show only the
122 subset matching <replaceable>MATCH</replaceable>.</para></listitem>
123 <!-- TODO: link to sd_bus_add_match when it is written? -->
127 <term><option>--no-legend</option></term>
130 <para>Do not print the legend,
131 i.e. the column headers and the
137 <term><option>--size=</option></term>
140 <para>When used with the <command>capture</command> command
141 specifies the maximum bus message size to capture
142 ("snaplen"). Defaults to 4096 bytes.</para>
147 <term><option>--list</option></term>
150 <para>When used with the <command>tree</command> command shows a
151 flat list of object paths instead of a tree.</para>
156 <term><option>--quiet</option></term>
159 <para>When used with the <command>call</command> command suppresses
160 display of the response message.</para>
164 <xi:include href="user-system-options.xml" xpointer="user" />
165 <xi:include href="user-system-options.xml" xpointer="system" />
166 <xi:include href="user-system-options.xml" xpointer="host" />
167 <xi:include href="user-system-options.xml" xpointer="machine" />
169 <xi:include href="standard-options.xml" xpointer="help" />
170 <xi:include href="standard-options.xml" xpointer="version" />
171 <xi:include href="standard-options.xml" xpointer="no-pager" />
176 <title>Commands</title>
178 <para>The following commands are understood:</para>
182 <term><command>list</command></term>
184 <listitem><para>Show service names on the bus. This is the
185 default if no command is specified.</para></listitem>
189 <term><command>tree</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
191 <listitem><para>Shows an object tree of one or more
192 services. If <replaceable>SERVICE</replaceable> is specified,
193 show object tree of the specified services only. Otherwise,
194 show all object trees of all services on the bus that acquired
195 at least one well-known name.</para></listitem>
199 <term><command>monitor</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
201 <listitem><para>Dump messages being exchanged. If
202 <replaceable>SERVICE</replaceable> is specified, show messages
203 to or from this endpoint. Otherwise, show all messages on the
204 bus.</para></listitem>
208 <term><command>capture</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
210 <listitem><para>Similar to <command>monitor</command> but
211 writes the output in pcap format (for details see the <ulink
212 url="http://wiki.wireshark.org/Development/LibpcapFileFormat">Libpcap
213 File Format</ulink> description. Make sure to redirect the
214 output to STDOUT to a file. Tools like
215 <citerefentry><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry>
216 may be used to dissect and view the generated
217 files.</para></listitem>
221 <term><command>status</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg></term>
223 <listitem><para>Show process information and credentials of a
224 bus service.</para></listitem>
228 <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>
230 <listitem><para>Invoke a method and show the response. Takes a
231 service name, object path, interface name and method name. If
232 parameters shall be passed to the method call a signature
233 string is required, followed by the individual parameters,
234 individually formatted as textual arguments.</para></listitem>
238 <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>
240 <listitem><para>Retrieve the current value one or more object
241 properties. Takes a service name and object path. Optionally
242 takes an interface name and property name. If the property
243 name is omited, shows all properties on the selected
244 interface. If the interface is also omitted shows the
245 properties of all interfaces. Multiple properties may be
246 specified at once in which case their values will be shown one
247 after the other.</para></listitem>
251 <term><command>help</command></term>
253 <listitem><para>Show command syntax help.</para></listitem>
259 <title>See Also</title>
262 <citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
263 <ulink url="http://freedesktop.org/wiki/Software/dbus">D-Bus</ulink>,
264 <ulink url="https://code.google.com/p/d-bus/">kdbus</ulink>,
265 <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
266 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
267 <citerefentry><refentrytitle>systemd-bus-proxyd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
268 <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
269 <citerefentry><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry>