2003-05-03 22:03:16 +00:00
|
|
|
.\"
|
|
|
|
|
.\" dbus-send manual page.
|
|
|
|
|
.\" Copyright (C) 2003 Red Hat, Inc.
|
|
|
|
|
.\"
|
|
|
|
|
.TH dbus-send 1
|
|
|
|
|
.SH NAME
|
|
|
|
|
dbus-send \- Send a message to a message bus
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.PP
|
|
|
|
|
.B dbus-send
|
2005-01-18 20:42:15 +00:00
|
|
|
[\-\-system | \-\-session] [\-\-dest=NAME] [\-\-print-reply]
|
2003-08-31 01:51:44 +00:00
|
|
|
[\-\-type=TYPE] <destination object path> <message name> [contents ...]
|
2003-05-03 22:03:16 +00:00
|
|
|
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
|
|
|
|
|
The \fIdbus-send\fP command is used to send a message to a D-BUS message
|
|
|
|
|
bus. See http://www.freedesktop.org/software/dbus/ for more
|
|
|
|
|
information about the big picture.
|
|
|
|
|
|
|
|
|
|
.PP
|
|
|
|
|
There are two well-known message buses: the systemwide message bus
|
|
|
|
|
(installed on many systems as the "messagebus" service) and the
|
|
|
|
|
per-user-login-session message bus (started each time a user logs in).
|
2003-06-21 22:20:30 +00:00
|
|
|
The \-\-system and \-\-session options direct \fIdbus-send\fP to send
|
|
|
|
|
messages to the system or session buses respectively. If neither is
|
|
|
|
|
specified, \fIdbus-send\fP sends to the session bus.
|
2003-05-03 22:03:16 +00:00
|
|
|
|
|
|
|
|
.PP
|
2003-06-21 22:20:30 +00:00
|
|
|
Nearly all uses of \fIdbus-send\fP must provide the \-\-dest argument
|
2005-01-18 20:42:15 +00:00
|
|
|
which is the name of a connection on the bus to send the message to. If
|
|
|
|
|
\-\-dest is omitted, no destination is set.
|
2003-05-03 22:03:16 +00:00
|
|
|
|
|
|
|
|
.PP
|
2003-08-31 01:51:44 +00:00
|
|
|
The object path and the name of the message to send must always be
|
|
|
|
|
specified. Following arguments, if any, are the message contents
|
|
|
|
|
(message arguments). These are given as a type name, a colon, and
|
|
|
|
|
then the value of the argument. The possible type names are: string,
|
|
|
|
|
int32, uint32, double, byte, boolean. (D-BUS supports more types than
|
|
|
|
|
these, but \fIdbus-send\fP currently does not.)
|
2003-05-03 22:03:16 +00:00
|
|
|
|
|
|
|
|
.PP
|
|
|
|
|
Here is an example invocation:
|
|
|
|
|
.nf
|
|
|
|
|
|
2005-01-18 20:42:15 +00:00
|
|
|
dbus-send \-\-dest='org.freedesktop.ExampleName \\
|
2003-08-31 01:51:44 +00:00
|
|
|
/org/freedesktop/sample/object/name \\
|
2003-08-18 22:43:30 +00:00
|
|
|
org.freedesktop.ExampleInterface.ExampleMethod \\
|
2003-05-03 22:03:16 +00:00
|
|
|
int32:47 string:'hello world' double:65.32
|
|
|
|
|
|
|
|
|
|
.fi
|
|
|
|
|
|
2003-08-18 22:43:30 +00:00
|
|
|
Note that the interface is separated from a method or signal
|
|
|
|
|
name by a dot, though in the actual protocol the interface
|
|
|
|
|
and the interface member are separate fields.
|
|
|
|
|
|
2003-05-03 22:03:16 +00:00
|
|
|
.SH OPTIONS
|
|
|
|
|
The following options are supported:
|
|
|
|
|
.TP
|
2005-01-18 20:42:15 +00:00
|
|
|
.I "--dest=NAME"
|
|
|
|
|
Specify the name of the connection to receive the message.
|
2003-05-16 20:09:25 +00:00
|
|
|
.TP
|
|
|
|
|
.I "--print-reply"
|
|
|
|
|
Block for a reply to the message sent, and print any reply received.
|
|
|
|
|
.TP
|
2003-05-18 02:39:47 +00:00
|
|
|
.I "--system"
|
2003-06-21 22:20:30 +00:00
|
|
|
Send to the system message bus.
|
|
|
|
|
.TP
|
|
|
|
|
.I "--session"
|
|
|
|
|
Send to the session message bus. (This is the default.)
|
2003-08-11 02:11:58 +00:00
|
|
|
.TP
|
|
|
|
|
.I "--type=TYPE"
|
|
|
|
|
Specify "method_call" or "signal" (defaults to "signal").
|
2003-05-03 22:03:16 +00:00
|
|
|
|
|
|
|
|
.SH AUTHOR
|
|
|
|
|
dbus-send was written by Philip Blundell.
|
|
|
|
|
|
|
|
|
|
.SH BUGS
|
|
|
|
|
Please send bug reports to the D-BUS mailing list or bug tracker,
|
|
|
|
|
see http://www.freedesktop.org/software/dbus/
|
