[thirdparty/systemd.git] / man / busctl.xml

<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
This file is part of systemd.

Copyright 2014 Zbigniew Jędrzejewski-Szmek

systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.

systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="busctl"
          xmlns:xi="http://www.w3.org/2001/XInclude">

  <refentryinfo>
    <title>busctl</title>
    <productname>systemd</productname>

    <authorgroup>
      <author>
        <contrib>A monkey with a typewriter</contrib>
        <firstname>Zbigniew</firstname>
        <surname>Jędrzejewski-Szmek</surname>
        <email>zbyszek@in.waw.pl</email>
      </author>
    </authorgroup>
  </refentryinfo>

  <refmeta>
    <refentrytitle>busctl</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>busctl</refname>
    <refpurpose>Introspect the bus</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>busctl</command>
      <arg choice="opt" rep="repeat">OPTIONS</arg>
      <arg choice="opt">COMMAND</arg>
      <arg choice="opt" rep="repeat"><replaceable>NAME</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><command>busctl</command> may be used to
    introspect and monitor the D-Bus bus.</para>
  </refsect1>

  <refsect1>
    <title>Options</title>

    <para>The following options are understood:</para>

    <variablelist>
      <varlistentry>
          <term><option>--address=<replaceable>ADDRESS</replaceable></option></term>

          <listitem><para>Connect to the bus specified by
          <replaceable>ADDRESS</replaceable> instead of using suitable
          defaults for either the system or user bus (see
          <option>--system</option> and <option>--user</option>
          options).</para></listitem>
      </varlistentry>

      <varlistentry>
          <term><option>--show-machine</option></term>

          <listitem><para>When showing the list of endpoints, show a
          column containing the names of containers they belong to.
          See
          <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
          </para></listitem>
      </varlistentry>

      <varlistentry>
          <term><option>--unique</option></term>

          <listitem><para>When showing the list of endpoints, show
          only "unique" names (of the form
          <literal>:<replaceable>number</replaceable>.<replaceable>number</replaceable></literal>).
          </para></listitem>
      </varlistentry>

      <varlistentry>
          <term><option>--acquired</option></term>

          <listitem><para>The opposite of <option>--unique</option> —
          only "well-known" names will be shown.</para></listitem>
      </varlistentry>

      <varlistentry>
          <term><option>--activatable</option></term>

          <listitem><para>When showing the list of endpoints, show
          only endpoints which have actually not been activated yet,
          but may be started automatically if accessed.</para>
          </listitem>
      </varlistentry>

      <varlistentry>
          <term><option>--match=<replaceable>MATCH</replaceable></option></term>

          <listitem><para>When showing messages being exchanged, show only the
          subset matching <replaceable>MATCH</replaceable>.</para></listitem>
          <!-- TODO: link to sd_bus_add_match when it is written? -->
      </varlistentry>

      <varlistentry>
        <term><option>--no-legend</option></term>

        <listitem>
          <para>Do not print the legend,
          i.e. the column headers and the
          footer.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--size=</option></term>

        <listitem>
          <para>When used with the <command>capture</command> command
          specifies the maximum bus message size to capture
          ("snaplen"). Defaults to 4096 bytes.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--list</option></term>

        <listitem>
          <para>When used with the <command>tree</command> command shows a
          flat list of object paths instead of a tree.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--quiet</option></term>

        <listitem>
          <para>When used with the <command>call</command> command suppresses
          display of the response message.</para>
        </listitem>
      </varlistentry>

      <xi:include href="user-system-options.xml" xpointer="user" />
      <xi:include href="user-system-options.xml" xpointer="system" />
      <xi:include href="user-system-options.xml" xpointer="host" />
      <xi:include href="user-system-options.xml" xpointer="machine" />

      <xi:include href="standard-options.xml" xpointer="help" />
      <xi:include href="standard-options.xml" xpointer="version" />
      <xi:include href="standard-options.xml" xpointer="no-pager" />
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Commands</title>

    <para>The following commands are understood:</para>

    <variablelist>
      <varlistentry>
        <term><command>list</command></term>

        <listitem><para>Show service names on the bus. This is the
        default if no command is specified.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><command>status</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg></term>

        <listitem><para>Show process information and credentials of a
        bus service.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><command>monitor</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>

        <listitem><para>Dump messages being exchanged. If
        <replaceable>SERVICE</replaceable> is specified, show messages
        to or from this endpoint. Otherwise, show all messages on the
        bus. Use Ctrl-C to terminate dump.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><command>capture</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>

        <listitem><para>Similar to <command>monitor</command> but
        writes the output in pcap format (for details see the <ulink
        url="http://wiki.wireshark.org/Development/LibpcapFileFormat">Libpcap
        File Format</ulink> description. Make sure to redirect the
        output to STDOUT to a file. Tools like
        <citerefentry><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry>
        may be used to dissect and view the generated
        files.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><command>tree</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>

        <listitem><para>Shows an object tree of one or more
        services. If <replaceable>SERVICE</replaceable> is specified,
        show object tree of the specified services only. Otherwise,
        show all object trees of all services on the bus that acquired
        at least one well-known name.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><command>introspect</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg></term>

        <listitem><para>Show interfaces, methods, properties and
        signals of the specified object (identified by its path) on
        the specified service.</para></listitem>
      </varlistentry>

      <varlistentry>
        <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>ARGUMENT</replaceable></arg></arg></term>

        <listitem><para>Invoke a method and show the response. Takes a
        service name, object path, interface name and method name. If
        parameters shall be passed to the method call a signature
        string is required, followed by the individual arguments,
        individually formatted as textual parameters.</para></listitem>
      </varlistentry>

      <varlistentry>
        <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>PROPERTY</replaceable></arg></arg></term>

        <listitem><para>Retrieve the current value one or more object
        properties. Takes a service name and object path. Optionally
        takes an interface name and property name. If the property
        name is omited, shows all properties on the selected
        interface. If the interface is also omitted shows the
        properties of all interfaces. Multiple properties may be
        specified at once in which case their values will be shown one
        after the other.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><command>help</command></term>

        <listitem><para>Show command syntax help.</para></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>See Also</title>

    <para>
      <citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <ulink url="http://freedesktop.org/wiki/Software/dbus">D-Bus</ulink>,
      <ulink url="https://code.google.com/p/d-bus/">kdbus</ulink>,
      <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemd-bus-proxyd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry>
    </para>
  </refsect1>
</refentry>
Commit	Line	Data
708c143c ZJS	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
dfdebb1b ZJS	24	<refentry id="busctl"
dfdebb1b ZJS	25	xmlns:xi="http://www.w3.org/2001/XInclude">
708c143c ZJS	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>
708c143c ZJS	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
66f756d4	113	only endpoints which have actually not been activated yet,
708c143c ZJS	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>
dfdebb1b ZJS	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
1f70b087 LP	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
d9130355 LP	146	<varlistentry>
	147	<term><option>--list</option></term>
	148
	149	<listitem>
86349ffe	150	<para>When used with the <command>tree</command> command shows a
d9130355 LP	151	flat list of object paths instead of a tree.</para>
	152	</listitem>
	153	</varlistentry>
	154
781fa938 LP	155	<varlistentry>
	156	<term><option>--quiet</option></term>
	157
	158	<listitem>
	159	<para>When used with the <command>call</command> command suppresses
	160	display of the response message.</para>
	161	</listitem>
	162	</varlistentry>
	163
88ae7333 ZJS	164	<xi:include href="user-system-options.xml" xpointer="user" />
88ae7333 ZJS	165	<xi:include href="user-system-options.xml" xpointer="system" />
4f50d2ef ZJS	166	<xi:include href="user-system-options.xml" xpointer="host" />
4f50d2ef ZJS	167	<xi:include href="user-system-options.xml" xpointer="machine" />
88ae7333	168
dfdebb1b ZJS	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" />
708c143c ZJS	172	</variablelist>
	173	</refsect1>
	174
	175	<refsect1>
	176	<title>Commands</title>
	177
	178	<para>The following commands are understood:</para>
	179
	180	<variablelist>
	181	<varlistentry>
	182	<term><command>list</command></term>
	183
d9130355 LP	184	<listitem><para>Show service names on the bus. This is the
	185	default if no command is specified.</para></listitem>
	186	</varlistentry>
	187
	188	<varlistentry>
0171da06	189	<term><command>status</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg></term>
d9130355	190
0171da06 LP	191	<listitem><para>Show process information and credentials of a
0171da06 LP	192	bus service.</para></listitem>
708c143c ZJS	193	</varlistentry>
	194
	195	<varlistentry>
86349ffe	196	<term><command>monitor</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
708c143c ZJS	197
708c143c ZJS	198	<listitem><para>Dump messages being exchanged. If
86349ffe	199	<replaceable>SERVICE</replaceable> is specified, show messages
f5ca75f4	200	to or from this endpoint. Otherwise, show all messages on the
0171da06	201	bus. Use Ctrl-C to terminate dump.</para></listitem>
708c143c ZJS	202	</varlistentry>
708c143c ZJS	203
1f70b087	204	<varlistentry>
86349ffe	205	<term><command>capture</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
1f70b087 LP	206
	207	<listitem><para>Similar to <command>monitor</command> but
	208	writes the output in pcap format (for details see the <ulink
	209	url="http://wiki.wireshark.org/Development/LibpcapFileFormat">Libpcap
	210	File Format</ulink> description. Make sure to redirect the
	211	output to STDOUT to a file. Tools like
	212	<citerefentry><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry>
	213	may be used to dissect and view the generated
	214	files.</para></listitem>
	215	</varlistentry>
	216
708c143c	217	<varlistentry>
0171da06	218	<term><command>tree</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
708c143c	219
0171da06 LP	220	<listitem><para>Shows an object tree of one or more
	221	services. If <replaceable>SERVICE</replaceable> is specified,
	222	show object tree of the specified services only. Otherwise,
	223	show all object trees of all services on the bus that acquired
	224	at least one well-known name.</para></listitem>
	225	</varlistentry>
	226
	227	<varlistentry>
	228	<term><command>introspect</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg></term>
	229
	230	<listitem><para>Show interfaces, methods, properties and
	231	signals of the specified object (identified by its path) on
	232	the specified service.</para></listitem>
708c143c ZJS	233	</varlistentry>
	234
	235	<varlistentry>
0171da06	236	<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>ARGUMENT</replaceable></arg></arg></term>
781fa938	237
d55192ad LP	238	<listitem><para>Invoke a method and show the response. Takes a
	239	service name, object path, interface name and method name. If
	240	parameters shall be passed to the method call a signature
0171da06 LP	241	string is required, followed by the individual arguments,
0171da06 LP	242	individually formatted as textual parameters.</para></listitem>
d55192ad LP	243	</varlistentry>
	244
	245	<varlistentry>
0171da06	246	<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>PROPERTY</replaceable></arg></arg></term>
d55192ad LP	247
	248	<listitem><para>Retrieve the current value one or more object
	249	properties. Takes a service name and object path. Optionally
	250	takes an interface name and property name. If the property
	251	name is omited, shows all properties on the selected
	252	interface. If the interface is also omitted shows the
	253	properties of all interfaces. Multiple properties may be
	254	specified at once in which case their values will be shown one
	255	after the other.</para></listitem>
781fa938 LP	256	</varlistentry>
	257
	258	<varlistentry>
708c143c ZJS	259	<term><command>help</command></term>
	260
	261	<listitem><para>Show command syntax help.</para></listitem>
	262	</varlistentry>
	263	</variablelist>
	264	</refsect1>
	265
	266	<refsect1>
	267	<title>See Also</title>
	268
	269	<para>
	270	<citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
	271	<ulink url="http://freedesktop.org/wiki/Software/dbus">D-Bus</ulink>,
	272	<ulink url="https://code.google.com/p/d-bus/">kdbus</ulink>,
	273	<citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
	274	<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
	275	<citerefentry><refentrytitle>systemd-bus-proxyd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1f70b087 LP	276	<citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1f70b087 LP	277	<citerefentry><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry>
708c143c ZJS	278	</para>
	279	</refsect1>
	280	</refentry>