| blob | f66afd131a70f3b7e6f762a7b93c28537b9d8ff8 |
1 .TH CTEDDY 2 "4 May 2008" "0.2" "Cuddly teddy bear"
2 .SH NAME
3 cteddy - cuddly teddy bear for your X Window System desktop.
4 .SH SYNOPSIS
5 .B cteddy
6 [
7 .B \-float \-noquit \-F<file>
8 ]
9 .SH DESCRIPTION
10 .I cteddy
11 is a cuddly teddy bear for your composited X Window System desktop.
12 .PP
13 Normally,
14 .I cteddy
15 just sits around doing nothing. After all, that's what
16 teddy bears are for. Look at him, talk to him, place heavy windows on
17 top of him, zap him around until he becomes dizzy, do what you like;
18 he will always be your true (albeit virtual) friend.
19 .PP
20 .I
21 cteddy
22 was inspired by his older brother \fIxteddy\fP, the primary difference
23 being that since he was created using Cairo and GTK+, he plays more nicely
24 with modern composited desktops. In fact, if run without at least a basic
25 compositing manager, his appearance will be somewhat spoiled by an ugly
26 black border. Try \fIxcompmgr\fP if you do not wish to run a full
27 compositing window manager.
28 .PP
29 You can move
30 .I cteddy
31 with the mouse by pointing at him and dragging
32 him around. When clicked upon, he will pop up on top of all other
33 windows. If you type "q" on him, he will die (or, as I like to think
34 of it, be tucked away in the file system until you need him next time).
35 .PP
36 That's it. But he's cute.
37 .SH OPTIONS
38 .TP
39 .B \-float
40 Float up on top of overlapping windows. This will make \fIcteddy\fP
41 stay in sight at all times, so you won't lose him. However, this
42 is a bit intrusive and quite unlike a real teddy bear, so it is not
43 the default action.
44 .TP
45 .B \-stick
46 Stick to all desktops. This will make \fIcteddy\fP stay in sight
47 even when switching desktops, which again could be seen as a bit
48 intrusive, but a nice trick nonetheless.
49 .TP
50 .B \-noquit
51 Disable the "quit" command (do not quit when typing "q" in the window,
52 but of course still on explicit window kills or process kills).
53 .TP
54 .B \-nosm
55 Disable session management support. By default, cteddy will register
56 himself with your X session manager if you are running one, so that
57 he automatically comes back next time you log in.
58 .TP
59 .B \-nobg
60 By default, cteddy will detach himself from any terminal to which he
61 may be attached by forking into the background. This option turns off
62 that behaviour. Implies \fB-nobg\fP.
63 .TP
64 .B \-F\fIfile\fP
65 Display another image instead of \fIxteddy\fP. \fBfile\fP
66 should refer to an image with a transparent background. Absolute and
67 relative file paths will be used as-is if \fBfile\fP contains at least
68 one "/" character; otherwise,
69 .I cteddy
70 searches in $(installation_prefix)/share/cteddy, where
71 $(installation_prefix) is determined at compile time.
72 The search does a number of things to the given name, stopping when
73 a suitable image file is found; prepending and/or replacing leading "c" and "x"
74 characters, and appending a number of extensions, allowing (for example)
75 .B
76 -Fteddy
77 to refer to xteddy.png, or
78 .B
79 -Fdoggy
80 to refer to cdoggy.png.
81 .RS
82 .PP
83 If no `-F` parameter is given, \fBfile\fP is effectively \fBcteddy\fP \-
84 or more precisely, the name of the program. For instance, if there
85 is a symlink
86 .RS
87 .PP
88 \fBln -s cteddy cpenguin\fP
89 .RE
90 .PP
91 then \fBfile\fP equals \fBcpenguin\fP and the
92 image \fBcpenguin\fP is searched for.
93 .RE
94 .SH AUTHOR
95 Philip Allison <sane@not.co.uk>
96 .SH CREDITS
97 Credit for many of the image files included with this program goes to those
98 kind souls who originally contributed them to \fIxteddy\fP, including
99 Stefan Gustavson for the original xteddy.png, and indeed the original
100 \fIxteddy\fP. Much of the text in this man page comes from
101 \fIxteddy 2.0.1\fP. Please see the included README file for more information.
102 .SH COPYING
103 .I cteddy
104 is distributed under the GNU General Public License version 3.