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