man/busctl.xml

   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">
   4
   5 <!--
   6 This file is part of systemd.
   7
   8 Copyright 2014 Zbigniew Jędrzejewski-Szmek
   9
  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.
  14
  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.
  19
  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/>.
  22 -->
  23
  24 <refentry id="busctl"
  25           xmlns:xi="http://www.w3.org/2001/XInclude">
  26
  27   <refentryinfo>
  28     <title>busctl</title>
  29     <productname>systemd</productname>
  30
  31     <authorgroup>
  32       <author>
  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>
  37       </author>
  38     </authorgroup>
  39   </refentryinfo>
  40
  41   <refmeta>
  42     <refentrytitle>busctl</refentrytitle>
  43     <manvolnum>1</manvolnum>
  44   </refmeta>
  45
  46   <refnamediv>
  47     <refname>busctl</refname>
  48     <refpurpose>Introspect the bus</refpurpose>
  49   </refnamediv>
  50
  51   <refsynopsisdiv>
  52     <cmdsynopsis>
  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>
  57     </cmdsynopsis>
  58   </refsynopsisdiv>
  59
  60   <refsect1>
  61     <title>Description</title>
  62
  63     <para><command>busctl</command> may be used to
  64     introspect and monitor the D-Bus bus.</para>
  65   </refsect1>
  66
  67   <refsect1>
  68     <title>Options</title>
  69
  70     <para>The following options are understood:</para>
  71
  72     <variablelist>
  73       <varlistentry>
  74           <term><option>--address=<replaceable>ADDRESS</replaceable></option></term>
  75
  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>
  81       </varlistentry>
  82
  83       <varlistentry>
  84           <term><option>--show-machine</option></term>
  85
  86           <listitem><para>When showing the list of endpoints, show a
  87           column containing the names of containers they belong to.
  88           See
  89           <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
  90           </para></listitem>
  91       </varlistentry>
  92
  93       <varlistentry>
  94           <term><option>--unique</option></term>
  95
  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>).
  99           </para></listitem>
 100       </varlistentry>
 101
 102       <varlistentry>
 103           <term><option>--acquired</option></term>
 104
 105           <listitem><para>The opposite of <option>--unique</option> —
 106           only "well-known" names will be shown.</para></listitem>
 107       </varlistentry>
 108
 109       <varlistentry>
 110           <term><option>--activatable</option></term>
 111
 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>
 115           </listitem>
 116       </varlistentry>
 117
 118       <varlistentry>
 119           <term><option>--match=<replaceable>MATCH</replaceable></option></term>
 120
 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? -->
 124       </varlistentry>
 125
 126       <varlistentry>
 127         <term><option>--no-legend</option></term>
 128
 129         <listitem>
 130           <para>Do not print the legend,
 131           i.e. the column headers and the
 132           footer.</para>
 133         </listitem>
 134       </varlistentry>
 135
 136       <varlistentry>
 137         <term><option>--size=</option></term>
 138
 139         <listitem>
 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>
 143         </listitem>
 144       </varlistentry>
 145
 146       <varlistentry>
 147         <term><option>--list</option></term>
 148
 149         <listitem>
 150           <para>When used with the <command>tree</command> shows a
 151           flat list of object paths instead of a tree.</para>
 152         </listitem>
 153       </varlistentry>
 154
 155       <xi:include href="user-system-options.xml" xpointer="user" />
 156       <xi:include href="user-system-options.xml" xpointer="system" />
 157       <xi:include href="user-system-options.xml" xpointer="host" />
 158       <xi:include href="user-system-options.xml" xpointer="machine" />
 159
 160       <xi:include href="standard-options.xml" xpointer="help" />
 161       <xi:include href="standard-options.xml" xpointer="version" />
 162       <xi:include href="standard-options.xml" xpointer="no-pager" />
 163     </variablelist>
 164   </refsect1>
 165
 166   <refsect1>
 167     <title>Commands</title>
 168
 169     <para>The following commands are understood:</para>
 170
 171     <variablelist>
 172       <varlistentry>
 173         <term><command>list</command></term>
 174
 175         <listitem><para>Show service names on the bus. This is the
 176         default if no command is specified.</para></listitem>
 177       </varlistentry>
 178
 179       <varlistentry>
 180         <term><command>tree</command>  <arg choice="opt" rep="repeat"><replaceable>NAME</replaceable></arg></term>
 181
 182         <listitem><para>Shows an object tree of one or more
 183         services. If <replaceable>NAME</replaceable> is specified,
 184         show object tree of the specified services only. Otherwise,
 185         show all object trees of all services on the bus that acquired
 186         at least one well-known name.</para></listitem>
 187       </varlistentry>
 188
 189       <varlistentry>
 190         <term><command>monitor</command>  <arg choice="opt" rep="repeat"><replaceable>NAME</replaceable></arg></term>
 191
 192         <listitem><para>Dump messages being exchanged. If
 193         <replaceable>NAME</replaceable> is specified, show messages
 194         to or from this endpoint. Otherwise, show all messages on the
 195         bus.</para></listitem>
 196       </varlistentry>
 197
 198       <varlistentry>
 199         <term><command>capture</command>  <arg choice="opt" rep="repeat"><replaceable>NAME</replaceable></arg></term>
 200
 201         <listitem><para>Similar to <command>monitor</command> but
 202         writes the output in pcap format (for details see the <ulink
 203         url="http://wiki.wireshark.org/Development/LibpcapFileFormat">Libpcap
 204         File Format</ulink> description. Make sure to redirect the
 205         output to STDOUT to a file. Tools like
 206         <citerefentry><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 207         may be used to dissect and view the generated
 208         files.</para></listitem>
 209       </varlistentry>
 210
 211       <varlistentry>
 212         <term><command>status</command>  <arg choice="plain"><replaceable>NAME</replaceable></arg></term>
 213
 214         <listitem><para>Show process information and credentials of a
 215         bus service.</para></listitem>
 216       </varlistentry>
 217
 218       <varlistentry>
 219         <term><command>help</command></term>
 220
 221         <listitem><para>Show command syntax help.</para></listitem>
 222       </varlistentry>
 223     </variablelist>
 224   </refsect1>
 225
 226   <refsect1>
 227     <title>See Also</title>
 228
 229     <para>
 230       <citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 231       <ulink url="http://freedesktop.org/wiki/Software/dbus">D-Bus</ulink>,
 232       <ulink url="https://code.google.com/p/d-bus/">kdbus</ulink>,
 233       <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 234       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 235       <citerefentry><refentrytitle>systemd-bus-proxyd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 236       <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 237       <citerefentry><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 238     </para>
 239   </refsect1>
 240 </refentry>