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>-H</option></term>
75 <term><option>--host</option></term>
78 <para>Execute the operation remotely. Specify a hostname, or
79 username and hostname separated by <literal>@</literal>, to
80 connect to. This will use SSH to talk to the remote systemd
86 <term><option>-M</option></term>
87 <term><option>--machine=</option></term>
89 <listitem><para>Execute the operation on a local container.
90 Specify a container name to connect to.</para></listitem>
94 <term><option>--address=<replaceable>ADDRESS</replaceable></option></term>
96 <listitem><para>Connect to the bus specified by
97 <replaceable>ADDRESS</replaceable> instead of using suitable
98 defaults for either the system or user bus (see
99 <option>--system</option> and <option>--user</option>
100 options).</para></listitem>
104 <term><option>--show-machine</option></term>
106 <listitem><para>When showing the list of endpoints, show a
107 column containing the names of containers they belong to.
109 <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
114 <term><option>--unique</option></term>
116 <listitem><para>When showing the list of endpoints, show
117 only "unique" names (of the form
118 <literal>:<replaceable>number</replaceable>.<replaceable>number</replaceable></literal>).
123 <term><option>--acquired</option></term>
125 <listitem><para>The opposite of <option>--unique</option> —
126 only "well-known" names will be shown.</para></listitem>
130 <term><option>--activatable</option></term>
132 <listitem><para>When showing the list of endpoints, show
133 only endpoints which have actually not been activated yet,
134 but may be started automatically if accessed.</para>
139 <term><option>--match=<replaceable>MATCH</replaceable></option></term>
141 <listitem><para>When showing messages being exchanged, show only the
142 subset matching <replaceable>MATCH</replaceable>.</para></listitem>
143 <!-- TODO: link to sd_bus_add_match when it is written? -->
147 <term><option>--no-legend</option></term>
150 <para>Do not print the legend,
151 i.e. the column headers and the
156 <xi:include href="user-system-options.xml" xpointer="user" />
157 <xi:include href="user-system-options.xml" xpointer="system" />
159 <xi:include href="standard-options.xml" xpointer="help" />
160 <xi:include href="standard-options.xml" xpointer="version" />
161 <xi:include href="standard-options.xml" xpointer="no-pager" />
166 <title>Commands</title>
168 <para>The following commands are understood:</para>
172 <term><command>list</command></term>
174 <listitem><para>Show endpoints attached to the bus. This is
175 the default if no command is specified.</para></listitem>
179 <term><command>monitor</command> <arg choice="opt" rep="repeat"><replaceable>NAME</replaceable></arg></term>
181 <listitem><para>Dump messages being exchanged. If
182 <replaceable>NAME</replaceable> is specified, show messages
183 to or from this endpoint. Otherwise, show all messages on the
184 bus.</para></listitem>
188 <term><command>status</command> <arg choice="plain"><replaceable>NAME</replaceable></arg></term>
190 <listitem><para>Show process information and credentials of a
191 bus endpoint.</para></listitem>
195 <term><command>help</command></term>
197 <listitem><para>Show command syntax help.</para></listitem>
203 <title>See Also</title>
206 <citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
207 <ulink url="http://freedesktop.org/wiki/Software/dbus">D-Bus</ulink>,
208 <ulink url="https://code.google.com/p/d-bus/">kdbus</ulink>,
209 <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
210 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
211 <citerefentry><refentrytitle>systemd-bus-proxyd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
212 <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>