eboxy remote control plugin 0.1
-------------------------------

This eboxy plugin provides a way to control eboxy from shell scripts or
interactively via the console. It allows you to send standard or user actions
to eboxy. It consists of two parts - the remote control server plugin (rcon)
which must be loaded into eboxy, and the command-line client (eboxy-remote).

rcon listens for commands on UDP port 5450. Anything it receives is executed
as an action.

eboxy-remote is a command-line application which connects to an arbitrary
machine on port 5450 and sends actions you specify. You can either use it
interactively, pipe a script into it, or specify one action to be sent on
the command line after the hostname. See the eboxy user guide for details on
standard and user actions that you can send.

WARNING: use of this plugin on unsecured networks (eg. the internet) is
entirely at your own risk. rcon provides no authentication or security. You
have been warned.


Installation
------------

Run make and then (as root) make install.

If your system is set up in a non-standard way you may have to modify the
makefile slightly. In the future this plugin will use autoconf/automake to
avoid this.


Usage
-----

To load the plugin, you need to add a <plugin> section into your XML file.
Here's an example (details have been stripped out):

...
    <page name="test2">
      <plugin module="rcon" />
      <button x="40" y="20" caption="Help" action="help" template="t_button">
        <event type="OnClick">
          echo "Help button was pressed"
        </event>
      </button>
...

Say eboxy was running with the above XML file on the machine at 192.168.1.5.
Running "eboxy-remote 192.168.1.5 help" would cause the Help button to be
pressed.


Reference
---------

Properties:

  port
    Port to listen on (default 5450)

  address
    Address to listen on (default 127.0.0.1)

Methods:

  listen()
    Start listening immediately. Normally the rcon plugin begins listening
    when the page is shown.

Events:

  None.


Notes
-----

- You cannot use telnet to connect to the rcon plugin as it expects commands
  to be sent in one packet. However, you can use netcat to send commands,
  eg.:

  echo -n quit | netcat -u localhost 5450

  Obviously there isn't much of an advantage to using this as opposed to
  eboxy-remote, unless of course you don't have eboxy-remote installed on the
  local machine.

  
Todo
----

- Better error checking
- Authentication?


eboxy
-----

eboxy is a GUI system for set-top boxes. For more information on eboxy, visit:

  http://eboxy.sourceforge.net

If you have any questions or suggestions, please send them to the eboxy mailing
list at eboxy-users@sourceforge.net.


Licence
-------

This plugin is released under the GPL, version 2 (or a later version, at your
option). For more information on the GNU GPL please visit http://www.fsf.org.
For copyright details please see individual source code files.
