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>--system</option></term>
  75
  76         <listitem>
  77           <para>Talk to the systemd system manager (the
  78           default).</para>
  79         </listitem>
  80       </varlistentry>
  81
  82       <varlistentry>
  83         <term><option>--user</option></term>
  84
  85         <listitem>
  86           <para>Talk to the systemd manager of the calling
  87           user.</para>
  88         </listitem>
  89       </varlistentry>
  90
  91       <varlistentry>
  92         <term><option>-H</option></term>
  93         <term><option>--host</option></term>
  94
  95         <listitem>
  96           <para>Execute the operation remotely. Specify a hostname, or
  97           username and hostname separated by <literal>@</literal>, to
  98           connect to. This will use SSH to talk to the remote systemd
  99           instance.</para>
 100         </listitem>
 101       </varlistentry>
 102
 103       <varlistentry>
 104           <term><option>-M</option></term>
 105           <term><option>--machine=</option></term>
 106
 107           <listitem><para>Execute the operation on a local container.
 108           Specify a container name to connect to.</para></listitem>
 109       </varlistentry>
 110
 111       <varlistentry>
 112           <term><option>--address=<replaceable>ADDRESS</replaceable></option></term>
 113
 114           <listitem><para>Connect to the bus specified by
 115           <replaceable>ADDRESS</replaceable> instead of using suitable
 116           defaults for either the system or user bus (see
 117           <option>--system</option> and <option>--user</option>
 118           options).</para></listitem>
 119       </varlistentry>
 120
 121       <varlistentry>
 122           <term><option>--show-machine</option></term>
 123
 124           <listitem><para>When showing the list of endpoints, show a
 125           column containing the names of containers they belong to.
 126           See
 127           <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
 128           </para></listitem>
 129       </varlistentry>
 130
 131       <varlistentry>
 132           <term><option>--unique</option></term>
 133
 134           <listitem><para>When showing the list of endpoints, show
 135           only "unique" names (of the form
 136           <literal>:<replaceable>number</replaceable>.<replaceable>number</replaceable></literal>).
 137           </para></listitem>
 138       </varlistentry>
 139
 140       <varlistentry>
 141           <term><option>--acquired</option></term>
 142
 143           <listitem><para>The opposite of <option>--unique</option> —
 144           only "well-known" names will be shown.</para></listitem>
 145       </varlistentry>
 146
 147       <varlistentry>
 148           <term><option>--activatable</option></term>
 149
 150           <listitem><para>When showing the list of endpoints, show
 151           only endpoints which have actually not been activated yet,
 152           but may be started automatically if accessed.</para>
 153           </listitem>
 154       </varlistentry>
 155
 156       <varlistentry>
 157           <term><option>--match=<replaceable>MATCH</replaceable></option></term>
 158
 159           <listitem><para>When showing messages being exchanged, show only the
 160           subset matching <replaceable>MATCH</replaceable>.</para></listitem>
 161           <!-- TODO: link to sd_bus_add_match when it is written? -->
 162       </varlistentry>
 163
 164       <varlistentry>
 165         <term><option>--no-legend</option></term>
 166
 167         <listitem>
 168           <para>Do not print the legend,
 169           i.e. the column headers and the
 170           footer.</para>
 171         </listitem>
 172       </varlistentry>
 173
 174       <xi:include href="standard-options.xml" xpointer="help" />
 175       <xi:include href="standard-options.xml" xpointer="version" />
 176       <xi:include href="standard-options.xml" xpointer="no-pager" />
 177     </variablelist>
 178   </refsect1>
 179
 180   <refsect1>
 181     <title>Commands</title>
 182
 183     <para>The following commands are understood:</para>
 184
 185     <variablelist>
 186       <varlistentry>
 187         <term><command>list</command></term>
 188
 189         <listitem><para>Show endpoints attached to the bus. This is
 190         the default if no command is specified.</para></listitem>
 191       </varlistentry>
 192
 193       <varlistentry>
 194         <term><command>monitor</command>  <arg choice="opt" rep="repeat"><replaceable>NAME</replaceable></arg></term>
 195
 196         <listitem><para>Dump messages being exchanged. If
 197         <replaceable>NAME</replaceable> is specified, show messages
 198         to or from this endpoint. Otherwise, show all messages on the
 199         bus.</para></listitem>
 200       </varlistentry>
 201
 202       <varlistentry>
 203         <term><command>status</command>  <arg choice="plain"><replaceable>NAME</replaceable></arg></term>
 204
 205         <listitem><para>Show process information and credentials of a
 206         bus endpoint.</para></listitem>
 207       </varlistentry>
 208
 209       <varlistentry>
 210         <term><command>help</command></term>
 211
 212         <listitem><para>Show command syntax help.</para></listitem>
 213       </varlistentry>
 214     </variablelist>
 215   </refsect1>
 216
 217   <refsect1>
 218     <title>See Also</title>
 219
 220     <para>
 221       <citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 222       <ulink url="http://freedesktop.org/wiki/Software/dbus">D-Bus</ulink>,
 223       <ulink url="https://code.google.com/p/d-bus/">kdbus</ulink>,
 224       <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 225       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 226       <citerefentry><refentrytitle>systemd-bus-proxyd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 227       <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 228     </para>
 229   </refsect1>
 230 </refentry>