1------------------------------------------------------------------------
2xteddy version 1.0.3, by Stefan Gustavson, ISY-LiTH (stegu@itn.liu.se)
3------------------------------------------------------------------------
4
5DESCRIPTION
6
7xteddy is a cuddly teddy bear for your X Windows desktop.
8
9Normally, xteddy just sits around doing nothing. After all, that's what
10teddy bears are for. Look at him, talk to him, place heavy windows on
11top of him, zap him around until he becomes dizzy, do what you like;
12he will always be your true (albeit virtual) friend.
13
14You can move xteddy with the mouse by pointing at him and dragging
15him around. When clicked upon, he will pop up on top of all other
16windows. If you type "q" on him, he will die (or, as I like to think
17of it, be tucked away in the file system until you need him next time).
18
19That's it. But he's cute.
20
21
22OPTIONS
23
24By default, xteddy will set the override_redirect attribute for his
25window, which means that he will be ignored by most window managers
26and live directly on the root window all by himself.
27You cannot iconify or resize him. This is intentional. If you really
28want to be able to iconify xteddy, there is code to communicate with
29a window manager, and I have even specified an icon bitmap for him.
30All it takes is that you supply the command-line option -wm.
31Beware that this will probably cram title bars and other ugly things
32onto xteddy if you do not tell you window manager otherwise.
33To find out how to do that, refer to the manual of your specific
34window manager.
35If you want your teddy close at all times, there is also an option -float
36to make xteddy float up on top of all overlapping windows on the screen.
37This is a bit intrusive and unlike a real teddy bear, so it is not the
38default action. The original to xteddy sits on my real-world desktop,
39and he sometimes gets obscured with paper and stuff, too.
40If you place two copies of "xteddy -float" so that they overlap, you are
41asking for trouble.
42The option -mono forces xteddy to show up in black-and-white, without
43allocationg any colormap entries.
44Xteddy accepts a standard X -geometry option, but will only honour the
45position request. Teddy bears are not scalable.
46
47
48COMPILATION
49
50You will need the shape extension to X and the Xpm library to compile.
51The shape extension to X is bundled with all official distributions of X.
52The Xpm library is included in most distributions, and it is installed
53on most systems. If not, it can be obtained by anonymous FTP to avahi.inria.fr
54or to export.lcs.mit.edu.
55
56Xteddy is known to compile fine on almost every imagineable X Windows
57system, including X11R4, X11R5, X11R6 and OpenWindows (all versions),
58and almost any Unix system, at least on Solaris, SunOS, Linux, Ultrix,
59HP/UX, AIX, A/UX and IRIX.
60
61To compile, just execute "./configure --prefix=<location>"
62where <location> can be /usr/local or any other directory where
63you want xteddy to be installed. Configure checks whether
64Xpm is installed and defines -DHAVE_LIBXPM if successful. (Please
65check if this mechanism works right, because it is tested only
66in some cases. If configure can not detect your Xpm library please
67edit the resulting Makefile manually, that means add
68-L<path_to_libXpm> to X_LIBS and -I<path_to_Xpm.h> to X_CFLAGS.)
69Than you can type "make xteddy".
70
71
72
73YOUR OWN TEDDY
74
75Now there is a command line option for making your own favourite teddy
76bear for the program. You need four files xteddy_bw.xbm and
77xteddy_mask.xbm are standard X bitmap files that contain the
78monochrome image and the shape mask. The color and grayscale images
79are in one file, xteddy_color.xpm, in the X Pixmap format defined for
80the Xpm library. The same shape mask is used for monochrome, grayscale
81and color. At last you need an icon which is named xteddy_icon.xbm.
82See to it that you get the names right for the variables at
83the top of the file. The image size doesn't really matter, as long as
84it is the same for all three files. If you make your own teddy,
85please send me a copy. I'll take good care of him.
86
87If you create four files according to this scheme with for instance
88the Linux penguin and name the files xpenguin_... then you can call
89
90 xteddy -Fxpenguin
91
92and instead of the lovely xteddy you will see penguin at your desktop.
93Alternatively you can make a symlink
94
95 ln -s xteddy xpenguin
96
97and the xpenguin pixmaps are searched too.
98
99
100BUGS
101
102Some window managers may experience problems if you don't specify -wm.
103
104If you want to use Xteddy with a virtual window manager without having
105him as a "sticky" window on all desktops, use the option -wm and
106instruct your window manager not to decorate the window with title bar
107and stuff. You might want to add the option -noquit as well to prevent
108accidentally killing xteddy in case he happens to get keyboard focus.
109
110The Desktop Manager in Sun CDE (Common Desktop Environment) does not
111like xteddy at all. If you run him without any parameters, he shows up
112on all your alternate desktops, which might not be all that bad, but if
113you try to circumvent that by running him with the -wm option, and move
114him by grabbing him by the tummy instead of by the title bar, and then
115move him partly off the screen, the image is lost and never redrawn again,
116so all you see is a silhouette of a teddy bear.
117I have no idea why this happens. If you know, please tell me, and if you
118can fix it, please do. If you run CDE on other platforms than Sun, please
119tell me if it works for you. CDE does something which xteddy does not
120handle properly, and since I have a Sun with CDE myself I would like to
121know what the problem is.
122
123On most X servers, the -float option does not work properly if xteddy
124is moved partially off the screen. This is not my fault. It's your
125X server that doesn't know the difference between occlusion and clipping
126and fails to send occlusion notifications to clipped windows.
127
128
129AUTHOR
130
131Written by Stefan Gustavson, ISY-LiTH, 1994-1997.
132 Email address: stegu@itn.liu.se
133
134Xteddy is a program I made entirely for fun. If you make any useful
135changes, additions, improvements, or bug fixes, please send me a message.
136If you like xteddy, remember to smile.
137
138This software is distributed under the GNU General Public License (GPL).
139
140The Xpm library is Copyright 1990-93 GROUPE BULL.
141The X Window System is Copyright the Massachusetts Institute
142of Technology. "X Window System" is a trademark of MIT.
143The teddy bear images are photos of a Tender Teddy from Gund.
144
145
146DISCLAIMER
147
148I make no promises that this software will work for any purpose
149whatsoever. If you hurt yourself or your system, don't blame me.
150Blame xteddy if you like. He doesn't mind.
151
152
153---- This file wast last modified on Aug 7, 1997 ----
154