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