dbus-send.1 revision 17601
222N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
222N/A<!--ArborText, Inc., 1988-1999, v.4002-->
222N/A<!--ARC : LSARC 2006/368 D-BUS Message Bus System -->
222N/A<!ENTITY cmd "dbus-send">
355N/A<!ENTITY % commonents SYSTEM "smancommon.ent">
222N/A%commonents;
222N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">
222N/A%booktitles;
222N/A<!ENTITY suncopy "Copyright (c) 2007,2009 Sun Microsystems, Inc. All Rights Reserved.">
222N/A]>
222N/A<?Pub UDT _bookmark _target>
222N/A<?Pub Inc>
222N/A<refentry id="dbus-send-1">
222N/A<!-- %Z%%M% %I% %E% SMI; -->
222N/A<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>1</manvolnum>
222N/A<refmiscinfo class="date">25 Feb 2009</refmiscinfo>
222N/A<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
222N/A<refmiscinfo class="software">&release;</refmiscinfo>
222N/A<refmiscinfo class="arch">generic</refmiscinfo>
222N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
222N/A</refmeta>
222N/A<indexterm><primary>&cmd;</primary></indexterm><indexterm><primary>
222N/ASend a message to a message bus
222N/A</primary></indexterm><refnamediv id="dbus-send-1-name">
222N/A<refname>&cmd;</refname><refpurpose>
222N/ASend a message to a message bus
222N/A</refpurpose></refnamediv>
222N/A<refsynopsisdiv id="dbus-send-1-synp"><title>&synp-tt;</title>
222N/A<cmdsynopsis><command>&cmd;</command>
222N/A<arg choice="opt"><option>-system</option> | <option>-session</option></arg>
222N/A<arg choice="opt"><option>-dest=<replaceable>name</replaceable></option></arg>
222N/A<arg choice="opt"><option>-help</option></arg>
540N/A<arg choice="opt"><option>-print-reply</option></arg>
222N/A<arg choice="opt"><option>-type=<replaceable>type</replaceable></option></arg>
222N/A<arg choice="plain"><option role="nodash">destination_object_path</option></arg>
493N/A<arg choice="plain"><option role="nodash">message_name</option></arg>
493N/A<arg rep="repeat"><option role="nodash">contents</option></arg>
222N/A</cmdsynopsis></refsynopsisdiv>
222N/A
540N/A<refsect1 id="dbus-send-1-desc"><title>&desc-tt;</title>
222N/A<para>
222N/AThe <command>&cmd;</command> command is used to send a message to a D\-Bus
222N/Amessage bus.
222N/A</para>
222N/A
222N/A<para>
222N/AThere are two standard message buses:
222N/A</para>
493N/A
493N/A<itemizedlist>
493N/A<listitem><para>
222N/Asystemwide message bus - Launched when the system is started and is always
493N/Aavailable. Additional systemwide services can be launched via the D\-Bus
493N/A&quot;service activation&quot; feature. However, note that this
493N/A&quot;service activation&quot; feature is disabled on Solaris.
222N/A</para></listitem>
222N/A<listitem><para>
365N/Aper-user-login-session message bus - Launched each time a user logs in.
365N/A</para></listitem>
222N/A</itemizedlist>
355N/A
355N/A<para>
355N/AThe <option>-system</option> and <option>-session</option> options direct
355N/A<command>&cmd;</command> to send messages to the system or session buses
222N/Arespectively. If neither is specified, &cmd; sends to the session bus.
493N/A</para>
222N/A
222N/A<para>
222N/ANearly all uses of <command>&cmd;</command> must provide the
222N/A<option>-dest</option> argument which is the name of a connection on the bus to
222N/Asend the message to. If <option>-dest</option> is omitted, no destination is
222N/Aset.
222N/A</para>
222N/A
222N/A<para>
222N/AThe object path and the name of the message to send must always be specified.
222N/AFollowing arguments, if any, are the message contents (message arguments).
222N/AThese are given as type-specified values and may include containers (arrays,
222N/Adicts, and variants) as described below.
222N/A</para>
222N/A
222N/A<para>
222N/A<screen>
222N/A &lt;contents&gt; ::= &lt;item&gt; | &lt;container&gt; [ &lt;item&gt; | &lt;container&gt;...]
222N/A &lt;item&gt; ::= &lt;type&gt;:&lt;value&gt;
222N/A &lt;container&gt; ::= &lt;array&gt; | &lt;dict&gt; | &lt;variant&gt;
222N/A &lt;array&gt; ::= array:&lt;type&gt;:&lt;value&gt;[,&lt;value&gt;...]
222N/A &lt;dict&gt; ::= dict:&lt;type&gt;:&lt;type&gt;:&lt;key&gt;,&lt;value&gt;[,&lt;key&gt;,&lt;value&gt;...]
222N/A &lt;variant&gt; ::= variant:&lt;type&gt;:&lt;value&gt;
222N/A &lt;type&gt; ::= string | int16 | uint 16 | int32 | uint32 |
222N/A int64 | uint64 | double | byte | boolean | objpath
222N/A</screen>
493N/A</para>
361N/A
222N/A<para>
222N/AD-Bus supports more types than these, but <command>&cmd;</command> currently
222N/Adoes not. Also, <command>&cmd;</command> does not permit empty containers or
493N/Anested containers (e.g. arrays of variants).
365N/A</para>
365N/A</refsect1>
365N/A
365N/A<refsect1 id="dbus-send-1-opts"><title>&opts-tt;</title>
365N/A
365N/A<para>
365N/AThe following options are supported:
365N/A</para>
365N/A
365N/A<variablelist termlength="wholeline">
365N/A<varlistentry>
365N/A<term><option>-dest=<replaceable>name</replaceable></option></term>
365N/A<listitem><para>
365N/ASpecify the <replaceable>name</replaceable> of the connection to receive the
365N/Amessage.
365N/A</para>
</listitem></varlistentry>
<varlistentry>
<term><option>-help</option></term>
<listitem><para>
Show help information on standard output and exit.
</para>
</listitem></varlistentry>
<varlistentry>
<term><option>-print-reply</option></term>
<listitem><para>
Block for a reply to the message sent, and print any reply received.
</para>
</listitem></varlistentry>
<varlistentry>
<term><option>-session</option></term>
<listitem><para>
Send to the session message bus (this is the default).
</para>
</listitem></varlistentry>
<varlistentry>
<term><option>-system</option></term>
<listitem><para>
Send to the system message bus. The system bus is disabled and unsupported
on Solaris.
</para>
</listitem></varlistentry>
<varlistentry>
<term><option>-type=<replaceable>type</replaceable></option></term>
<listitem><para>
Specify &quot;method_call&quot; or &quot;signal&quot; (defaults to
&quot;signal&quot;).
</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="dbus-send-1-oper"><title>&oper-tt;</title>
<para>
The following operands are supported:
</para>
<variablelist termlength="medium">
<varlistentry>
<term><option role="nodash"><replaceable>destination_object_path</replaceable></option></term>
<listitem><para>
The object path of the message to send must always be specified.
</para>
</listitem></varlistentry>
<varlistentry>
<term><option role="nodash"><replaceable>message_name</replaceable></option></term>
<listitem><para>
The name of the message to send must always be specified.
</para>
</listitem></varlistentry>
<varlistentry>
<term><option role="nodash"><replaceable>contents</replaceable></option></term>
<listitem><para>
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.
</para>
</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="dbus-send-1-exam"><title>&exam-tt;</title>
<example role="example">
<title>How to use <command>&cmd;</command> with a sh-compatible shell to start
the per-session bus daemon</title>
<para>
<screen>example% <userinput>&cmd; --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 \\
objpath:/org/freedesktop/sample/object/name
</userinput>
</screen></para>
<para>
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.
</para>
</example>
</refsect1>
<refsect1 id="dbus-send-1-exit"><title>&exit-tt;</title>
<para>
The following exit values are returned:
</para>
<variablelist termlength="xtranarrow">
<varlistentry>
<term><returnvalue>0</returnvalue></term>
<listitem><para>
Application exited successfully
</para>
</listitem></varlistentry>
<varlistentry>
<term><returnvalue>>0</returnvalue></term>
<listitem><para>
Application exited with failure
</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="dbus-send-1-file"><title>&file-tt;</title>
<para>
The following files are used by this application:
</para>
<variablelist termlength="wide">
<varlistentry>
<term><filename>/usr/bin/&cmd;</filename></term>
<listitem><para>
Executable for <command>&cmd;</command>
</para>
</listitem></varlistentry>
</variablelist>
</refsect1>
<refsect1 id="dbus-send-1-attr"><title>&attr-tt;</title>
<para>
See
<olink targetdocent="REFMAN5" localinfo="attributes-5">
<citerefentry><refentrytitle>attributes</refentrytitle>
<manvolnum>5</manvolnum></citerefentry></olink>
for descriptions of the following attributes:
</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="COLSPEC0" colwidth="1*">
<colspec colname="COLSPEC1" colwidth="1*">
<thead>
<row>
<entry align="center" valign="middle">ATTRIBUTE TYPE</entry>
<entry align="center"
valign="middle">ATTRIBUTE VALUE</entry></row>
</thead>
<tbody>
<row>
<entry><para>Availability</para></entry>
<entry><para>SUNWdbus</para></entry>
</row>
<row>
<entry colname="COLSPEC0"><para>Interface stability</para></entry>
<entry colname="COLSPEC1"><para>Volatile</para></entry>
</row>
</tbody></tgroup>
</informaltable>
</refsect1>
<refsect1 id="dbus-send-1-also"><title>&also-tt;</title>
<!--Reference to another man page-->
<!--Reference to a Help manual-->
<!--Reference to a book.-->
<para>
More information can be found at:
</para>
<para>
<literal>http://www.freedesktop.org/software/dbus/</literal>
</para>
<para>
<citerefentry><refentrytitle>dbus-binding-tool</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>dbus-cleanup-sockets</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>dbus-launch</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>dbus-monitor</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>dbus-uuidgen</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>libdbus-glib-1</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
<refsect1 id="dbus-send-1-note"><title>&note-tt;</title>
<para>
For authorship information refer to
<literal>http://www.freedesktop.org/software/dbus/doc/AUTHORS</literal>.
Updated by Brian Cameron, Sun Microsystems Inc., 2007.
</para>
<para>
<command>&cmd;</command> was written by Philip Blundell.
</para>
<para>
Please send bug reports to the D\-Bus mailing list or bug
tracker, see
<literal>http://www.freedesktop.org/software/dbus/</literal>
</para>
</refsect1>
</refentry>