2003-05-03 Havoc Pennington <hp@pobox.com>
[platform/upstream/dbus.git] / tools / dbus-send.1
1 .\" 
2 .\" dbus-send manual page.
3 .\" Copyright (C) 2003 Red Hat, Inc.
4 .\"
5 .TH dbus-send 1
6 .SH NAME
7 dbus-send \- Send a message to a message bus
8 .SH SYNOPSIS
9 .PP
10 .B dbus-send
11 [\-\-session] [\-\-dest=SERVICE] <message name> [contents ...]
12
13 .SH DESCRIPTION
14
15 The \fIdbus-send\fP command is used to send a message to a D-BUS message
16 bus. See http://www.freedesktop.org/software/dbus/ for more 
17 information about the big picture.
18
19 .PP
20 There are two well-known message buses: the systemwide message bus 
21 (installed on many systems as the "messagebus" service) and the 
22 per-user-login-session message bus (started each time a user logs in).
23 \fIdbus-send\fP sends messages to the system bus by default, and 
24 to the per-session bus if you specify \-\-session.
25
26 .PP 
27 Nearly all uses of \fIdbus-send\fP must provide the \-\-dest 
28 argument which is the name of a service on the bus to send 
29 the message to. The other required argument is the name 
30 of the message to send. Following arguments are the message 
31 contents (message arguments).
32
33 .PP
34 The message arguments are given as a type name, a colon, 
35 and then the value of the argument. The possible type names 
36 are: string, int32, uint32, double, byte, boolean.
37 D-BUS supports more types than these, but \fIdbus-send\fP
38 does not currently.
39
40 .PP
41 Here is an example invocation:
42 .nf
43
44   dbus-send \-\-dest='org.freedesktop.ExampleService'     \\
45             org.freedesktop.ExampleMessage              \\
46             int32:47 string:'hello world' double:65.32
47
48 .fi
49
50 .SH OPTIONS
51 The following options are supported:
52 .TP
53 .I "--session"
54 Use the per-login-session message bus instead of the systemwide bus.
55 .TP
56 .I "--dest=SERVICE"
57 Specify the service to receive the message.
58
59 .SH AUTHOR
60 dbus-send was written by Philip Blundell.
61
62 .SH BUGS
63 Please send bug reports to the D-BUS mailing list or bug tracker,
64 see http://www.freedesktop.org/software/dbus/