shaba/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-12-23 21:35:11 +03:00
Code
d0e11b9e17
systemd/man/busctl.xml

606 lines
26 KiB
XML
Raw Normal View History

man: drop mode line in file headers This is already included in .dir-locals, so we don't need it in the files themselves.
2018-07-03 00:15:39 +03:00
<?xml version='1.0'?>
man: use same header for all files The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml
2019-03-14 16:40:58 +03:00
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
man: use same version in public and system ident.
2023-12-25 17:48:33 +03:00
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
license: LGPL-2.1+ -> LGPL-2.1-or-later
2020-11-09 07:23:58 +03:00
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
man: add busctl(1)
2014-01-12 08:44:34 +04:00
man: xinclude --help/--version/--no-pager
2014-02-13 23:33:51 +04:00
<refentry id="busctl"
xmlns:xi="http://www.w3.org/2001/XInclude">
man: add busctl(1)
2014-01-12 08:44:34 +04:00
<refentryinfo>
<title>busctl</title>
<productname>systemd</productname>
</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>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
<refsect1>
<title>Commands</title>
<para>The following commands are understood:</para>
<variablelist>
<varlistentry>
Revert "man: add missing <cmdsynopsis> wrapper" This reverts commit 35fc10756bc5302d2dff1c235f864fa23a6d8771. Although DocBook 4.5 states that `cmdsynopsis` can be used within `term` [1], and `term` within `varlistentry`, `man` does not display the list of commands after this change. FWIW, `cmdsynopsis` is used tree-wide within `refsynopsisdiv` only. [1] https://tdg.docbook.org/tdg/4.5/term
2024-01-18 16:45:24 +03:00
<term><command>list</command></term>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
<listitem><para>Show all peers on the bus, by their service
names. By default, shows both unique and well-known names, but
this may be changed with the <option>--unique</option> and
<option>--acquired</option> switches. This is the default
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
operation if no command is specified.</para>
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
</varlistentry>
<varlistentry>
Revert "man: add missing <cmdsynopsis> wrapper" This reverts commit 35fc10756bc5302d2dff1c235f864fa23a6d8771. Although DocBook 4.5 states that `cmdsynopsis` can be used within `term` [1], and `term` within `varlistentry`, `man` does not display the list of commands after this change. FWIW, `cmdsynopsis` is used tree-wide within `refsynopsisdiv` only. [1] https://tdg.docbook.org/tdg/4.5/term
2024-01-18 16:45:24 +03:00
<term><command>status</command> <arg choice="opt"><replaceable>SERVICE</replaceable></arg></term>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
<listitem><para>Show process information and credentials of a
bus service (if one is specified by its unique or well-known
name), a process (if one is specified by its numeric PID), or
the owner of the bus (if no parameter is
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
specified).</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 18:03:38 +03:00
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
</varlistentry>
<varlistentry>
Revert "man: add missing <cmdsynopsis> wrapper" This reverts commit 35fc10756bc5302d2dff1c235f864fa23a6d8771. Although DocBook 4.5 states that `cmdsynopsis` can be used within `term` [1], and `term` within `varlistentry`, `man` does not display the list of commands after this change. FWIW, `cmdsynopsis` is used tree-wide within `refsynopsisdiv` only. [1] https://tdg.docbook.org/tdg/4.5/term
2024-01-18 16:45:24 +03:00
<term><command>monitor</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
<listitem><para>Dump messages being exchanged. If
<replaceable>SERVICE</replaceable> is specified, show messages
to or from this peer, identified by its well-known or unique
name. Otherwise, show all messages on the bus. Use
<keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
to terminate the dump.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 18:03:38 +03:00
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
</varlistentry>
<varlistentry>
Revert "man: add missing <cmdsynopsis> wrapper" This reverts commit 35fc10756bc5302d2dff1c235f864fa23a6d8771. Although DocBook 4.5 states that `cmdsynopsis` can be used within `term` [1], and `term` within `varlistentry`, `man` does not display the list of commands after this change. FWIW, `cmdsynopsis` is used tree-wide within `refsynopsisdiv` only. [1] https://tdg.docbook.org/tdg/4.5/term
2024-01-18 16:45:24 +03:00
<term><command>capture</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
<listitem><para>Similar to <command>monitor</command> but
bus-dump: change capture output to use pcapng (#21738) This patch changes busctl capture to generate pcapng format instead of the legacy pcap format files. It includes basic meta-data in the file and still uses microsecond time resolution. In future, more things can be added such as high resolution timestams, statistics, etc. PCAP Next Generation capture file format is what tshark uses and is in process of being standardized in IETF. It is also readable with libpcap. $ capinfos /tmp/new.pcapng File name: /tmp/new.pcapng File type: Wireshark/... - pcapng File encapsulation: D-Bus File timestamp precision: microseconds (6) Packet size limit: file hdr: (not set) Packet size limit: inferred: 4096 bytes Number of packets: 22 File size: 21kB Data size: 20kB Capture duration: 0.005694 seconds First packet time: 2021-12-11 11:57:42.788374 Last packet time: 2021-12-11 11:57:42.794068 Data byte rate: 3,671kBps Data bit rate: 29Mbps Average packet size: 950.27 bytes Average packet rate: 3,863 packets/s SHA256: b85ed8b094af60c64aa6d9db4a91404e841736d36b9e662d707db9e4096148f1 RIPEMD160: 81f9bac7ec0ec5cd1d55ede136a5c90413894e3a SHA1: 8400822ef724b934d6000f5b7604b9e6e91be011 Strict time order: True Capture oper-sys: Linux 5.14.0-0.bpo.2-amd64 Capture application: systemd 250 (250-rc2-33-gdc79ae2+) Number of interfaces in file: 1 Interface #0 info: Encapsulation = D-Bus (146 - dbus) Capture length = 4096 Time precision = microseconds (6) Time ticks per second = 1000000 Number of stat entries = 0 Number of packets = 22
2021-12-25 09:07:40 +03:00
writes the output in pcapng format (for details, see
<ulink url="https://github.com/pcapng/pcapng/">
PCAP Next Generation (pcapng) Capture File Format</ulink>).
Make sure to redirect standard output to a file or pipe. Tools like
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
<citerefentry project='die-net'><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry>
may be used to dissect and view the resulting
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
files.</para>
<xi:include href="version-info.xml" xpointer="v218"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
</varlistentry>
<varlistentry>
Revert "man: add missing <cmdsynopsis> wrapper" This reverts commit 35fc10756bc5302d2dff1c235f864fa23a6d8771. Although DocBook 4.5 states that `cmdsynopsis` can be used within `term` [1], and `term` within `varlistentry`, `man` does not display the list of commands after this change. FWIW, `cmdsynopsis` is used tree-wide within `refsynopsisdiv` only. [1] https://tdg.docbook.org/tdg/4.5/term
2024-01-18 16:45:24 +03:00
<term><command>tree</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
<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
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
at least one well-known name.</para>
<xi:include href="version-info.xml" xpointer="v218"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
</varlistentry>
<varlistentry>
Revert "man: add missing <cmdsynopsis> wrapper" This reverts commit 35fc10756bc5302d2dff1c235f864fa23a6d8771. Although DocBook 4.5 states that `cmdsynopsis` can be used within `term` [1], and `term` within `varlistentry`, `man` does not display the list of commands after this change. FWIW, `cmdsynopsis` is used tree-wide within `refsynopsisdiv` only. [1] https://tdg.docbook.org/tdg/4.5/term
2024-01-18 16:45:24 +03:00
<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>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
<listitem><para>Show interfaces, methods, properties and
signals of the specified object (identified by its path) on
the specified service. If the interface argument is passed, the
output is limited to members of the specified
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
interface.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 18:03:38 +03:00
<xi:include href="version-info.xml" xpointer="v218"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
</varlistentry>
<varlistentry>
Revert "man: add missing <cmdsynopsis> wrapper" This reverts commit 35fc10756bc5302d2dff1c235f864fa23a6d8771. Although DocBook 4.5 states that `cmdsynopsis` can be used within `term` [1], and `term` within `varlistentry`, `man` does not display the list of commands after this change. FWIW, `cmdsynopsis` is used tree-wide within `refsynopsisdiv` only. [1] https://tdg.docbook.org/tdg/4.5/term
2024-01-18 16:45:24 +03:00
<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>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
<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 arguments, individually
formatted as strings. For details on the formatting used, see
below. To suppress output of the returned data, use the
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<option>--quiet</option> option.</para>
<xi:include href="version-info.xml" xpointer="v218"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
</varlistentry>
<varlistentry>
Revert "man: add missing <cmdsynopsis> wrapper" This reverts commit 35fc10756bc5302d2dff1c235f864fa23a6d8771. Although DocBook 4.5 states that `cmdsynopsis` can be used within `term` [1], and `term` within `varlistentry`, `man` does not display the list of commands after this change. FWIW, `cmdsynopsis` is used tree-wide within `refsynopsisdiv` only. [1] https://tdg.docbook.org/tdg/4.5/term
2024-01-18 16:45:24 +03:00
<term><command>emit</command> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="plain"><replaceable>INTERFACE</replaceable></arg> <arg choice="plain"><replaceable>SIGNAL</replaceable></arg> <arg choice="opt"><replaceable>SIGNATURE</replaceable> <arg choice="opt" rep="repeat"><replaceable>ARGUMENT</replaceable></arg></arg></term>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
tree-wide: "a" -> "an"
2021-06-30 15:26:47 +03:00
<listitem><para>Emit a signal. Takes an object path, interface name and method name. If parameters
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
shall be passed, a signature string is required, followed by the arguments, individually formatted as
strings. For details on the formatting used, see below. To specify the destination of the signal,
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
use the <option>--destination=</option> option.</para>
<xi:include href="version-info.xml" xpointer="v242"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
</varlistentry>
<varlistentry>
Revert "man: add missing <cmdsynopsis> wrapper" This reverts commit 35fc10756bc5302d2dff1c235f864fa23a6d8771. Although DocBook 4.5 states that `cmdsynopsis` can be used within `term` [1], and `term` within `varlistentry`, `man` does not display the list of commands after this change. FWIW, `cmdsynopsis` is used tree-wide within `refsynopsisdiv` only. [1] https://tdg.docbook.org/tdg/4.5/term
2024-01-18 16:45:24 +03:00
<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>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
<listitem><para>Retrieve the current value of one or more
object properties. Takes a service name, object path,
interface name and property name. Multiple properties may be
specified at once, in which case their values will be shown one
after the other, separated by newlines. The output is, by
default, in terse format. Use <option>--verbose</option> for a
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
more elaborate output format.</para>
<xi:include href="version-info.xml" xpointer="v218"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
</varlistentry>
<varlistentry>
Revert "man: add missing <cmdsynopsis> wrapper" This reverts commit 35fc10756bc5302d2dff1c235f864fa23a6d8771. Although DocBook 4.5 states that `cmdsynopsis` can be used within `term` [1], and `term` within `varlistentry`, `man` does not display the list of commands after this change. FWIW, `cmdsynopsis` is used tree-wide within `refsynopsisdiv` only. [1] https://tdg.docbook.org/tdg/4.5/term
2024-01-18 16:45:24 +03:00
<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>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
<listitem><para>Set the current value of an object
property. Takes a service name, object path, interface name,
property name, property signature, followed by a list of
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
parameters formatted as strings.</para>
<xi:include href="version-info.xml" xpointer="v218"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
</varlistentry>
<varlistentry>
Revert "man: add missing <cmdsynopsis> wrapper" This reverts commit 35fc10756bc5302d2dff1c235f864fa23a6d8771. Although DocBook 4.5 states that `cmdsynopsis` can be used within `term` [1], and `term` within `varlistentry`, `man` does not display the list of commands after this change. FWIW, `cmdsynopsis` is used tree-wide within `refsynopsisdiv` only. [1] https://tdg.docbook.org/tdg/4.5/term
2024-01-18 16:45:24 +03:00
<term><command>help</command></term>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<listitem><para>Show command syntax help.</para>
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
</varlistentry>
</variablelist>
</refsect1>
man: add busctl(1)
2014-01-12 08:44:34 +04:00
<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>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
options).</para>
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
man: add busctl(1)
2014-01-12 08:44:34 +04:00
</varlistentry>
<varlistentry>
<term><option>--show-machine</option></term>
man: be more careful with the wording in busctl(1)
2015-06-19 23:29:29 +03:00
<listitem><para>When showing the list of peers, show a
man: add busctl(1)
2014-01-12 08:44:34 +04:00
column containing the names of containers they belong to.
See
<citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
</para>
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
man: add busctl(1)
2014-01-12 08:44:34 +04:00
</varlistentry>
<varlistentry>
<term><option>--unique</option></term>
man: be more careful with the wording in busctl(1)
2015-06-19 23:29:29 +03:00
<listitem><para>When showing the list of peers, show only
"unique" names (of the form
man: add busctl(1)
2014-01-12 08:44:34 +04:00
<literal>:<replaceable>number</replaceable>.<replaceable>number</replaceable></literal>).
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
</para>
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
man: add busctl(1)
2014-01-12 08:44:34 +04:00
</varlistentry>
<varlistentry>
<term><option>--acquired</option></term>
<listitem><para>The opposite of <option>--unique</option> —
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
only "well-known" names will be shown.</para>
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
man: add busctl(1)
2014-01-12 08:44:34 +04:00
</varlistentry>
<varlistentry>
<term><option>--activatable</option></term>
man: be more careful with the wording in busctl(1)
2015-06-19 23:29:29 +03:00
<listitem><para>When showing the list of peers, show only
peers which have actually not been activated yet, but may be
started automatically if accessed.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v209"/>
man: add busctl(1)
2014-01-12 08:44:34 +04:00
</listitem>
</varlistentry>
<varlistentry>
<term><option>--match=<replaceable>MATCH</replaceable></option></term>
<listitem><para>When showing messages being exchanged, show only the
man: add link to sd_bus_add_match to busctl.xml
2016-06-24 16:32:57 +03:00
subset matching <replaceable>MATCH</replaceable>.
See
<citerefentry><refentrytitle>sd_bus_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
</para>
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
man: add busctl(1)
2014-01-12 08:44:34 +04:00
</varlistentry>
man: xinclude --help/--version/--no-pager
2014-02-13 23:33:51 +04:00
busctl: add new "capture" verb to record bus messages in libpcap compatible files, for dissection with wireshark
2014-10-30 03:13:11 +03:00
<varlistentry>
<term><option>--size=</option></term>
<listitem>
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
<para>When used with the <command>capture</command> command,
busctl: add new "capture" verb to record bus messages in libpcap compatible files, for dissection with wireshark
2014-10-30 03:13:11 +03:00
specifies the maximum bus message size to capture
("snaplen"). Defaults to 4096 bytes.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v218"/>
busctl: add new "capture" verb to record bus messages in libpcap compatible files, for dissection with wireshark
2014-10-30 03:13:11 +03:00
</listitem>
</varlistentry>
busctl: add "tree" command to explore object trees
2014-11-10 21:24:48 +03:00
<varlistentry>
<term><option>--list</option></term>
<listitem>
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
<para>When used with the <command>tree</command> command, shows a
busctl: add "tree" command to explore object trees
2014-11-10 21:24:48 +03:00
flat list of object paths instead of a tree.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v218"/>
busctl: add "tree" command to explore object trees
2014-11-10 21:24:48 +03:00
</listitem>
</varlistentry>
busctl: add new "call" command to invoke methods on a service
2014-11-14 15:11:10 +03:00
<varlistentry>
man: add missing options
2017-12-04 15:02:09 +03:00
<term><option>-q</option></term>
busctl: add new "call" command to invoke methods on a service
2014-11-14 15:11:10 +03:00
<term><option>--quiet</option></term>
<listitem>
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
<para>When used with the <command>call</command> command,
busctl: add options to control message header flags when invoking methods
2014-11-21 22:13:26 +03:00
suppresses display of the response message payload. Note that even
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
if this option is specified, errors returned will still be
busctl: add options to control message header flags when invoking methods
2014-11-21 22:13:26 +03:00
printed and the tool will indicate success or failure with
the process exit code.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 18:03:38 +03:00
<xi:include href="version-info.xml" xpointer="v218"/>
busctl: add new "call" command to invoke methods on a service
2014-11-14 15:11:10 +03:00
</listitem>
</varlistentry>
busctl: show property values in "introspect" output, add "set-property" command, and support both a terse and a verbose output format
2014-11-21 01:12:29 +03:00
<varlistentry>
<term><option>--verbose</option></term>
<listitem>
<para>When used with the <command>call</command> or
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
<command>get-property</command> command, shows output in a
busctl: show property values in "introspect" output, add "set-property" command, and support both a terse and a verbose output format
2014-11-21 01:12:29 +03:00
more verbose format.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v218"/>
busctl: show property values in "introspect" output, add "set-property" command, and support both a terse and a verbose output format
2014-11-21 01:12:29 +03:00
</listitem>
</varlistentry>
busctl: add introspect --xml-interface This wraps the call to org.freedesktop.DBus.Introspectable.Introspect. Using "busctl call" directly is inconvenient because busctl escapes the string before printing. Example: $ busctl introspect --xml org.freedesktop.systemd1 /org/freedesktop/systemd1 | pygmentize -lxml | less -RF
2019-04-21 23:23:45 +03:00
<varlistentry>
<term><option>--xml-interface</option></term>
<listitem>
<para>When used with the <command>introspect</command> call, dump the XML description received from
the D-Bus <constant>org.freedesktop.DBus.Introspectable.Introspect</constant> call instead of the
normal output.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v243"/>
busctl: add introspect --xml-interface This wraps the call to org.freedesktop.DBus.Introspectable.Introspect. Using "busctl call" directly is inconvenient because busctl escapes the string before printing. Example: $ busctl introspect --xml org.freedesktop.systemd1 /org/freedesktop/systemd1 | pygmentize -lxml | less -RF
2019-04-21 23:23:45 +03:00
</listitem>
</varlistentry>
busctl: add a --json= output mode A new switch "-j" or "--json=" is added which transforms dbus marshalling into json. This is extremely useful in combination with tools such as "jq" to process bus calls further.
2018-07-04 16:28:09 +03:00
<varlistentry>
man: fix incorrect XML in man page
2024-04-12 12:12:15 +03:00
<term><option>--json=<replaceable>MODE</replaceable></option></term>
busctl: add a --json= output mode A new switch "-j" or "--json=" is added which transforms dbus marshalling into json. This is extremely useful in combination with tools such as "jq" to process bus calls further.
2018-07-04 16:28:09 +03:00
<listitem>
<para>When used with the <command>call</command> or <command>get-property</command> command, shows output
formatted as JSON. Expects one of <literal>short</literal> (for the shortest possible output without any
redundant whitespace or line breaks) or <literal>pretty</literal> (for a pretty version of the same, with
indentation and line breaks). Note that transformation from D-Bus marshalling to JSON is done in a loss-less
way, which means type information is embedded into the JSON object tree.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v240"/>
busctl: add a --json= output mode A new switch "-j" or "--json=" is added which transforms dbus marshalling into json. This is extremely useful in combination with tools such as "jq" to process bus calls further.
2018-07-04 16:28:09 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><option>-j</option></term>
<listitem>
<para>Equivalent to <option>--json=pretty</option> when invoked interactively from a terminal. Otherwise
equivalent to <option>--json=short</option>, in particular when the output is piped to some other
program.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v240"/>
busctl: add a --json= output mode A new switch "-j" or "--json=" is added which transforms dbus marshalling into json. This is extremely useful in combination with tools such as "jq" to process bus calls further.
2018-07-04 16:28:09 +03:00
</listitem>
</varlistentry>
busctl: add options to control message header flags when invoking methods
2014-11-21 22:13:26 +03:00
<varlistentry>
man: fix incorrect XML in man page
2024-04-12 12:12:15 +03:00
<term><option>--expect-reply=<replaceable>BOOL</replaceable></option></term>
busctl: add options to control message header flags when invoking methods
2014-11-21 22:13:26 +03:00
<listitem>
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
<para>When used with the <command>call</command> command,
busctl: add options to control message header flags when invoking methods
2014-11-21 22:13:26 +03:00
specifies whether <command>busctl</command> shall wait for
completion of the method call, output the returned method
response data, and return success or failure via the process
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
exit code. If this is set to <literal>no</literal>, the
busctl: add options to control message header flags when invoking methods
2014-11-21 22:13:26 +03:00
method call will be issued but no response is expected, the
tool terminates immediately, and thus no response can be
shown, and no success or failure is returned via the exit
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
code. To only suppress output of the reply message payload,
busctl: add options to control message header flags when invoking methods
2014-11-21 22:13:26 +03:00
use <option>--quiet</option> above. Defaults to
<literal>yes</literal>.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v218"/>
busctl: add options to control message header flags when invoking methods
2014-11-21 22:13:26 +03:00
</listitem>
</varlistentry>
<varlistentry>
man: fix incorrect XML in man page
2024-04-12 12:12:15 +03:00
<term><option>--auto-start=<replaceable>BOOL</replaceable></option></term>
busctl: add options to control message header flags when invoking methods
2014-11-21 22:13:26 +03:00
<listitem>
busctl: introduce 'emit' command to emit a signal Closes #11622.
2019-02-02 20:01:05 +03:00
<para>When used with the <command>call</command> or <command>emit</command> command, specifies
busctl: add options to control message header flags when invoking methods
2014-11-21 22:13:26 +03:00
whether the method call should implicitly activate the
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
called service, should it not be running yet but is
busctl: add options to control message header flags when invoking methods
2014-11-21 22:13:26 +03:00
configured to be auto-started. Defaults to
<literal>yes</literal>.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v218"/>
busctl: add options to control message header flags when invoking methods
2014-11-21 22:13:26 +03:00
</listitem>
</varlistentry>
<varlistentry>
man: fix incorrect XML in man page
2024-04-12 12:12:15 +03:00
<term><option>--allow-interactive-authorization=<replaceable>BOOL</replaceable></option></term>
busctl: add options to control message header flags when invoking methods
2014-11-21 22:13:26 +03:00
<listitem>
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
<para>When used with the <command>call</command> command,
busctl: add options to control message header flags when invoking methods
2014-11-21 22:13:26 +03:00
specifies whether the services may enforce interactive
authorization while executing the operation, if the security
policy is configured for this. Defaults to
<literal>yes</literal>.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v218"/>
busctl: add options to control message header flags when invoking methods
2014-11-21 22:13:26 +03:00
</listitem>
</varlistentry>
busctl: add --timeout= option to specify method call timeout
2014-11-21 22:31:50 +03:00
<varlistentry>
man: fix incorrect XML in man page
2024-04-12 12:12:15 +03:00
<term><option>--timeout=<replaceable>SECS</replaceable></option></term>
busctl: add --timeout= option to specify method call timeout
2014-11-21 22:31:50 +03:00
<listitem>
busctl: add support for --timeout to monitor verb Useful in scripts when you want to exit successfully after a certain time
2024-08-07 22:41:20 +03:00
<para>When used with the <command>call</command> command, specifies the maximum time to wait for
method call completion. When used with the <command>monitor</command> command, since version v257,
specifies the maximum time to wait for messages before automatically exiting. If no time unit is
specified, assumes seconds. The usual other units are understood, too (ms, us, s, min, h, d, w,
month, y). Note that this timeout does not apply if <option>--expect-reply=no</option> is used,
when combined with the <command>call</command> command, as the tool does not wait for any reply
message then. When not specified or when set to 0, the default of <literal>25s</literal> is
assumed for the <command>call</command> command, and it is disabled for the
<command>monitor</command> command.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v218"/>
busctl: add --timeout= option to specify method call timeout
2014-11-21 22:31:50 +03:00
</listitem>
</varlistentry>
busctl: add --num-matches= for monitor verb Useful in scripts when one wants to wait for a specific signal before continuing
2024-08-07 23:59:26 +03:00
<varlistentry>
<term><option>--num-matches=<replaceable>NUMBER</replaceable></option></term>
<listitem>
<para>When used with the <command>monitor</command> command, if enabled will make
<command>busctl</command> exit when the specified number of messages have been received and
printed. This is useful in combination with <option>--match=</option>, to wait for the specified
number of occurrences of specific D-Bus messages.</para>
<xi:include href="version-info.xml" xpointer="v257"/>
</listitem>
</varlistentry>
busctl: add new --augment-creds= switch for controlling whether shown credential data shall be augment with data from /proc
2014-11-24 23:53:29 +03:00
<varlistentry>
man: fix incorrect XML in man page
2024-04-12 12:12:15 +03:00
<term><option>--augment-creds=<replaceable>BOOL</replaceable></option></term>
busctl: add new --augment-creds= switch for controlling whether shown credential data shall be augment with data from /proc
2014-11-24 23:53:29 +03:00
<listitem>
<para>Controls whether credential data reported by
<command>list</command> or <command>status</command> shall
be augmented with data from
man: use trailing slash on directories in more places
2020-10-05 19:08:21 +03:00
<filename>/proc/</filename>. When this is turned on, the data
busctl: add new --augment-creds= switch for controlling whether shown credential data shall be augment with data from /proc
2014-11-24 23:53:29 +03:00
shown is possibly inconsistent, as the data read from
man: use trailing slash on directories in more places
2020-10-05 19:08:21 +03:00
<filename>/proc/</filename> might be more recent than the rest of
busctl: add new --augment-creds= switch for controlling whether shown credential data shall be augment with data from /proc
2014-11-24 23:53:29 +03:00
the credential information. Defaults to <literal>yes</literal>.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v218"/>
busctl: add new --augment-creds= switch for controlling whether shown credential data shall be augment with data from /proc
2014-11-24 23:53:29 +03:00
</listitem>
</varlistentry>
busctl: add a new --watch-bind switch This is useful for testing, and early-boot scripting.
2017-12-16 00:19:34 +03:00
<varlistentry>
man: fix incorrect XML in man page
2024-04-12 12:12:15 +03:00
<term><option>--watch-bind=<replaceable>BOOL</replaceable></option></term>
busctl: add a new --watch-bind switch This is useful for testing, and early-boot scripting.
2017-12-16 00:19:34 +03:00
<listitem>
<para>Controls whether to wait for the specified <constant>AF_UNIX</constant> bus socket to appear in the
file system before connecting to it. Defaults to off. When enabled, the tool will watch the file system until
the socket is created and then connect to it.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v237"/>
busctl: add a new --watch-bind switch This is useful for testing, and early-boot scripting.
2017-12-16 00:19:34 +03:00
</listitem>
</varlistentry>
busctl: introduce 'emit' command to emit a signal Closes #11622.
2019-02-02 20:01:05 +03:00
<varlistentry>
man: fix incorrect XML in man page
2024-04-12 12:12:15 +03:00
<term><option>--destination=<replaceable>SERVICE</replaceable></option></term>
busctl: introduce 'emit' command to emit a signal Closes #11622.
2019-02-02 20:01:05 +03:00
<listitem>
<para>Takes a service name. When used with the <command>emit</command> command, a signal is
emitted to the specified service.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v242"/>
busctl: introduce 'emit' command to emit a signal Closes #11622.
2019-02-02 20:01:05 +03:00
</listitem>
</varlistentry>
man: xinclude --user/--system
2014-02-13 23:40:40 +04:00
<xi:include href="user-system-options.xml" xpointer="user" />
<xi:include href="user-system-options.xml" xpointer="system" />
man: xinclude --host/--machine As usual, those common options are pushed to the end.
2014-02-21 04:47:03 +04:00
<xi:include href="user-system-options.xml" xpointer="host" />
<xi:include href="user-system-options.xml" xpointer="machine" />
man: document the new concepts
2024-01-03 21:29:23 +03:00
<xi:include href="user-system-options.xml" xpointer="capsule" />
man: xinclude --user/--system
2014-02-13 23:40:40 +04:00
busctl: introduce --full command line option
2020-01-10 06:19:47 +03:00
<varlistentry>
<term><option>-l</option></term>
<term><option>--full</option></term>
<listitem>
<para>Do not ellipsize the output in <command>list</command> command.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v245"/>
busctl: introduce --full command line option
2020-01-10 06:19:47 +03:00
</listitem>
</varlistentry>
man: use one description of --no-legend
2015-01-20 05:43:35 +03:00
<xi:include href="standard-options.xml" xpointer="no-pager" />
<xi:include href="standard-options.xml" xpointer="no-legend" />
man: xinclude --help/--version/--no-pager
2014-02-13 23:33:51 +04:00
<xi:include href="standard-options.xml" xpointer="help" />
<xi:include href="standard-options.xml" xpointer="version" />
man: add busctl(1)
2014-01-12 08:44:34 +04:00
</variablelist>
</refsect1>
busctl: show property values in "introspect" output, add "set-property" command, and support both a terse and a verbose output format
2014-11-21 01:12:29 +03:00
<refsect1>
man: don't mix 2ch and 8ch indentation in busctl.xml
2014-11-21 22:46:01 +03:00
<title>Parameter Formatting</title>
<para>The <command>call</command> and
<command>set-property</command> commands take a signature string
followed by a list of parameters formatted as string (for details
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
on D-Bus signature strings, see the <ulink
Use https for freedesktop.org grep -l -r http:// | xargs sed -E -i s'#http://(.*).freedesktop.org#https://\1.freedesktop.org#'
2022-06-28 13:00:47 +03:00
url="https://dbus.freedesktop.org/doc/dbus-specification.html#type-system">Type
man: don't mix 2ch and 8ch indentation in busctl.xml
2014-11-21 22:46:01 +03:00
system chapter of the D-Bus specification</ulink>). For simple
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
types, each parameter following the signature should simply be the
man: don't mix 2ch and 8ch indentation in busctl.xml
2014-11-21 22:46:01 +03:00
parameter's value formatted as string. Positive boolean values may
be formatted as <literal>true</literal>, <literal>yes</literal>,
doc: correct orthography, word forms and missing/extraneous words
2014-08-03 09:11:37 +04:00
<literal>on</literal>, or <literal>1</literal>; negative boolean
man: don't mix 2ch and 8ch indentation in busctl.xml
2014-11-21 22:46:01 +03:00
values may be specified as <literal>false</literal>,
doc: correct orthography, word forms and missing/extraneous words
2014-08-03 09:11:37 +04:00
<literal>no</literal>, <literal>off</literal>, or
man: don't mix 2ch and 8ch indentation in busctl.xml
2014-11-21 22:46:01 +03:00
<literal>0</literal>. For arrays, a numeric argument for the
number of entries followed by the entries shall be specified. For
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
variants, the signature of the contents shall be specified,
followed by the contents. For dictionaries and structs, the
man: don't mix 2ch and 8ch indentation in busctl.xml
2014-11-21 22:46:01 +03:00
contents of them shall be directly specified.</para>
<para>For example,
<programlisting>s jawoll</programlisting> is the formatting
of a single string <literal>jawoll</literal>.</para>
<para>
<programlisting>as 3 hello world foobar</programlisting>
is the formatting of a string array with three entries,
<literal>hello</literal>, <literal>world</literal> and
<literal>foobar</literal>.</para>
<para>
<programlisting>a{sv} 3 One s Eins Two u 2 Yes b true</programlisting>
is the formatting of a dictionary
array that maps strings to variants, consisting of three
entries. The string <literal>One</literal> is assigned the
string <literal>Eins</literal>. The string
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
<literal>Two</literal> is assigned the 32-bit unsigned
man: don't mix 2ch and 8ch indentation in busctl.xml
2014-11-21 22:46:01 +03:00
integer 2. The string <literal>Yes</literal> is assigned a
positive boolean.</para>
<para>Note that the <command>call</command>,
<command>get-property</command>, <command>introspect</command>
commands will also generate output in this format for the returned
data. Since this format is sometimes too terse to be easily
understood, the <command>call</command> and
<command>get-property</command> commands may generate a more
verbose, multi-line output when passed the
<option>--verbose</option> option.</para>
busctl: show property values in "introspect" output, add "set-property" command, and support both a terse and a verbose output format
2014-11-21 01:12:29 +03:00
</refsect1>
<refsect1>
man: don't mix 2ch and 8ch indentation in busctl.xml
2014-11-21 22:46:01 +03:00
<title>Examples</title>
<example>
<title>Write and Read a Property</title>
<para>The following two commands first write a property and then
read it back. The property is found on the
<literal>/org/freedesktop/systemd1</literal> object of the
<literal>org.freedesktop.systemd1</literal> service. The name of
the property is <literal>LogLevel</literal> on the
<literal>org.freedesktop.systemd1.Manager</literal>
interface. The property contains a single string:</para>
<programlisting># busctl set-property org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager LogLevel s debug
busctl: show property values in "introspect" output, add "set-property" command, and support both a terse and a verbose output format
2014-11-21 01:12:29 +03:00
# busctl get-property org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager LogLevel
s "debug"</programlisting>
man: don't mix 2ch and 8ch indentation in busctl.xml
2014-11-21 22:46:01 +03:00
</example>
busctl: show property values in "introspect" output, add "set-property" command, and support both a terse and a verbose output format
2014-11-21 01:12:29 +03:00
man: don't mix 2ch and 8ch indentation in busctl.xml
2014-11-21 22:46:01 +03:00
<example>
<title>Terse and Verbose Output</title>
busctl: show property values in "introspect" output, add "set-property" command, and support both a terse and a verbose output format
2014-11-21 01:12:29 +03:00
man: don't mix 2ch and 8ch indentation in busctl.xml
2014-11-21 22:46:01 +03:00
<para>The following two commands read a property that contains
an array of strings, and first show it in terse format, followed
by verbose format:</para>
busctl: show property values in "introspect" output, add "set-property" command, and support both a terse and a verbose output format
2014-11-21 01:12:29 +03:00
man: don't mix 2ch and 8ch indentation in busctl.xml
2014-11-21 22:46:01 +03:00
<programlisting>$ busctl get-property org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager Environment
busctl: show property values in "introspect" output, add "set-property" command, and support both a terse and a verbose output format
2014-11-21 01:12:29 +03:00
as 2 "LANG=en_US.UTF-8" "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin"
$ busctl get-property --verbose org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager Environment
ARRAY "s" {
STRING "LANG=en_US.UTF-8";
STRING "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin";
};</programlisting>
man: don't mix 2ch and 8ch indentation in busctl.xml
2014-11-21 22:46:01 +03:00
</example>
<example>
<title>Invoking a Method</title>
man: fix typos
2015-12-26 20:25:49 +03:00
<para>The following command invokes the
man: don't mix 2ch and 8ch indentation in busctl.xml
2014-11-21 22:46:01 +03:00
<literal>StartUnit</literal> method on the
<literal>org.freedesktop.systemd1.Manager</literal>
interface of the
<literal>/org/freedesktop/systemd1</literal> object
of the <literal>org.freedesktop.systemd1</literal>
service, and passes it two strings
<literal>cups.service</literal> and
doc: correct orthography, word forms and missing/extraneous words
2014-08-03 09:11:37 +04:00
<literal>replace</literal>. As a result of the method
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
call, a single object path parameter is received and
man: don't mix 2ch and 8ch indentation in busctl.xml
2014-11-21 22:46:01 +03:00
shown:</para>
<programlisting># busctl call org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager StartUnit ss "cups.service" "replace"
busctl: show property values in "introspect" output, add "set-property" command, and support both a terse and a verbose output format
2014-11-21 01:12:29 +03:00
o "/org/freedesktop/systemd1/job/42684"</programlisting>
man: don't mix 2ch and 8ch indentation in busctl.xml
2014-11-21 22:46:01 +03:00
</example>
busctl: show property values in "introspect" output, add "set-property" command, and support both a terse and a verbose output format
2014-11-21 01:12:29 +03:00
</refsect1>
man: add busctl(1)
2014-01-12 08:44:34 +04:00
<refsect1>
<title>See Also</title>
man: use <simplelist> for 'See also' sections This is just a slight markup improvement; there should be no difference in rendering.
2023-12-22 21:09:32 +03:00
<para><simplelist type="inline">
<member><citerefentry project='dbus'><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><ulink url="https://www.freedesktop.org/wiki/Software/dbus">D-Bus</ulink></member>
<member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>varlinkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry project='die-net'><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
</simplelist></para>
man: add busctl(1)
2014-01-12 08:44:34 +04:00
</refsect1>
</refentry>
Copy Permalink