* s/D-BUS/D-Bus/g
[platform/upstream/dbus.git] / tools / 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]
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 In order to get \fIdbus-monitor\fP to see the messages you are interested
31 in, you should specify a set of watch expressions as you would expect to
32 be passed to the \fIdbus_bus_add_watch\fP function.
33
34 .PP 
35 The message bus configuration may keep \fIdbus-monitor\fP from seeing
36 all messages, especially if you run the monitor as a non-root user.
37
38 .SH OPTIONS
39 .TP
40 .I "--system"
41 Monitor the system message bus.
42 .TP
43 .I "--session"
44 Monitor the session message bus.  (This is the default.)
45
46 .SH EXAMPLE
47 Here is an example of using dbus-monitor to watch for the gnome typing
48 monitor to say things
49 .nf
50
51   dbus-monitor "type='signal',sender='org.gnome.TypingMonitor',interface='org.gnome.TypingMonitor'"
52
53 .fi
54
55 .SH AUTHOR
56 dbus-monitor was written by Philip Blundell.
57
58 .SH BUGS
59 Please send bug reports to the D-Bus mailing list or bug tracker,
60 see http://www.freedesktop.org/software/dbus/