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>-H</option></term>
  75         <term><option>--host</option></term>
  76
  77         <listitem>
  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
  81           instance.</para>
  82         </listitem>
  83       </varlistentry>
  84
  85       <varlistentry>
  86           <term><option>-M</option></term>
  87           <term><option>--machine=</option></term>
  88
  89           <listitem><para>Execute the operation on a local container.
  90           Specify a container name to connect to.</para></listitem>
  91       </varlistentry>
  92
  93       <varlistentry>
  94           <term><option>--address=<replaceable>ADDRESS</replaceable></option></term>
  95
  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>
 101       </varlistentry>
 102
 103       <varlistentry>
 104           <term><option>--show-machine</option></term>
 105
 106           <listitem><para>When showing the list of endpoints, show a
 107           column containing the names of containers they belong to.
 108           See
 109           <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
 110           </para></listitem>
 111       </varlistentry>
 112
 113       <varlistentry>
 114           <term><option>--unique</option></term>
 115
 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>).
 119           </para></listitem>
 120       </varlistentry>
 121
 122       <varlistentry>
 123           <term><option>--acquired</option></term>
 124
 125           <listitem><para>The opposite of <option>--unique</option> —
 126           only "well-known" names will be shown.</para></listitem>
 127       </varlistentry>
 128
 129       <varlistentry>
 130           <term><option>--activatable</option></term>
 131
 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>
 135           </listitem>
 136       </varlistentry>
 137
 138       <varlistentry>
 139           <term><option>--match=<replaceable>MATCH</replaceable></option></term>
 140
 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? -->
 144       </varlistentry>
 145
 146       <varlistentry>
 147         <term><option>--no-legend</option></term>
 148
 149         <listitem>
 150           <para>Do not print the legend,
 151           i.e. the column headers and the
 152           footer.</para>
 153         </listitem>
 154       </varlistentry>
 155
 156       <xi:include href="user-system-options.xml" xpointer="user" />
 157       <xi:include href="user-system-options.xml" xpointer="system" />
 158
 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" />
 162     </variablelist>
 163   </refsect1>
 164
 165   <refsect1>
 166     <title>Commands</title>
 167
 168     <para>The following commands are understood:</para>
 169
 170     <variablelist>
 171       <varlistentry>
 172         <term><command>list</command></term>
 173
 174         <listitem><para>Show endpoints attached to the bus. This is
 175         the default if no command is specified.</para></listitem>
 176       </varlistentry>
 177
 178       <varlistentry>
 179         <term><command>monitor</command>  <arg choice="opt" rep="repeat"><replaceable>NAME</replaceable></arg></term>
 180
 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>
 185       </varlistentry>
 186
 187       <varlistentry>
 188         <term><command>status</command>  <arg choice="plain"><replaceable>NAME</replaceable></arg></term>
 189
 190         <listitem><para>Show process information and credentials of a
 191         bus endpoint.</para></listitem>
 192       </varlistentry>
 193
 194       <varlistentry>
 195         <term><command>help</command></term>
 196
 197         <listitem><para>Show command syntax help.</para></listitem>
 198       </varlistentry>
 199     </variablelist>
 200   </refsect1>
 201
 202   <refsect1>
 203     <title>See Also</title>
 204
 205     <para>
 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>
 213     </para>
 214   </refsect1>
 215 </refentry>