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 [\-\-system | \-\-session] [\-\-dest=SERVICE] [\-\-print-reply] [\-\-type=TYPE] <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 The \-\-system and \-\-session options direct \fIdbus-send\fP to send
  24 messages to the system or session buses respectively.  If neither is
  25 specified, \fIdbus-send\fP sends to the session bus.
  26
  27 .PP
  28 Nearly all uses of \fIdbus-send\fP must provide the \-\-dest argument
  29 which is the name of a service on the bus to send the message to. If
  30 \-\-dest is omitted, a default service name of
  31 "org.freedesktop.DBus.Broadcast" is used.
  32
  33 .PP
  34 The name of the message to send must always be specified. Following
  35 arguments, if any, are the message contents (message arguments).
  36 These are given as a type name, a colon, and then the value of the
  37 argument. The possible type names are: string, int32, uint32, double,
  38 byte, boolean.  (D-BUS supports more types than these, but
  39 \fIdbus-send\fP currently does not.)
  40
  41 .PP
  42 Here is an example invocation:
  43 .nf
  44
  45   dbus-send \-\-dest='org.freedesktop.ExampleService'        \\
  46             org.freedesktop.ExampleInterface.ExampleMethod   \\
  47             int32:47 string:'hello world' double:65.32
  48
  49 .fi
  50
  51 Note that the interface is separated from a method or signal
  52 name by a dot, though in the actual protocol the interface
  53 and the interface member are separate fields.
  54
  55 .SH OPTIONS
  56 The following options are supported:
  57 .TP
  58 .I "--dest=SERVICE"
  59 Specify the service to receive the message.
  60 .TP
  61 .I "--print-reply"
  62 Block for a reply to the message sent, and print any reply received.
  63 .TP
  64 .I "--system"
  65 Send to the system message bus.
  66 .TP
  67 .I "--session"
  68 Send to the session message bus.  (This is the default.)
  69 .TP
  70 .I "--type=TYPE"
  71 Specify "method_call" or "signal" (defaults to "signal").
  72
  73 .SH AUTHOR
  74 dbus-send was written by Philip Blundell.
  75
  76 .SH BUGS
  77 Please send bug reports to the D-BUS mailing list or bug tracker,
  78 see http://www.freedesktop.org/software/dbus/