dbus-monitor.1 revision 15985
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<!--ArborText, Inc., 1988-1999, v.4002-->
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<!--ARC : LSARC 2006/368 D-BUS Message Bus System -->
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<!ENTITY suncopy "Copyright (c) 2007,2009 Sun Microsystems, Inc. All Rights Reserved.">
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<!-- %Z%%M% %I% %E% SMI; -->
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>1</manvolnum>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<refmiscinfo class="date">25 Feb 2009</refmiscinfo>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<refmiscinfo class="software">&release;</refmiscinfo>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<indexterm><primary>&cmd;</primary></indexterm><indexterm><primary>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowedebug probe to print message bus messages
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe</primary></indexterm><refnamediv id="dbus-monitor-1-name">
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowedebug probe to print message bus messages
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<refsynopsisdiv id="dbus-monitor-1-synp"><title>&synp-tt;</title>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<arg choice="opt"><option>-system</option> | <option>-session</option></arg>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<arg choice="opt"><option>-profile</option> | <option>-monitor</option></arg>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<arg choice="opt"><option role="nodash">watch_expressions</option></arg>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<refsect1 id="dbus-monitor-1-desc"><title>&desc-tt;</title>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard LoweThe <command>&cmd;</command> command is used to monitor messages going through
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowea D\-Bus message bus.
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard LoweThere are two standard message buses:
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<itemizedlist>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowesystemwide message bus - Disabled and not supported on Solaris, but installed
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Loweon many systems as the "messagebus" init service.
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Loweper-user-login-session message bus - Enabled and supported on Solaris, and
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowestarted each time a user logs in.
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe</itemizedlist>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard LoweThe <option>-system</option> and <option>-session</option> options direct
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<command>&cmd;</command> to monitor the system or session buses respectively.
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard LoweIf neither is specified, <command>&cmd;</command> monitors the session bus.
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<command>&cmd;</command> has two different output modes, the 'classic'-style
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowemonitoring mode and profiling mode. The profiling format is a compact format
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowewith a single line per message and microsecond-resolution timing information.
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard LoweThe <option>-profile</option> and <option>-monitor</option> options select the
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Loweprofiling and monitoring output format respectively. If neither is specified,
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<command>&cmd;</command> uses the monitoring output format.
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard LoweIn order to get dbus-monitor to see the messages you are interested in, you
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Loweshould specify a set of watch expressions as you would expect to be passed to
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowethe dbus_bus_add_watch function.
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard LoweThe message bus configuration may keep <command>&cmd;</command> from seeing all
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowemessages, especially if you run the monitor as a non-root user.
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard LoweSee <literal>http://www.freedesktop.org/software/dbus/</literal>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowefor more information.
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<refsect1 id="dbus-monitor-1-opts"><title>&opts-tt;</title>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<para>The following options are supported:</para>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<varlistentry>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard LoweUse the monitoring output format (this is the default).
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<varlistentry>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard LoweUse the profiling output format.
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<varlistentry>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard LoweMonitor the session message bus (this is the default).
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<varlistentry>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard LoweMonitor the system message bus. The system bus is disabled and unsupported
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<refsect1 id="dbus-monitor-1-oper"><title>&oper-tt;</title>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<para>The following operands are supported:</para>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<varlistentry>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<term><option role="nodash"><replaceable>watch_expressions</replaceable></option></term>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard LoweIn order to display the messages you are interested in, you should specify
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowea set of <replaceable>watch_expressions</replaceable> as you would expect
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Loweto be passed to the dbus_bus_add_watch function.
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<refsect1 id="dbus-send-1-exam"><title>&exam-tt;</title>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<title>How to use <command>&cmd;</command> to watch for the GNOME
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowetyping monitor to say things</title>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<para><screen>example% <userinput>&cmd; "type='signal',sender='org.gnome.TypingMonitor',interface='org.gnome.TypingMonitor'"</userinput>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<refsect1 id="dbus-monitor-1-exit"><title>&exit-tt;</title>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<para>The following exit values are returned:</para>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<varlistentry>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard LoweApplication exited successfully
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<varlistentry>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard LoweApplication exited with failure
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<refsect1 id="dbus-monitor-1-file"><title>&file-tt;</title>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<para>The following files are used by this application:</para>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<varlistentry>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<term><filename>/usr/bin/&cmd;</filename></term>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<refsect1 id="dbus-monitor-1-attr"><title>&attr-tt;</title>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowefor descriptions of the following attributes:</para>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe</informaltable>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<refsect1 id="dbus-monitor-1-also"><title>&also-tt;</title>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<!--Reference to another man page-->
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<!--Reference to a Help manual-->
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<!--Reference to a book.-->
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<citerefentry><refentrytitle>dbus-cleanup-sockets</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<citerefentry><refentrytitle>dbus-launch</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<citerefentry><refentrytitle>dbus-send</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<citerefentry><refentrytitle>dbus-uuidgen</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<citerefentry><refentrytitle>libdbus-glib-1</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<refsect1 id="dbus-monitor-1-note"><title>¬e-tt;</title>
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard LoweFor authorship information refer to
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<literal>http://www.freedesktop.org/software/dbus/doc/AUTHORS</literal>.
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard LoweUpdated by Brian Cameron, Sun Microsystems Inc., 2007.
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowe<command>&cmd;</command> was written by Philip Blundell. The profiling output
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard Lowemode was added by Olli Salli.
10d63b7db37a83b39c7f511cf9426c9d03ea0760Richard LowePlease send bug reports to the D\-Bus mailing list or bug