<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [

<!--ArborText, Inc., 1988-1999, v.4002-->

<!ENTITY cmd "dbus-monitor">

<!ENTITY % commonents SYSTEM "smancommon.ent">

%commonents;

<!ENTITY % booktitles SYSTEM "booktitles.ent">

%booktitles;

<!ENTITY suncopy "Copyright (c) 2007 Sun Microsystems, Inc. All Rights Reserved.">

]>

<?Pub UDT _bookmark _target>

<?Pub Inc>

<refentry id="dbus-monitor-1">

<!-- %Z%%M% %I% %E% SMI; -->

<refmeta><refentrytitle>dbus-monitor</refentrytitle><manvolnum>1</manvolnum>

<refmiscinfo class="date">19 Nov 2007</refmiscinfo>

<refmiscinfo class="sectdesc">&man1;</refmiscinfo>

<refmiscinfo class="software">&release;</refmiscinfo>

<refmiscinfo class="arch">generic</refmiscinfo>

<refmiscinfo class="copyright">&suncopy;</refmiscinfo>

</refmeta>

<indexterm><primary>dbus-monitor</primary></indexterm><indexterm><primary>

debug probe to print message bus messages

</primary></indexterm><refnamediv id="dbus-monitor-1-name">

<refname>dbus-monitor</refname><refpurpose>

debug probe to print message bus messages

</refpurpose></refnamediv>

<refsynopsisdiv id="dbus-monitor-1-synp"><title>&synp-tt;</title>

<cmdsynopsis><command>&cmd;</command>

<arg choice="opt"><option>-system</option> | <option>-session</option></arg>

<arg choice="opt"><option>-profile</option> | <option>-monitor</option></arg>

<arg choice="opt"><option role="nodash">watch_expressions</option></arg>

</cmdsynopsis></refsynopsisdiv>

<refsect1 id="dbus-monitor-1-desc"><title>&desc-tt;</title>

<para>

The &cmd; command is used to monitor messages going through a D\-Bus message

bus.

</para>

<para>

There are two standard message buses:

</para>

<itemizedlist>

<listitem><para>

systemwide message bus - Disabled and not supported on Solaris, but installed

on many systems as the "messagebus" init service.

</para></listitem>

<listitem><para>

per-user-login-session message bus - Enabled and supported on Solaris, and

started each time a user logs in.

</para></listitem>

</itemizedlist>

<para>

The <option>-system</option> and <option>-session</option> options direct &cmd;

to monitor the system or session buses respectively.  If neither is specified,

&cmd; monitors the session bus.

</para>

<para>

&cmd; has two different 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

<option>-profile</option> and <option>-monitor</option> options select the

profiling and monitoring output format respectively.  If neither is specified,

&cmd; uses the monitoring output format.

</para>

<para>

The message bus configuration may keep &cmd; from seeing all messages,

especially if you run the monitor as a non-root user.

</para>

<para>

See <literal>http://www.freedesktop.org/software/dbus/</literal>

for more information.

</para>

</refsect1>

<refsect1 id="dbus-monitor-1-opts"><title>&opts-tt;</title>

<para>The following options are supported:</para>

<variablelist termlength="wholeline">

<varlistentry>

<term><option>-monitor</option></term>

<listitem><para>

Use the monitoring output format (this is the default).

</para>

</listitem></varlistentry>

<varlistentry>

<term><option>-profile</option></term>

<listitem><para>

Use the profiling output format.

</para>

</listitem></varlistentry>

<varlistentry>

<term><option>-session</option></term>

<listitem><para>

Monitor the session message bus (this is the default).

</para>

</listitem></varlistentry>

<varlistentry>

<term><option>-system</option></term>

<listitem><para>

Monitor the system message bus.  The system bus is disabled and unsupported

on Solaris.

</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="dbus-monitor-1-oper"><title>&oper-tt;</title>

<para>The following operands are supported:</para>

<variablelist termlength="medium">

<varlistentry>

<term><option role="nodash"><replaceable>watch_expressions</replaceable></option></term>

<listitem><para>

In order to display the messages you are interested in, you should specify

a set of <replaceable>watch_expressions</replaceable> as you would expect

to be passed to the dbus_bus_add_watch function.

</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="dbus-monitor-1-exit"><title>&exit-tt;</title>

<para>The following exit values are returned:</para>

<variablelist termlength="xtranarrow">

<varlistentry>

<term><returnvalue>0</returnvalue></term>

<listitem><para>

Application exited successfully

</para>

</listitem></varlistentry>

<varlistentry>

<term><returnvalue>>0</returnvalue></term>

<listitem><para>

Application exited with failure

</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="dbus-monitor-1-file"><title>&file-tt;</title>

<para>The following files are used by this application:</para>

<variablelist termlength="wide">

<varlistentry>

<term><filename>/usr/bin/&cmd;</filename></term>

<listitem><para>

Executable for &cmd;

</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="dbus-monitor-1-attr"><title>&attr-tt;</title>

<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>

<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>

for descriptions of the following attributes:</para>

<informaltable frame="all">

<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">

<colspec colname="COLSPEC1" colwidth="1*">

<thead>

<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"

valign="middle">ATTRIBUTE VALUE</entry></row>

</thead>

<tbody>

<row><entry>

<para>Availability</para>

</entry><entry>

<para>SUNWdbus</para>

</entry></row><row><entry colname="COLSPEC0">

<para>Interface stability</para>

</entry><entry colname="COLSPEC1">

<para>Volatile</para>

</entry></row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 id="dbus-monitor-1-also"><title>&also-tt;</title>

<!--Reference to another man page-->

<!--Reference to a Help manual-->

<!--Reference to a book.-->

<para>

<citerefentry><refentrytitle>dbus-cleanup-sockets</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>dbus-launch</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>dbus-send</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>dbus-uuidgen</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>libdbus-glib-1</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>

</para>

</refsect1>

<refsect1 id="dbus-monitor-1-note"><title>&note-tt;</title>

<para>

For authorship information refer to

<literal>http://www.freedesktop.org/software/dbus/doc/AUTHORS</literal>.

Updated by Brian Cameron, Sun Microsystems Inc., 2007.

</para>

<para>

&cmd; was written by Philip Blundell.  The profiling output mode was added by

Olli Salli.

</para>

<para>

Please send bug reports to the D\-Bus mailing list or bug

tracker, see

<literal>http://www.freedesktop.org/software/dbus/</literal>

</para>

</refsect1>

</refentry>