11965N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
11965N/A<!--ArborText, Inc., 1988-1999, v.4002-->
15941N/A<!--ARC : LSARC 2006/368 D-BUS Message Bus System -->
11965N/A<!ENTITY cmd "dbus-monitor">
11965N/A<!ENTITY % commonents SYSTEM "smancommon.ent">
11965N/A%commonents;
11965N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">
11965N/A%booktitles;
15985N/A<!ENTITY suncopy "Copyright (c) 2007,2009 Sun Microsystems, Inc. All Rights Reserved.">
11965N/A]>
11965N/A<refentry id="dbus-monitor-1">
11965N/A<!-- %Z%%M% %I% %E% SMI; -->
15985N/A<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>1</manvolnum>
15985N/A<refmiscinfo class="date">25 Feb 2009</refmiscinfo>
11965N/A<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
11965N/A<refmiscinfo class="software">&release;</refmiscinfo>
11965N/A<refmiscinfo class="arch">generic</refmiscinfo>
11965N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
11965N/A</refmeta>
17616N/A<indexterm><primary>&cmd;</primary></indexterm>
17616N/A<indexterm><primary>debug probe to print message bus messages</primary></indexterm>
17616N/A<refnamediv id="dbus-monitor-1-name">
15985N/A<refname>&cmd;</refname><refpurpose>
11965N/Adebug probe to print message bus messages
17616N/A</refpurpose>
17616N/A</refnamediv>
11965N/A<refsynopsisdiv id="dbus-monitor-1-synp"><title>&synp-tt;</title>
11965N/A<cmdsynopsis><command>&cmd;</command>
11965N/A<arg choice="opt"><option>-system</option> | <option>-session</option></arg>
11965N/A<arg choice="opt"><option>-profile</option> | <option>-monitor</option></arg>
11965N/A<arg choice="opt"><option role="nodash">watch_expressions</option></arg>
11965N/A</cmdsynopsis></refsynopsisdiv>
17601N/A
11965N/A<refsect1 id="dbus-monitor-1-desc"><title>&desc-tt;</title>
11965N/A<para>
15985N/AThe <command>&cmd;</command> command is used to monitor messages going through
15985N/Aa D\-Bus message bus.
11965N/A</para>
17601N/A
11965N/A<para>
11965N/AThere are two standard message buses:
11965N/A</para>
17601N/A
11965N/A<itemizedlist>
11965N/A<listitem><para>
17601N/Asystemwide message bus - Launched when the system is started and is always
17602N/Aavailable. Additional systemwide services can be launched via D\-Bus
17603N/Aservice activation. However, D\-Bus service activation is disabled on Solaris.
11965N/A</para></listitem>
11965N/A<listitem><para>
17601N/Aper-user-login-session message bus - Launched each time a user logs in.
11965N/A</para></listitem>
11965N/A</itemizedlist>
17601N/A
11965N/A<para>
15985N/AThe <option>-system</option> and <option>-session</option> options direct
15985N/A<command>&cmd;</command> to monitor the system or session buses respectively.
15985N/AIf neither is specified, <command>&cmd;</command> monitors the session bus.
11965N/A</para>
17601N/A
11965N/A<para>
15985N/A<command>&cmd;</command> has two different output modes, the 'classic'-style
15985N/Amonitoring mode and profiling mode. The profiling format is a compact format
15985N/Awith a single line per message and microsecond-resolution timing information.
15985N/AThe <option>-profile</option> and <option>-monitor</option> options select the
11965N/Aprofiling and monitoring output format respectively. If neither is specified,
15985N/A<command>&cmd;</command> uses the monitoring output format.
11965N/A</para>
17601N/A
11965N/A<para>
15985N/AIn order to get dbus-monitor to see the messages you are interested in, you
15985N/Ashould specify a set of watch expressions as you would expect to be passed to
15985N/Athe dbus_bus_add_watch function.
15985N/A</para>
17601N/A
15985N/A<para>
15985N/AThe message bus configuration may keep <command>&cmd;</command> from seeing all
15985N/Amessages, especially if you run the monitor as a non-root user.
11965N/A</para>
17601N/A</refsect1>
17601N/A
17601N/A<refsect1 id="dbus-monitor-1-opts"><title>&opts-tt;</title>
11965N/A<para>
17601N/AThe following options are supported:
11965N/A</para>
17601N/A
11965N/A<variablelist termlength="wholeline">
11965N/A<varlistentry>
11965N/A<term><option>-monitor</option></term>
11965N/A<listitem><para>
11965N/AUse the monitoring output format (this is the default).
17616N/A</para></listitem></varlistentry>
17601N/A
11965N/A<varlistentry>
11965N/A<term><option>-profile</option></term>
11965N/A<listitem><para>
11965N/AUse the profiling output format.
17616N/A</para></listitem></varlistentry>
17601N/A
11965N/A<varlistentry>
11965N/A<term><option>-session</option></term>
11965N/A<listitem><para>
11965N/AMonitor the session message bus (this is the default).
17616N/A</para></listitem></varlistentry>
17601N/A
11965N/A<varlistentry>
11965N/A<term><option>-system</option></term>
11965N/A<listitem><para>
11965N/AMonitor the system message bus. The system bus is disabled and unsupported
11965N/Aon Solaris.
17616N/A</para></listitem></varlistentry>
17616N/A</variablelist>
17616N/A</refsect1>
17601N/A
11965N/A<refsect1 id="dbus-monitor-1-oper"><title>&oper-tt;</title>
17601N/A<para>
17601N/AThe following operands are supported:
17601N/A</para>
17601N/A
11965N/A<variablelist termlength="medium">
11965N/A<varlistentry>
11965N/A<term><option role="nodash"><replaceable>watch_expressions</replaceable></option></term>
11965N/A<listitem><para>
11965N/AIn order to display the messages you are interested in, you should specify
11965N/Aa set of <replaceable>watch_expressions</replaceable> as you would expect
11965N/Ato be passed to the dbus_bus_add_watch function.
17616N/A</para></listitem></varlistentry>
11965N/A</variablelist></refsect1>
17601N/A
15985N/A<refsect1 id="dbus-send-1-exam"><title>&exam-tt;</title>
15985N/A<example role="example">
15985N/A<title>How to use <command>&cmd;</command> to watch for the GNOME
15985N/Atyping monitor to say things</title>
17601N/A
17601N/A<para>
17601N/A<screen>
17601N/Aexample% <userinput>&cmd; &quot;type='signal',sender='org.gnome.TypingMonitor',interface='org.gnome.TypingMonitor'&quot;</userinput>
15985N/A</screen></para>
15985N/A</example>
15985N/A</refsect1>
17601N/A
11965N/A<refsect1 id="dbus-monitor-1-exit"><title>&exit-tt;</title>
17601N/A<para>
17601N/AThe following exit values are returned:
17601N/A</para>
17601N/A
11965N/A<variablelist termlength="xtranarrow">
11965N/A<varlistentry>
11965N/A<term><returnvalue>0</returnvalue></term>
11965N/A<listitem><para>
11965N/AApplication exited successfully
17601N/A</para></listitem></varlistentry>
17601N/A
11965N/A<varlistentry>
11965N/A<term><returnvalue>>0</returnvalue></term>
11965N/A<listitem><para>
11965N/AApplication exited with failure
17601N/A</para></listitem></varlistentry>
17616N/A</variablelist>
17616N/A</refsect1>
17601N/A
11965N/A<refsect1 id="dbus-monitor-1-file"><title>&file-tt;</title>
17601N/A<para>
17601N/AThe following files are used by this application:
17601N/A</para>
17601N/A
11965N/A<variablelist termlength="wide">
11965N/A<varlistentry>
11965N/A<term><filename>/usr/bin/&cmd;</filename></term>
11965N/A<listitem><para>
15985N/AExecutable for <command>&cmd;</command>
17616N/A</para></listitem></varlistentry>
11965N/A</variablelist></refsect1>
17601N/A
11965N/A<refsect1 id="dbus-monitor-1-attr"><title>&attr-tt;</title>
17601N/A<para>
17601N/ASee
17601N/A<olink targetdocent="REFMAN5" localinfo="attributes-5">
17601N/A<citerefentry><refentrytitle>attributes</refentrytitle>
17601N/A<manvolnum>5</manvolnum></citerefentry></olink>
17601N/Afor descriptions of the following attributes:
17601N/A</para>
11965N/A<informaltable frame="all">
17601N/A<tgroup cols="2" colsep="1" rowsep="1">
17601N/A<colspec colname="COLSPEC0" colwidth="1*">
11965N/A<colspec colname="COLSPEC1" colwidth="1*">
11965N/A<thead>
17601N/A<row>
17601N/A<entry align="center" valign="middle">ATTRIBUTE TYPE</entry>
17601N/A<entry align="center" valign="middle">ATTRIBUTE VALUE</entry></row>
11965N/A</thead>
11965N/A<tbody>
17601N/A<row>
17601N/A<entry><para>Availability</para></entry>
18745N/A<entry><para>system/library/dbus</para></entry>
17601N/A</row>
17601N/A<row>
17601N/A<entry colname="COLSPEC0"><para>Interface stability</para></entry>
17601N/A<entry colname="COLSPEC1"><para>Volatile</para></entry>
17601N/A</row>
17601N/A</tbody></tgroup></informaltable>
11965N/A</refsect1>
17601N/A
11965N/A<refsect1 id="dbus-monitor-1-also"><title>&also-tt;</title>
11965N/A<!--Reference to another man page-->
11965N/A<!--Reference to a Help manual-->
11965N/A<!--Reference to a book.-->
11965N/A<para>
17601N/AMore information can be found at:
17601N/A</para>
17601N/A
17601N/A<para>
17601N/A<literal>http://www.freedesktop.org/software/dbus/</literal>
17601N/A</para>
17601N/A
17601N/A<para>
15995N/A<citerefentry><refentrytitle>dbus-binding-tool</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
11965N/A<citerefentry><refentrytitle>dbus-cleanup-sockets</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
13931N/A<citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
11965N/A<citerefentry><refentrytitle>dbus-launch</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
11965N/A<citerefentry><refentrytitle>dbus-send</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
11965N/A<citerefentry><refentrytitle>dbus-uuidgen</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
11965N/A<citerefentry><refentrytitle>libdbus-glib-1</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
11965N/A<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>
11965N/A</para>
11965N/A</refsect1>
17601N/A
11965N/A<refsect1 id="dbus-monitor-1-note"><title>&note-tt;</title>
11965N/A<para>
11965N/AFor authorship information refer to
11965N/A<literal>http://www.freedesktop.org/software/dbus/doc/AUTHORS</literal>.
11965N/AUpdated by Brian Cameron, Sun Microsystems Inc., 2007.
11965N/A</para>
17601N/A
11965N/A<para>
15985N/A<command>&cmd;</command> was written by Philip Blundell. The profiling output
15985N/Amode was added by Olli Salli.
11965N/A</para>
17601N/A
11965N/A<para>
11965N/APlease send bug reports to the D\-Bus mailing list or bug
11965N/Atracker, see
11965N/A<literal>http://www.freedesktop.org/software/dbus/</literal>
11965N/A</para>
11965N/A</refsect1>
11965N/A</refentry>