====================================================================
                               AUTOIDLE

                  Being as idle and away as possible
====================================================================


0. Content
----------

0. Content
1. Copying
2. Purpose
3. Build
4. Install
5. Reference


1. Copying
----------

This program is Copyright (C) Helge Jensen <jensen@slog.dk>

This program may be distributed under the terms described in the file
COPYING (The General Public License).


2. Purpose
----------

The purpose of AUTOIDLE is simple: make xchat set you away when you
don't touch the keyboard or mouse for a while.


3. Build
--------

  1. Get the sources, bleeding edge is at 
        http://svn.slog.dk/repos/home/jensen/autoidle
  2. Try running GNU Make:

        $ gmake

     or 

        $ make
     
     This should produce autoidle.dll or autoidle.so, depending on
     your platform.


4. Install
----------

1. Load the dynamic link library produced in "Build" as a plugin in
   xchat.

   You can put the plugin into xchats "plugins" directory to have it
   automatically loaded



5. Reference
------------

Autoidle sets you as away whenever you have not interacted with your
computer (in a detectable way) for a certain amount of time.

The default timeout is 600s, which is 10 minutes.

The default away message is "auto idle"

You can change the defaults by typing "/AUTOIDLE TIME [MESSAGE]" in
xchat. autoidle will print an informational message back to you,
saying what it actually set the timeout and message to.

If you mark yourself idle with another message than the one AUTOIDLE
uses, AUTOIDLE will not set you away or back on those servers.