cmake/tools/dbus-monitor.xml

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