summaryrefslogtreecommitdiffstats
path: root/tools/dbus-send.1
diff options
context:
space:
mode:
Diffstat (limited to 'tools/dbus-send.1')
-rw-r--r--tools/dbus-send.129
1 files changed, 19 insertions, 10 deletions
diff --git a/tools/dbus-send.1 b/tools/dbus-send.1
index 08ea1335..725507c0 100644
--- a/tools/dbus-send.1
+++ b/tools/dbus-send.1
@@ -8,7 +8,8 @@ dbus-send \- Send a message to a message bus
.SH SYNOPSIS
.PP
.B dbus-send
-[\-\-system | \-\-session] [\-\-dest=SERVICE] [\-\-print-reply] <message name> [contents ...]
+[\-\-system | \-\-session] [\-\-dest=SERVICE] [\-\-print-reply]
+[\-\-type=TYPE] <destination object path> <message name> [contents ...]
.SH DESCRIPTION
@@ -28,26 +29,31 @@ specified, \fIdbus-send\fP sends to the session bus.
Nearly all uses of \fIdbus-send\fP must provide the \-\-dest argument
which is the name of a service on the bus to send the message to. If
\-\-dest is omitted, a default service name of
-"org.freedesktop.DBus.Broadcast" is used.
+"org.freedesktop.Broadcast" is used.
.PP
-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.)
+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.)
.PP
Here is an example invocation:
.nf
- dbus-send \-\-dest='org.freedesktop.ExampleService' \\
- org.freedesktop.ExampleMessage \\
+ dbus-send \-\-dest='org.freedesktop.ExampleService' \\
+ /org/freedesktop/sample/object/name \\
+ org.freedesktop.ExampleInterface.ExampleMethod \\
int32:47 string:'hello world' double:65.32
.fi
+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.
+
.SH OPTIONS
The following options are supported:
.TP
@@ -62,6 +68,9 @@ Send to the system message bus.
.TP
.I "--session"
Send to the session message bus. (This is the default.)
+.TP
+.I "--type=TYPE"
+Specify "method_call" or "signal" (defaults to "signal").
.SH AUTHOR
dbus-send was written by Philip Blundell.