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/conkygooglereader/example folder you'll find 2 files,
conkyrc and conkyGoogleReader.template

Conky can be run using these example files as follows:

    conky -c /usr/share/conkygooglereader/example/conkyrc &

HOWEVER the login details found in both files are invalid for obvious reasons.
I suggest looking at the files and making your own in your home folder based on
them. The call to conky would then need changing to suit the new path.

By running equivalent files with proper credentials you should see some output
at the top right of your screen.


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

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

Usage: conkyGoogleReader [options]
Options:
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        username to login with
  -p PASSWORD, --password=PASSWORD
                        Password to login with, if not set the username is
                        used to fetch a 'conky' password from the keyring
  -t FILE, --template=FILE
                        Template file determining the format for each rss feed
                        summary. Use the following placeholders:
                        [unreadcount], [name], [url]
  -s FILE, --summarytemplate=FILE
                        Template file determining the format for summary
                        output. Use the following placeholders:
                        [totalfeedscount], [unreadfeedscount],
                        [unreadfeeditemscount]
  -S, --summaryoutput   Request summary output rather than each feeds details
  -c NUMBER, --connectiontimeout=NUMBER
                        [default: 10] Define the number of seconds before a
                        connection timeout can occur.
  -v, --verbose         Request verbose output, no 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 are able to combine standard font output with other fonts in a 
single template, but must use either 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 Google Reader Python Script
	
	http://ubuntuforums.org/showthread.php?t=TBA

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 :)


