Author: Mark Buck (Kaivalagi) <m_buck@hotmail.com>

PREREQUISITES
=============

It is expected that the user is already familiar with Conky.

Any conky specific help can be found by either visiting the conky website here:

    http://conky.sourceforge.net

Alternatively there is a large user base, various helpful posts are available
at http://www.ubuntuforums.org

For example, to see various incarnations of conky setups, or to ask technical
questions you could go here:
    
        Post your .conkyrc files w/ screenshots

        http://ubuntuforums.org/showthread.php?t=281865 

If you are not familiar with conky there is help available here:

    HOW TO: A Beginners Guide to Setting up Conky

    http://ubuntuforums.org/showthread.php?t=867076


EXAMPLE USE
===========

In the /usr/share/conkypidgin/example folder you'll find 2 files, conkyrc and
conkyPidgin.template

Conky can be run using these example files as follows:

    conky -c /usr/share/conkypidgin/example/conkyrc &
    
Make sure Pidgin is running first...


COMMAND OPTIONS
===============

A break down of all the options available are below. The same details can be
found by running conkyPidgin --help

Usage: conkyPidgin [options]
Options:
  -h, --help            show this help message and exit
  -t FILE, --template=FILE
                        Template file determining the format for each buddy's
                        data. Use the following placeholders: [name], [alias],
                        [group], [status], [status_message].
  -o, --onlineonly      Only show online buddies
  -a, --availableonly   Only show available buddies
  -f, --offlineonly     Only show offline buddies
  -i LIST, --ignorelist=LIST
                        A comma delimited list of groups to ignore. Partial
                        text matches on group will be ignored if found
  -I LIST, --includelist=LIST
                        A comma delimited list of groups to include. Partial
                        text matches on group will be included if found. The
                        ignorelist, if used, takes precedence. if this list is
                        omitted all groups will be included unless ignored.
  -C TEXT, --chattingtext=TEXT
                        [default: Chatting] Text to use for chatting status
                        output
  -A TEXT, --availabletext=TEXT
                        [default: Available] Text to use for available status
                        output
  -U TEXT, --unavailabletext=TEXT
                        [default: Unavailable] Text to use for unavailable
                        status output
  -N TEXT, --invisibletext=TEXT
                        [default: Invisible] Text to use for invisible status
                        output
  -W TEXT, --awaytext=TEXT
                        [default: Away] Text to use for away status output
  -M TEXT, --mobiletext=TEXT
                        [default: Mobile] Text to use for mobile status output
  -F TEXT, --offlinetext=TEXT
                        [default: Offline] Text to use for offline status
                        output
  -l NUMBER, --limit=NUMBER
                        [default: 0] Set a limit to the number of buddies
                        displayed, by default no limitation is made
  -s, --sortbylogactivity
                        If used the list is sorted by most recent activity
                        first, this is useful when limiting the list size with
                        the limit option
  -v, --verbose         Request verbose output, not a good idea when running
                        through conky!
  -V, --version         Displays the version of the script.
  --errorlogfile=FILE   If a filepath is set, the script appends errors to the
                        filepath.
  --infologfile=FILE    If a filepath is set, the script appends info to the
                        filepath.


TEMPLATE FILES
==============

A template file is included in the example files and there are also details on
the template option in the command options listed above.

Note that you can combine standard font output with other fonts in a single
template, but must use execp or execpi conky commands to do so.

Please take a look at the example template provided. You will see that it uses
text inside a "<" and a ">" as markers, these must be exact for the replacment
event text to be output. Anything outside of these markers will be output as
it looks in the template.


FURTHER HELP
============

If you have an issue and are not sure, try running the same command in the
terminal window and add the option --verbose, you should then see lots of
information about what the script is doing, any warnings or errors should also
be displayed.

If after doing the above you are still stuck, further help can be found by 
visiting this thread on ubuntuforums.org:

	Conky Pidgin Python Script
	
	http://ubuntuforums.org/showthread.php?p=6099901

Note that it is best to post --verbose output of your script call, as well as
the conkyrc you are using. This way the issue can be understood quickly and
easily.

ENJOY :)


