blob: 131a60df14193fe6c5314a257350170b5c1347fb [file] [log] [blame]
.\" dbus\-send manual page.
.\" Copyright (C) 2003 Red Hat, Inc.
.TH dbus\-send 1
dbus\-send \- Send a message to a message bus
.B dbus\-send
[\fB\-\-system\fP | \fB\-\-session\fP]
The \fIdbus\-send\fP command is used to send a message to a D\-Bus message
bus. See for more
information about the big picture.
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).
The \fB\-\-system\fP and \fB\-\-session\fP options direct
\fBdbus\-send\fP to send messages to the system or session buses respectively.
If neither is specified, \fBdbus\-send\fP sends to the session bus.
Nearly all uses of \fBdbus\-send\fP must provide the \fB\-\-dest\fP argument
which is the name of a connection on the bus to send the message to. If
\fB\-\-dest\fP is omitted, no destination is set.
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 type\-specified values and
may include containers (arrays, dicts, and variants) as described below.
<contents> ::= <item> | <container> [ <item> | <container>...]
<item> ::= <type>:<value>
<container> ::= <array> | <dict> | <variant>
<array> ::= array:<type>:<value>[,<value>...]
<dict> ::= dict:<type>:<type>:<key>,<value>[,<key>,<value>...]
<variant> ::= variant:<type>:<value>
<type> ::= string | int16 | uint 16 | int32 | uint32 | int64 | uint64 | double | byte | boolean | objpath
D\-Bus supports more types than these, but \fBdbus\-send\fP currently
does not. Also, \fBdbus\-send\fP does not permit empty containers
or nested containers (e.g. arrays of variants).
Here is an example invocation:
dbus\-send \-\-dest=org.freedesktop.ExampleName \\
/org/freedesktop/sample/object/name \\
org.freedesktop.ExampleInterface.ExampleMethod \\
int32:47 string:'hello world' double:65.32 \\
array:string:"1st item","next item","last item" \\
dict:string:int32:"one",1,"two",2,"three",3 \\
variant:int32:\-8 \\
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.
The following options are supported:
.BI \-\-dest= NAME
Specify the name of the connection to receive the message.
.B "\-\-print\-reply"
Block for a reply to the message sent, and print any reply received
in a human-readable form.
.B "\-\-print\-reply=literal"
Block for a reply to the message sent, and print the body of the
reply. If the reply is an object path or a string, it is printed
literally, with no punctuation, escape characters etc.
.BI \-\-reply\-timeout= MSEC
Wait for a reply for up to \fIMSEC\fP milliseconds.
The default is implementation\(hydefined, typically 25 seconds.
.B "\-\-system"
Send to the system message bus.
.B "\-\-session"
Send to the session message bus. (This is the default.)
.BI \-\-type= TYPE
Specify \fBmethod_call\fP or \fBsignal\fP (defaults to "\fBsignal\fP").
dbus\-send was written by Philip Blundell.
Please send bug reports to the D\-Bus mailing list or bug tracker,