doc/dbus-monitor.1.xml.in

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
   4 <refentry id='dbusmonitor1'>
   5
   6 <!--  dbus&bsol;-monitor manual page.
   7  Copyright (C) 2003 Red Hat, Inc. -->
   8
   9 <refmeta>
  10 <refentrytitle>dbus-monitor</refentrytitle>
  11 <manvolnum>1</manvolnum>
  12 <refmiscinfo class="manual">User Commands</refmiscinfo>
  13 <refmiscinfo class="source">D-Bus</refmiscinfo>
  14 <refmiscinfo class="version">@DBUS_VERSION@</refmiscinfo>
  15 </refmeta>
  16 <refnamediv>
  17 <refname>dbus-monitor</refname>
  18 <refpurpose>debug probe to print message bus messages</refpurpose>
  19 </refnamediv>
  20 <!-- body begins here -->
  21 <refsynopsisdiv id='synopsis'>
  22 <cmdsynopsis>
  23   <command>dbus-monitor</command>
  24     <group choice='opt'><arg choice='plain'>--system </arg><arg choice='plain'>--session </arg><arg choice='plain'>--address <replaceable>ADDRESS</replaceable></arg></group>
  25     <group choice='opt'><arg choice='plain'>--profile </arg><arg choice='plain'>--monitor </arg></group>
  26     <arg choice='opt'><arg choice='plain'><replaceable>watch</replaceable></arg><arg choice='plain'><replaceable>expressions</replaceable></arg></arg>
  27     <sbr/>
  28 </cmdsynopsis>
  29 </refsynopsisdiv>
  30
  31
  32 <refsect1 id='description'><title>DESCRIPTION</title>
  33 <para>The <command>dbus-monitor</command> command is used to monitor messages going
  34 through a D-Bus message bus.  See
  35 <ulink url='http://www.freedesktop.org/software/dbus/'>http://www.freedesktop.org/software/dbus/</ulink> for more information about
  36 the big picture.</para>
  37
  38
  39 <para>There are two well-known message buses: the systemwide message bus
  40 (installed on many systems as the "messagebus" service) and the
  41 per-user-login-session message bus (started each time a user logs in).
  42 The --system and --session options direct <command>dbus-monitor</command> to
  43 monitor the system or session buses respectively.  If neither is
  44 specified, <command>dbus-monitor</command> monitors the session bus.</para>
  45
  46
  47 <para><command>dbus-monitor</command> has two different output modes, the 'classic'-style
  48 monitoring mode and profiling mode. The profiling format is a compact
  49 format with a single line per message and microsecond-resolution timing
  50 information. The --profile and --monitor options select the profiling
  51 and monitoring output format respectively. If neither is specified,
  52 <command>dbus-monitor</command> uses the monitoring output format.</para>
  53
  54
  55 <para>In order to get <command>dbus-monitor</command> to see the messages you are interested
  56 in, you should specify a set of watch expressions as you would expect to
  57 be passed to the <emphasis remap='I'>dbus_bus_add_match</emphasis> function.</para>
  58
  59
  60 <para>The message bus configuration may keep <command>dbus-monitor</command> from seeing
  61 all messages, especially if you run the monitor as a non-root user.</para>
  62
  63 </refsect1>
  64
  65 <refsect1 id='options'><title>OPTIONS</title>
  66 <variablelist remap='TP'>
  67   <varlistentry>
  68   <term><option>--system</option></term>
  69   <listitem>
  70 <para>Monitor the system message bus.</para>
  71   </listitem>
  72   </varlistentry>
  73   <varlistentry>
  74   <term><option>--session</option></term>
  75   <listitem>
  76 <para>Monitor the session message bus.  (This is the default.)</para>
  77   </listitem>
  78   </varlistentry>
  79   <varlistentry>
  80   <term><option>--address ADDRESS</option></term>
  81   <listitem>
  82 <para>Monitor an arbitrary message bus given at ADDRESS.</para>
  83   </listitem>
  84   </varlistentry>
  85   <varlistentry>
  86   <term><option>--profile</option></term>
  87   <listitem>
  88 <para>Use the profiling output format.</para>
  89   </listitem>
  90   </varlistentry>
  91   <varlistentry>
  92   <term><option>--monitor</option></term>
  93   <listitem>
  94 <para>Use the monitoring output format.  (This is the default.)</para>
  95
  96   </listitem>
  97   </varlistentry>
  98 </variablelist>
  99 </refsect1>
 100
 101 <refsect1 id='example'><title>EXAMPLE</title>
 102 <para>Here is an example of using dbus-monitor to watch for the gnome typing
 103 monitor to say things</para>
 104 <literallayout remap='.nf'>
 105
 106   dbus-monitor "type='signal',sender='org.gnome.TypingMonitor',interface='org.gnome.TypingMonitor'"
 107
 108 </literallayout> <!-- .fi -->
 109
 110 </refsect1>
 111
 112 <refsect1 id='author'><title>AUTHOR</title>
 113 <para>dbus-monitor was written by Philip Blundell.
 114 The profiling output mode was added by Olli Salli.</para>
 115
 116 </refsect1>
 117
 118 <refsect1 id='bugs'><title>BUGS</title>
 119 <para>Please send bug reports to the D-Bus mailing list or bug tracker,
 120 see <ulink url='http://www.freedesktop.org/software/dbus/'>http://www.freedesktop.org/software/dbus/</ulink></para>
 121 </refsect1>
 122 </refentry>