----------------------------------------------------------------------
xteddy version 1.0, by Stefan Gustavson, ISY-LiTH (stefang@isy.liu.se)
----------------------------------------------------------------------

DESCRIPTION

xteddy is a cuddly teddy bear for your X Windows desktop.

Normally, xteddy just sits around doing nothing. After all, that's what
teddy bears are for. Look at him, talk to him, place heavy windows on
top of him, zap him around until he becomes dizzy, do what you like;
he will always be your true (albeit virtual) friend.

You can move xteddy with the mouse by pointing at him and dragging
him around. When clicked upon, he will pop up on top of all other
windows. If you type "q" on him, he will die (or, as I like to think
of it, be tucked away in the file system until you need him next time).

That's it. But he's cute.


COMPILATION

You will need the shape extension to X and the Xpm library to compile.
The shape extension to X is bundled with most distributions of X.
The Xpm library can be obtained by anonymous FTP to avahi.inria.fr
or to export.lcs.mit.edu. The Imakefile will need some editing to point
to the place where Xpm is installed at your site. Then, just execute
"xmkmf" and "make xteddy".

If you don't have access to Xpm, you can compile with -DNOXPM, which
makes Xteddy always show up in black-and-white. If you don't have the
shape extension either, you can hack the source code to skip the window
shaping, but then Xteddy will only be a square window with a small teddy
bear locked up inside, which is not what I intended. I refuse to provide
a compilation flag for this.

By default, xteddy will set the override_redirect attribute for his
window, which means that he will be ignored by most window managers
and live directly on the root window all by himself.
You cannot iconify or resize him. This is intentional. If you really
want to be able to iconify xteddy, there is code to communicate with
a window manager. All it takes is that you compile with -DUSEWM.
Beware that this will cram title bars and other ugly things onto xteddy.
If you specify -DUSEWM, you should tell your window manager not to
decorate the window. To find out how to do that, refer to the manual of
your specific window manager.


YOUR OWN TEDDY

It's quite easy to make your own favourite teddy bear for the program.
You will need to change four files that are included at compile time.
The files xteddy_bw.xbm and xteddy_mask.xbm are standard X bitmap
files. The color and grayscale images are in X Pixmap format as written
by the converter ppmtoxpm supplied with the Xpm library. The same shape
mask is used for monochrome, grayscale and color. See to it that you get
the names right for the variables at the top of the file. The size does
not really matter, as long as it is the same for all four files.


BUGS

The code for xteddy is far from bullet-proof. It might fail for some
X servers, and there are doubtlessly some bugs I have not found.

This README file is all there is for a manpage.

Xteddy reads no options from the command line, and does not make use
of the X resource database. I just didn't get around to that.
The compilation flag -DUSEWM should really be a command-line option.


CHANGES

Version 1.0 of xteddy is the original release. It is a fast hack made
for fun. If you make any useful changes, additions, improvements, or bug
fixes, please send me a message. If you like xteddy, remember to smile.


COPYRIGHT

Copyright Stefan Gustavson, ISY-LiTH, 1994.
  Email address: stefang@isy.liu.se

You may use, copy, modify, and distribute this software and its
rudimentary documentation freely, provided that you do it for free
and that the above copyright notice appears in all copies and sup-
porting documentation.

The Xpm library is Copyright 1990-93 GROUPE BULL.
The X Window System is Copyright the Massachusetts Institute
of Technology. "X Window System" is a trademark of MIT.
The teddy bear images are photos of a Tender Teddy from Gund.


DISCLAIMER

I make no promises that this software will work for any purpose
whatsoever. If you hurt yourself or your system, don't blame me.
Blame xteddy if you like. He doesn't mind.


---- This file wast last modified on Jan 20, 1994 ----
