man-pages/man1/dbus-monitor.1.html
2021-03-31 01:06:50 +01:00

179 lines
4.2 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of DBUS-MONITOR</TITLE>
</HEAD><BODY>
<H1>DBUS-MONITOR</H1>
Section: User Commands (1)<BR>Updated: <BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
dbus-monitor - debug probe to print message bus messages
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<DL COMPACT>
<DT id="1">
<B>dbus-monitor</B> [--system | --session | --address&nbsp;<I>ADDRESS</I>] [--profile | --monitor | --pcap | --binary] [<I>watch</I>&nbsp;<I>expressions</I>]
<DD>
<P>
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<DD>The
<B>dbus-monitor</B>
command is used to monitor messages going through a D-Bus message bus. See
m[blue]<B><A HREF="http://www.freedesktop.org/software/dbus/">http://www.freedesktop.org/software/dbus/</A></B>m[]
for more information about the big picture.
<P>
There are two well-known message buses: the systemwide message bus (installed on many systems as the &quot;messagebus&quot; service) and the per-user-login-session message bus (started each time a user logs in). The --system and --session options direct
<B>dbus-monitor</B>
to monitor the system or session buses respectively. If neither is specified,
<B>dbus-monitor</B>
monitors the session bus.
<P>
<B>dbus-monitor</B>
has two different text output modes: the 'classic'-style monitoring mode, and profiling mode. The profiling format is a compact format with a single line per message and microsecond-resolution timing information. The --profile and --monitor options select the profiling and monitoring output format respectively.
<P>
<B>dbus-monitor</B>
also has two binary output modes. The binary mode, selected by
--binary, outputs the entire binary message stream (without the initial authentication handshake). The PCAP mode, selected by
--pcap, adds a PCAP file header to the beginning of the output, and prepends a PCAP message header to each message; this produces a binary file that can be read by, for instance, Wireshark.
<P>
If no mode is specified,
<B>dbus-monitor</B>
uses the monitoring output format.
<P>
In order to get
<B>dbus-monitor</B>
to see the messages you are interested in, you should specify a set of watch expressions as you would expect to be passed to the
<I>dbus_bus_add_match</I>
function.
<P>
The message bus configuration may keep
<B>dbus-monitor</B>
from seeing all messages, especially if you run the monitor as a non-root user.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<P>
<B>--system</B>
<DL COMPACT><DT id="2"><DD>
Monitor the system message bus.
</DL>
<P>
<B>--session</B>
<DL COMPACT><DT id="3"><DD>
Monitor the session message bus. (This is the default.)
</DL>
<P>
<B>--address ADDRESS</B>
<DL COMPACT><DT id="4"><DD>
Monitor an arbitrary message bus given at ADDRESS.
</DL>
<P>
<B>--profile</B>
<DL COMPACT><DT id="5"><DD>
Use the profiling output format.
</DL>
<P>
<B>--monitor</B>
<DL COMPACT><DT id="6"><DD>
Use the monitoring output format. (This is the default.)
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>EXAMPLE</H2>
<P>
Here is an example of using dbus-monitor to watch for the gnome typing monitor to say things
<P>
<DL COMPACT><DT id="7"><DD>
<PRE>
dbus-monitor &quot;type='signal',sender='org.gnome.TypingMonitor',interface='org.gnome.TypingMonitor'&quot;
</PRE>
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>AUTHOR</H2>
<P>
dbus-monitor was written by Philip Blundell. The profiling output mode was added by Olli Salli.
<A NAME="lbAH">&nbsp;</A>
<H2>BUGS</H2>
<P>
Please send bug reports to the D-Bus mailing list or bug tracker, see
m[blue]<B><A HREF="http://www.freedesktop.org/software/dbus/">http://www.freedesktop.org/software/dbus/</A></B>m[]
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="8"><A HREF="#lbAB">NAME</A><DD>
<DT id="9"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="10"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="11"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="12"><A HREF="#lbAF">EXAMPLE</A><DD>
<DT id="13"><A HREF="#lbAG">AUTHOR</A><DD>
<DT id="14"><A HREF="#lbAH">BUGS</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:09 GMT, March 31, 2021
</BODY>
</HTML>