mirror of
https://gitlab.freedesktop.org/dbus/dbus.git
synced 2025-12-22 09:00:17 +01:00
8873c90f99
* Throughout, grand renaming to strip out the use of "service", just say "name" instead (or "bus name" when ambiguous). Did not change the internal code of the message bus itself, only the programmer-facing API and messages. * doc/dbus-specification.xml: further update the message bus section * bus/config-parser.c (all_are_equiv): fix bug using freed string in error case
79 lines
2.5 KiB
Groff
79 lines
2.5 KiB
Groff
.\"
|
|
.\" 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
|
|
[\-\-system | \-\-session] [\-\-dest=NAME] [\-\-print-reply]
|
|
[\-\-type=TYPE] <destination object path> <message name> [contents ...]
|
|
|
|
.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).
|
|
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.
|
|
|
|
.PP
|
|
Nearly all uses of \fIdbus-send\fP must provide the \-\-dest argument
|
|
which is the name of a connection on the bus to send the message to. If
|
|
\-\-dest is omitted, no destination is set.
|
|
|
|
.PP
|
|
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.ExampleName \\
|
|
/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
|
|
.I "--dest=NAME"
|
|
Specify the name of the connection to receive the message.
|
|
.TP
|
|
.I "--print-reply"
|
|
Block for a reply to the message sent, and print any reply received.
|
|
.TP
|
|
.I "--system"
|
|
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.
|
|
|
|
.SH BUGS
|
|
Please send bug reports to the D-BUS mailing list or bug tracker,
|
|
see http://www.freedesktop.org/software/dbus/
|