chiark / gitweb /
hashmap: return more information from resize_buckets()
[elogind.git] / man / busctl.xml
1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5 <!--
6 This file is part of systemd.
7
8 Copyright 2014 Zbigniew Jędrzejewski-Szmek
9
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
14
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
19
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 -->
23
24 <refentry id="busctl"
25           xmlns:xi="http://www.w3.org/2001/XInclude">
26
27   <refentryinfo>
28     <title>busctl</title>
29     <productname>systemd</productname>
30
31     <authorgroup>
32       <author>
33         <contrib>A monkey with a typewriter</contrib>
34         <firstname>Zbigniew</firstname>
35         <surname>Jędrzejewski-Szmek</surname>
36         <email>zbyszek@in.waw.pl</email>
37       </author>
38     </authorgroup>
39   </refentryinfo>
40
41   <refmeta>
42     <refentrytitle>busctl</refentrytitle>
43     <manvolnum>1</manvolnum>
44   </refmeta>
45
46   <refnamediv>
47     <refname>busctl</refname>
48     <refpurpose>Introspect the bus</refpurpose>
49   </refnamediv>
50
51   <refsynopsisdiv>
52     <cmdsynopsis>
53       <command>busctl</command>
54       <arg choice="opt" rep="repeat">OPTIONS</arg>
55       <arg choice="opt">COMMAND</arg>
56       <arg choice="opt" rep="repeat"><replaceable>NAME</replaceable></arg>
57     </cmdsynopsis>
58   </refsynopsisdiv>
59
60   <refsect1>
61     <title>Description</title>
62
63     <para><command>busctl</command> may be used to
64     introspect and monitor the D-Bus bus.</para>
65   </refsect1>
66
67   <refsect1>
68     <title>Options</title>
69
70     <para>The following options are understood:</para>
71
72     <variablelist>
73       <varlistentry>
74           <term><option>--address=<replaceable>ADDRESS</replaceable></option></term>
75
76           <listitem><para>Connect to the bus specified by
77           <replaceable>ADDRESS</replaceable> instead of using suitable
78           defaults for either the system or user bus (see
79           <option>--system</option> and <option>--user</option>
80           options).</para></listitem>
81       </varlistentry>
82
83       <varlistentry>
84           <term><option>--show-machine</option></term>
85
86           <listitem><para>When showing the list of endpoints, show a
87           column containing the names of containers they belong to.
88           See
89           <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
90           </para></listitem>
91       </varlistentry>
92
93       <varlistentry>
94           <term><option>--unique</option></term>
95
96           <listitem><para>When showing the list of endpoints, show
97           only "unique" names (of the form
98           <literal>:<replaceable>number</replaceable>.<replaceable>number</replaceable></literal>).
99           </para></listitem>
100       </varlistentry>
101
102       <varlistentry>
103           <term><option>--acquired</option></term>
104
105           <listitem><para>The opposite of <option>--unique</option> —
106           only "well-known" names will be shown.</para></listitem>
107       </varlistentry>
108
109       <varlistentry>
110           <term><option>--activatable</option></term>
111
112           <listitem><para>When showing the list of endpoints, show
113           only endpoints which have actually not been activated yet,
114           but may be started automatically if accessed.</para>
115           </listitem>
116       </varlistentry>
117
118       <varlistentry>
119           <term><option>--match=<replaceable>MATCH</replaceable></option></term>
120
121           <listitem><para>When showing messages being exchanged, show only the
122           subset matching <replaceable>MATCH</replaceable>.</para></listitem>
123           <!-- TODO: link to sd_bus_add_match when it is written? -->
124       </varlistentry>
125
126       <varlistentry>
127         <term><option>--no-legend</option></term>
128
129         <listitem>
130           <para>Do not print the legend,
131           i.e. the column headers and the
132           footer.</para>
133         </listitem>
134       </varlistentry>
135
136       <xi:include href="user-system-options.xml" xpointer="user" />
137       <xi:include href="user-system-options.xml" xpointer="system" />
138       <xi:include href="user-system-options.xml" xpointer="host" />
139       <xi:include href="user-system-options.xml" xpointer="machine" />
140
141       <xi:include href="standard-options.xml" xpointer="help" />
142       <xi:include href="standard-options.xml" xpointer="version" />
143       <xi:include href="standard-options.xml" xpointer="no-pager" />
144     </variablelist>
145   </refsect1>
146
147   <refsect1>
148     <title>Commands</title>
149
150     <para>The following commands are understood:</para>
151
152     <variablelist>
153       <varlistentry>
154         <term><command>list</command></term>
155
156         <listitem><para>Show endpoints attached to the bus. This is
157         the default if no command is specified.</para></listitem>
158       </varlistentry>
159
160       <varlistentry>
161         <term><command>monitor</command>  <arg choice="opt" rep="repeat"><replaceable>NAME</replaceable></arg></term>
162
163         <listitem><para>Dump messages being exchanged. If
164         <replaceable>NAME</replaceable> is specified, show messages
165         to or from this endpoint. Otherwise, show all messages on the
166         bus.</para></listitem>
167       </varlistentry>
168
169       <varlistentry>
170         <term><command>status</command>  <arg choice="plain"><replaceable>NAME</replaceable></arg></term>
171
172         <listitem><para>Show process information and credentials of a
173         bus endpoint.</para></listitem>
174       </varlistentry>
175
176       <varlistentry>
177         <term><command>help</command></term>
178
179         <listitem><para>Show command syntax help.</para></listitem>
180       </varlistentry>
181     </variablelist>
182   </refsect1>
183
184   <refsect1>
185     <title>See Also</title>
186
187     <para>
188       <citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
189       <ulink url="http://freedesktop.org/wiki/Software/dbus">D-Bus</ulink>,
190       <ulink url="https://code.google.com/p/d-bus/">kdbus</ulink>,
191       <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
192       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
193       <citerefentry><refentrytitle>systemd-bus-proxyd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
194       <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
195     </para>
196   </refsect1>
197 </refentry>