doc/dbus-monitor.1

   1 .\"
   2 .\" dbus\-monitor manual page.
   3 .\" Copyright (C) 2003 Red Hat, Inc.
   4 .\"
   5 .TH dbus\-monitor 1
   6 .SH NAME
   7 dbus\-monitor \- debug probe to print message bus messages
   8 .SH SYNOPSIS
   9 .PP
  10 .B dbus\-monitor
  11 [\-\-system | \-\-session | \-\-address ADDRESS] [\-\-profile | \-\-monitor]
  12 [watch expressions]
  13
  14 .SH DESCRIPTION
  15
  16 The \fIdbus\-monitor\fP command is used to monitor messages going
  17 through a D\-Bus message bus.  See
  18 http://www.freedesktop.org/software/dbus/ for more information about
  19 the big picture.
  20
  21 .PP
  22 There are two well\-known message buses: the systemwide message bus
  23 (installed on many systems as the "messagebus" service) and the
  24 per\-user\-login\-session message bus (started each time a user logs in).
  25 The \-\-system and \-\-session options direct \fIdbus\-monitor\fP to
  26 monitor the system or session buses respectively.  If neither is
  27 specified, \fIdbus\-monitor\fP monitors the session bus.
  28
  29 .PP
  30 \fIdbus\-monitor\fP has two different output modes, the 'classic'\-style
  31 monitoring mode and profiling mode. The profiling format is a compact
  32 format with a single line per message and microsecond\-resolution timing
  33 information. The \-\-profile and \-\-monitor options select the profiling
  34 and monitoring output format respectively. If neither is specified,
  35 \fIdbus\-monitor\fP uses the monitoring output format.
  36
  37 .PP
  38 In order to get \fIdbus\-monitor\fP to see the messages you are interested
  39 in, you should specify a set of watch expressions as you would expect to
  40 be passed to the \fIdbus_bus_add_match\fP function.
  41
  42 .PP
  43 The message bus configuration may keep \fIdbus\-monitor\fP from seeing
  44 all messages, especially if you run the monitor as a non\-root user.
  45
  46 .SH OPTIONS
  47 .TP
  48 .I "\-\-system"
  49 Monitor the system message bus.
  50 .TP
  51 .I "\-\-session"
  52 Monitor the session message bus.  (This is the default.)
  53 .TP
  54 .I "\-\-address ADDRESS"
  55 Monitor an arbitrary message bus given at ADDRESS.
  56 .TP
  57 .I "\-\-profile"
  58 Use the profiling output format.
  59 .TP
  60 .I "\-\-monitor"
  61 Use the monitoring output format.  (This is the default.)
  62
  63 .SH EXAMPLE
  64 Here is an example of using dbus\-monitor to watch for the gnome typing
  65 monitor to say things
  66 .nf
  67
  68   dbus\-monitor "type='signal',sender='org.gnome.TypingMonitor',interface='org.gnome.TypingMonitor'"
  69
  70 .fi
  71
  72 .SH AUTHOR
  73 dbus\-monitor was written by Philip Blundell.
  74 The profiling output mode was added by Olli Salli.
  75
  76 .SH BUGS
  77 Please send bug reports to the D\-Bus mailing list or bug tracker,
  78 see http://www.freedesktop.org/software/dbus/