xannotate
=========

xannotate is a simple program to temporarily annotate your desktop.

This is probably useful when you're doing presentation and you need
to attract attention to certain part of the screen by drawing text or
circles.

You can show and hide your annotation at any time, and you can always
clear it and start over.

You can also capture a screenshot of the screen - with or without your
annotation.

It is similar in purpose to gromit 
(http://www.home.unix-ag.org/simon/gromit/), in fact, gromit is the
inspiration of this program - I created this because I cannot get
gromit to work correctly. Unlike gromit, xannotate depends solely on
Xlib and nothing else. 

To use xannotate, just launch it. It is controlled by a hotkey.
This hotkey, along with shifted versions of it, control various
aspects of xannotate. By default, this hotkey is the "Pause" key. 

Keys usage
----------
Hotkey            - toggle annotate/normal mode
Shift-hotkey      - show/hide annotation
Ctrl-hotkey       - clear annotation
Ctrl-Shift-hotkey - terminate xannotate
Alt-Shift-hotkey  - take screenshot (when compiled with screenshot support)

Button usage
----------
Left-click        - start drawing, move to draw, release to stop
Shift-Left-click  - switch pens
Shift-Right-click - switch tool (pen/eraser)


Command line options
--------------------
There are a few aspects of the program you can control by passing 
options.
	-k key    : use "key" as the hotkey. This can be "F12", "Print" or any other key.
	            Default is "Pause".
	-w width  : pen size. Default is 5 pixel.
	-e width  : eraser size. Default is 20 pixel.
	-p path   : path prefix for screenshot. Default is $HOME/xannotate
	-n index  : starting index for screenshot files. Default is 0 (zero).
    -1 colour : colour for pen1 (default is red)
    -2 colour : colour for pen2 (default is green)    
    -3 colour : colour for pen3 (default is blue)

BUGS: 
-----
 - The program makes use of SHAPE extension, so it can be slow.
 - The screenshot always assumes direct/truecolor, 15/16/24-bit RGB pixel 
   (with LSB first).

Copyright (C) James Budiono, 2014
License: GNU GPL Version 3. See the attached gpl-3.0.txt.
