busctl.xml revision 7f3fdb7f19a109fa3d1be92926bfe4cea1817da5
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann This file is part of systemd.
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann Copyright 2014 Zbigniew Jędrzejewski-Szmek
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann systemd is free software; you can redistribute it and/or modify it
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann under the terms of the GNU Lesser General Public License as published by
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann the Free Software Foundation; either version 2.1 of the License, or
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann (at your option) any later version.
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann systemd is distributed in the hope that it will be useful, but
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann WITHOUT ANY WARRANTY; without even the implied warranty of
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann Lesser General Public License for more details.
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann You should have received a copy of the GNU Lesser General Public License
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann along with systemd; If not, see <http://www.gnu.org/licenses/>.
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <refentryinfo>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <authorgroup>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <contrib>A monkey with a typewriter</contrib>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </authorgroup>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </refentryinfo>
5476ad087c0f2d45ab0dab1bab9ef3e9d70418bcMarcel Holtmann </refnamediv>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <refsynopsisdiv>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <cmdsynopsis>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <arg choice="opt" rep="repeat">OPTIONS</arg>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <arg choice="opt" rep="repeat"><replaceable>NAME</replaceable></arg>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </cmdsynopsis>
5476ad087c0f2d45ab0dab1bab9ef3e9d70418bcMarcel Holtmann </refsynopsisdiv>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <para><command>busctl</command> may be used to
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann introspect and monitor the D-Bus bus.</para>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <para>The following options are understood:</para>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <variablelist>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <term><option>--address=<replaceable>ADDRESS</replaceable></option></term>
5476ad087c0f2d45ab0dab1bab9ef3e9d70418bcMarcel Holtmann <listitem><para>Connect to the bus specified by
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <replaceable>ADDRESS</replaceable> instead of using suitable
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann defaults for either the system or user bus (see
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <option>--system</option> and <option>--user</option>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <term><option>--show-machine</option></term>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <listitem><para>When showing the list of peers, show a
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann column containing the names of containers they belong to.
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <listitem><para>When showing the list of peers, show only
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann "unique" names (of the form
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <literal>:<replaceable>number</replaceable>.<replaceable>number</replaceable></literal>).
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <listitem><para>The opposite of <option>--unique</option> —
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann only "well-known" names will be shown.</para></listitem>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <listitem><para>When showing the list of peers, show only
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann peers which have actually not been activated yet, but may be
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann started automatically if accessed.</para>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
7cfa80f07e94c3e48703d145ef03a73dd6e7b983Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <term><option>--match=<replaceable>MATCH</replaceable></option></term>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <listitem><para>When showing messages being exchanged, show only the
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann subset matching <replaceable>MATCH</replaceable>.</para></listitem>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <!-- TODO: link to sd_bus_add_match when it is written? -->
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <para>When used with the <command>capture</command> command,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann specifies the maximum bus message size to capture
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann ("snaplen"). Defaults to 4096 bytes.</para>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <para>When used with the <command>tree</command> command, shows a
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann flat list of object paths instead of a tree.</para>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <para>When used with the <command>call</command> command,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann suppresses display of the response message payload. Note that even
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann if this option is specified, errors returned will still be
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann printed and the tool will indicate success or failure with
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann the process exit code.</para>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <para>When used with the <command>call</command> or
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <command>get-property</command> command, shows output in a
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann more verbose format.</para>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <term><option>--expect-reply=</option><replaceable>BOOL</replaceable></term>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <para>When used with the <command>call</command> command,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann specifies whether <command>busctl</command> shall wait for
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann completion of the method call, output the returned method
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann response data, and return success or failure via the process
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann exit code. If this is set to <literal>no</literal>, the
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann method call will be issued but no response is expected, the
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann tool terminates immediately, and thus no response can be
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann shown, and no success or failure is returned via the exit
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann code. To only suppress output of the reply message payload,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann use <option>--quiet</option> above. Defaults to
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <term><option>--auto-start=</option><replaceable>BOOL</replaceable></term>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <para>When used with the <command>call</command> command, specifies
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann whether the method call should implicitly activate the
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann called service, should it not be running yet but is
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann configured to be auto-started. Defaults to
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <term><option>--allow-interactive-authorization=</option><replaceable>BOOL</replaceable></term>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <para>When used with the <command>call</command> command,
5476ad087c0f2d45ab0dab1bab9ef3e9d70418bcMarcel Holtmann specifies whether the services may enforce interactive
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann authorization while executing the operation, if the security
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann policy is configured for this. Defaults to
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <term><option>--timeout=</option><replaceable>SECS</replaceable></term>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <para>When used with the <command>call</command> command,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann specifies the maximum time to wait for method call
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann completion. If no time unit is specified, assumes
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann seconds. The usual other units are understood, too (ms, us,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann s, min, h, d, w, month, y). Note that this timeout does not
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann apply if <option>--expect-reply=no</option> is used, as the
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann tool does not wait for any reply message then. When not
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann specified or when set to 0, the default of
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <term><option>--augment-creds=</option><replaceable>BOOL</replaceable></term>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <para>Controls whether credential data reported by
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <command>list</command> or <command>status</command> shall
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann be augmented with data from
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <filename>/proc</filename>. When this is turned on, the data
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann shown is possibly inconsistent, as the data read from
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <filename>/proc</filename> might be more recent than the rest of
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann the credential information. Defaults to <literal>yes</literal>.</para>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <xi:include href="user-system-options.xml" xpointer="user" />
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <xi:include href="user-system-options.xml" xpointer="system" />
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <xi:include href="user-system-options.xml" xpointer="host" />
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <xi:include href="user-system-options.xml" xpointer="machine" />
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <xi:include href="standard-options.xml" xpointer="no-pager" />
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <xi:include href="standard-options.xml" xpointer="no-legend" />
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <xi:include href="standard-options.xml" xpointer="help" />
5476ad087c0f2d45ab0dab1bab9ef3e9d70418bcMarcel Holtmann <xi:include href="standard-options.xml" xpointer="version" />
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </variablelist>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <para>The following commands are understood:</para>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <variablelist>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <listitem><para>Show all peers on the bus, by their service
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann names. By default, shows both unique and well-known names, but
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann this may be changed with the <option>--unique</option> and
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <option>--acquired</option> switches. This is the default
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann operation if no command is specified.</para></listitem>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <term><command>status</command> <arg choice="opt"><replaceable>SERVICE</replaceable></arg></term>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <listitem><para>Show process information and credentials of a
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann bus service (if one is specified by its unique or well-known
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann name), a process (if one is specified by its numeric PID), or
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann the owner of the bus (if no parameter is
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <term><command>monitor</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <listitem><para>Dump messages being exchanged. If
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <replaceable>SERVICE</replaceable> is specified, show messages
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann to or from this peer, identified by its well-known or unique
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann name. Otherwise, show all messages on the bus. Use Ctrl-C to
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <term><command>capture</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <listitem><para>Similar to <command>monitor</command> but
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann writes the output in pcap format (for details, see the <ulink
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann url="http://wiki.wireshark.org/Development/LibpcapFileFormat">Libpcap
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann File Format</ulink> description. Make sure to redirect the
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann output to STDOUT to a file. Tools like
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <citerefentry project='die-net'><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann may be used to dissect and view the generated
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <term><command>tree</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <listitem><para>Shows an object tree of one or more
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann services. If <replaceable>SERVICE</replaceable> is specified,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann show object tree of the specified services only. Otherwise,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann show all object trees of all services on the bus that acquired
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann at least one well-known name.</para></listitem>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <term><command>introspect</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="opt"><replaceable>INTERFACE</replaceable></arg></term>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <listitem><para>Show interfaces, methods, properties and
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann signals of the specified object (identified by its path) on
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann the specified service. If the interface argument is passed, the
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann output is limited to members of the specified
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <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>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <listitem><para>Invoke a method and show the response. Takes a
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann service name, object path, interface name and method name. If
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann parameters shall be passed to the method call, a signature
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann string is required, followed by the arguments, individually
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann formatted as strings. For details on the formatting used, see
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann below. To suppress output of the returned data, use the
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <option>--quiet</option> option.</para></listitem>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <term><command>get-property</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" rep="repeat"><replaceable>PROPERTY</replaceable></arg></term>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <listitem><para>Retrieve the current value of one or more
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann object properties. Takes a service name, object path,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann interface name and property name. Multiple properties may be
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann specified at once, in which case their values will be shown one
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann after the other, separated by newlines. The output is, by
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann default, in terse format. Use <option>--verbose</option> for a
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann more elaborate output format.</para></listitem>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <term><command>set-property</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>PROPERTY</replaceable></arg> <arg choice="plain"><replaceable>SIGNATURE</replaceable></arg> <arg choice="plain" rep="repeat"><replaceable>ARGUMENT</replaceable></arg></term>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <listitem><para>Set the current value of an object
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann property. Takes a service name, object path, interface name,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann property name, property signature, followed by a list of
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann parameters formatted as strings.</para></listitem>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <listitem><para>Show command syntax help.</para></listitem>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </varlistentry>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann </variablelist>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <command>set-property</command> commands take a signature string
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann followed by a list of parameters formatted as string (for details
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann on D-Bus signature strings, see the <ulink
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann url="http://dbus.freedesktop.org/doc/dbus-specification.html#type-system">Type
c6f3f5b4b3ec439ae911ca0644237d96fd31893eMarcel Holtmann system chapter of the D-Bus specification</ulink>). For simple
c6f3f5b4b3ec439ae911ca0644237d96fd31893eMarcel Holtmann types, each parameter following the signature should simply be the
c6f3f5b4b3ec439ae911ca0644237d96fd31893eMarcel Holtmann parameter's value formatted as string. Positive boolean values may
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann be formatted as <literal>true</literal>, <literal>yes</literal>,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <literal>on</literal>, or <literal>1</literal>; negative boolean
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann values may be specified as <literal>false</literal>,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <literal>no</literal>, <literal>off</literal>, or
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <literal>0</literal>. For arrays, a numeric argument for the
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann number of entries followed by the entries shall be specified. For
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann variants, the signature of the contents shall be specified,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann followed by the contents. For dictionaries and structs, the
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann contents of them shall be directly specified.</para>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <para>For example,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <programlisting>s jawoll</programlisting> is the formatting
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann of a single string <literal>jawoll</literal>.</para>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <programlisting>as 3 hello world foobar</programlisting>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann is the formatting of a string array with three entries,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <literal>hello</literal>, <literal>world</literal> and
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <programlisting>a{sv} 3 One s Eins Two u 2 Yes b true</programlisting>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann is the formatting of a dictionary
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann array that maps strings to variants, consisting of three
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann entries. The string <literal>One</literal> is assigned the
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <literal>Two</literal> is assigned the 32-bit unsigned
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann integer 2. The string <literal>Yes</literal> is assigned a
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann positive boolean.</para>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <para>Note that the <command>call</command>,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <command>get-property</command>, <command>introspect</command>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann commands will also generate output in this format for the returned
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann data. Since this format is sometimes too terse to be easily
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <command>get-property</command> commands may generate a more
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann verbose, multi-line output when passed the
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <para>The following two commands first write a property and then
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann read it back. The property is found on the
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <literal>/org/freedesktop/systemd1</literal> object of the
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <literal>org.freedesktop.systemd1</literal> service. The name of
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann the property is <literal>LogLevel</literal> on the
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <literal>org.freedesktop.systemd1.Manager</literal>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann interface. The property contains a single string:</para>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <programlisting># busctl set-property org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager LogLevel s debug
5476ad087c0f2d45ab0dab1bab9ef3e9d70418bcMarcel Holtmann# busctl get-property org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager LogLevel
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmanns "debug"</programlisting>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <para>The following two commands read a property that contains
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann an array of strings, and first show it in terse format, followed
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann by verbose format:</para>
5476ad087c0f2d45ab0dab1bab9ef3e9d70418bcMarcel Holtmann <programlisting>$ busctl get-property org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager Environment
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmannas 2 "LANG=en_US.UTF-8" "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin"
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann$ busctl get-property --verbose org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager Environment
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann STRING "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin";
5476ad087c0f2d45ab0dab1bab9ef3e9d70418bcMarcel Holtmann};</programlisting>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <para>The following command invokes the
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <literal>org.freedesktop.systemd1.Manager</literal>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann interface of the
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <literal>/org/freedesktop/systemd1</literal> object
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann of the <literal>org.freedesktop.systemd1</literal>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann service, and passes it two strings
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <literal>replace</literal>. As a result of the method
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann call, a single object path parameter is received and
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann shown:</para>
c6f3f5b4b3ec439ae911ca0644237d96fd31893eMarcel Holtmann <programlisting># busctl call org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager StartUnit ss "cups.service" "replace"
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmanno "/org/freedesktop/systemd1/job/42684"</programlisting>
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <citerefentry project='dbus'><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <ulink url="http://freedesktop.org/wiki/Software/dbus">D-Bus</ulink>,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <citerefentry><refentrytitle>systemd-bus-proxyd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
94f5bbc626f2a4102debd9b17c964170a887cb49Marcel Holtmann <citerefentry project='die-net'><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry>