<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [

<!--ArborText, Inc., 1988-1999, v.4002-->

<!ENTITY cmd "purple-remote">

<!ENTITY % commonents SYSTEM "smancommon.ent">

%commonents;

<!ENTITY % booktitles SYSTEM "booktitles.ent">

%booktitles;

<!ENTITY suncopy "Copyright (c) 2004, 2007, Sun Microsystems, Inc. All Rights Reserved.">

]>

<?Pub UDT _bookmark _target>

<?Pub Inc>

<refentry id="purple-remote-1">

<refmeta><refentrytitle>purple-remote</refentrytitle><manvolnum>1</manvolnum>

<refmiscinfo class="date">02 Apr 2008</refmiscinfo>

<refmiscinfo class="sectdesc">&man1;</refmiscinfo>

<refmiscinfo class="software">&release;</refmiscinfo>

<refmiscinfo class="arch">generic</refmiscinfo>

<refmiscinfo class="copyright">&suncopy;</refmiscinfo>

</refmeta>

<indexterm><primary>purple-remote</primary></indexterm><indexterm><primary>Send remote commands to Pidgin/Finch</primary></indexterm>

<refnamediv id="purple-remote-1-name"><refname>purple-remote</refname><refpurpose>Send remote commands to Pidgin/Finch</refpurpose></refnamediv>

<refsynopsisdiv id="purple-remote-1-synp"><title>&synp-tt;</title>

<cmdsynopsis><command>&cmd;</command>

<arg choice="opt"><option>command1</option></arg>

<arg choice="opt"><option>command2</option></arg>

<arg choice="opt"><option>...</option></arg>

</cmdsynopsis></refsynopsisdiv>

<refsect1 id="purple-remote-1-desc"><title>&desc-tt;</title>

<para>Send remote commands to Purple. This program uses DBus to communicate

with Pidgin/Finch.</para>

</refsect1>

<refsect1 id="purple-remote-1-opts"><title>&opts-tt;</title>

<para>

Each command is of one of the three types:

[protocol:]commandname?param1=value1&param2=value2&...

FunctionName?param1=value1&param2=value2&...

FunctionName(value1,value2,...)

The second and third form are provided for completeness but their use is not recommended; use purple-send or purple-send-async instead. The second form uses introspection to find out the parameter names and their types, therefore it is rather slow.

Here are some examples:

jabber:goim?screenname=testone@localhost&message=hi

jabber:gochat?room=TestRoom&server=conference.localhost

jabber:getinfo?screenname=testone@localhost

jabber:addbuddy?screenname=my friend

setstatus?status=away&message=don't disturb

quit

PurpleAccountsFindConnected?name=&protocol=prpl-jabber

PurpleAccountFindConnected(,prpl-jabber)

</para>

</refsect1>

<refsect1 id="purple-remote-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>communication/im/pidgin</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="purple-remote-1-also"><title>&also-tt;</title>

<para>

<citerefentry><refentrytitle>purple-send</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>purple-send-async</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>purple-url-handler</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>

</para>

<para>

<citetitle>&cmd; Manual</citetitle>,

<literal>http://pidgin.im/</literal>

</para>

</refsect1>

<refsect1 id="purple-remote-1-note"><title>&note-tt;</title>

<para>Updated by Lei Ju, Sun Microsystems Inc., 2006, 2007.</para>

</refsect1>

</refentry>