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

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

<!ENTITY cmd "gaim-remote">

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

%commonents;

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

%booktitles;

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

]>

<?Pub UDT _bookmark _target>

<?Pub Inc>

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

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

<refmiscinfo class="date">7 Sep 2004</refmiscinfo>

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

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

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

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

</refmeta>

<indexterm><primary>gaim-remote</primary></indexterm>

<indexterm><primary></primary></indexterm>

<refnamediv id="gaim-remote-1-name"><refname>gaim-remote</refname><refpurpose>Gaim command-line remote control</refpurpose></refnamediv>

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

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

<arg choice="opt"><option role="nodash"><replaceable>Options</replaceable></option></arg>

</cmdsynopsis></refsynopsisdiv>

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

<para>gaim-remote is a command-line interface for controlling an already-running instance of the Gaim Instant Messaging client. It currently has only rudimentary support for launching AIM-style URIs, and closing the running instance, although further functionality is planned.</para>

</refsect1>

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

<para>The following options are supported:</para>

<variablelist termlength="narrow">

<varlistentry><term><option role="nodash">-h [command] </option></term>

<listitem><para>Standard options available for use with most GNOME applications. Display help for gaim-remote or a specific command (see below).

</para></listitem></varlistentry>

<varlistentry><term>COMMANDS</term>

<listitem><para>

</para></listitem></varlistentry>

<varlistentry><term>quit </term>

<listitem><para>Closes the currently-running instance of Gaim.

</para></listitem></varlistentry>

<varlistentry><term>uri [URI]</term>

<listitem><para>Sends the given AIM-style URI to the currently running instance of Gaim (see below).

</para></listitem></varlistentry>

<varlistentry><term>URIs</term>

<para>The following URIs are currently valid. These default to acting on the first AIM account you have in your list:</para>

</varlistentry>

<varlistentry><term>aim:goim?screenname=[SCREENNAME]</term>

<listitem><para><para></para>Begins a new conversation with the given screenname.

</para></listitem></varlistentry>

<varlistentry><term>aim:goim?screenname=[SCREENNAME]&message=[MESSAGE]</term>

<listitem><para><para></para>Sends the given message to the screenname. Spaces in the message must be replaced with +.

</para></listitem></varlistentry>

<varlistentry><term>aim:gochat?roomname=[CHATROOM]</term>

<listitem><para><para></para>Opens a chat window in the given room.

</para></listitem></varlistentry>

<varlistentry><term>aim:addbuddy?screenname=[SCREENNAME]</term>

<listitem><para><para></para>Opens a dialog to add the specified buddy to your buddy list.

</para></listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="gaim-remote-1-exam"><title>&exam-tt;</title>

<example role="example">

<title>Launching gaim-remote</title>

<para><screen>example% <userinput>&cmd;</userinput></screen></para>

</example>

</refsect1>

<refsect1 id="gaim-remote-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="gaim-remote-1-file"><title>&file-tt;</title>

<para>The following files are used by this application:</para>

<variablelist termlength="medium">

<varlistentry><term><filename>/usr/bin/&cmd;</filename></term><listitem><para>

Executable for gaim-remote</para>

</listitem></varlistentry>

<varlistentry><term><filename>/tmp/gaim_[USERNAME].[INSTANCE]</filename></term><listitem>

<para></para><para>The UNIX domain socket used to contact the running instance of Gaim

</para></listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="gaim-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></para></entry>

</row>

<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry

colname="COLSPEC1"><para></para></entry></row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 id="gaim-remote-1-also"><title>&also-tt;</title>

<para><citerefentry><refentrytitle>gaim</refentrytitle><manvolnum>

1</manvolnum></citerefentry></para>

</refsect1>

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

<para>This manpage was written by Robert McQueen Debian.org

</para>

</refsect1>

</refentry>