From 57a352fd1eb334d289bde40f6f862f8e9dcdd2df Mon Sep 17 00:00:00 2001 From: Philip Allison Date: Sun, 4 May 2008 03:45:09 +0100 Subject: [PATCH] Document new options and tidy up a few other parts of documentation Signed-off-by: Philip Allison --- README | 16 +++++++++------- doc/cteddy.1 | 30 ++++++++++++++++++++++-------- 2 files changed, 31 insertions(+), 15 deletions(-) diff --git a/README b/README index 903bec2..9873878 100644 --- a/README +++ b/README @@ -3,13 +3,13 @@ cteddy From the man page, adapted from that of the original Xteddy: - cteddy is a cuddly teddy bear for your composited X Window desktop. - Normally, cteddy just sits around doing nothing. After all, that's - what teddy bears are for. Look at him, talk to him, place heavy window - on top of him, zap him around until he becomes dizzy, do what you like; - he will always be your true (albeit virtual) friend. + cteddy is a cuddly teddy bear for your composited X Window System + desktop. Normally, cteddy 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. -The original Xteddy was written by Stefan Gustavson. Its image support was +The original Xteddy was written by Stefan Gustavson. Its image support was later expanded by Andreas Tille, through the usage of Imlib of Xteddy 2. Both the basic version 1.1 and updated version 2.0.1 can be found at: @@ -25,6 +25,8 @@ GTK+ and Cairo. This is the result. cteddy is intended as a drop-in replacement, minus the "-wm" option (cteddy does not bypass the window manager, it simply asks it for an undecorated window) and the "-geometry" and "-display" options (currently left -unimplemented). It also contains a new toy: cdoggy. +unimplemented). It also contains a new toy (cdoggy), and a selection of +additional options, implemented for their utility and/or as a learning +exercise. Philip Allison diff --git a/doc/cteddy.1 b/doc/cteddy.1 index 716cfed..c6dbf7f 100644 --- a/doc/cteddy.1 +++ b/doc/cteddy.1 @@ -1,6 +1,6 @@ .TH CTEDDY 2 "16 April 2008" .SH NAME -cteddy - cuddly teddy bear for your X Window desktop. +cteddy - cuddly teddy bear for your X Window System desktop. .SH SYNOPSIS .B cteddy [ @@ -8,12 +8,12 @@ cteddy - cuddly teddy bear for your X Window desktop. ] .SH DESCRIPTION .I cteddy -is a cuddly teddy bear for your composited X Window desktop. +is a cuddly teddy bear for your composited X Window System desktop. .PP Normally, .I cteddy just sits around doing nothing. After all, that's what -teddy bears are for. Look at him, talk to him, place heavy windows on +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. .PP @@ -29,24 +29,38 @@ compositing window manager. You can move .I cteddy 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 +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). .PP That's it. But he's cute. .SH OPTIONS .TP .B \-float -Float up on top of overlapping windows. This will make -.I cteddy -stay in sight at all times, so you won't lose him. However, this +Float up on top of overlapping windows. This will make \fIcteddy\fP +stay in sight at all times, so you won't lose him. However, this is a bit intrusive and quite unlike a real teddy bear, so it is not the default action. .TP +.B \-stick +Stick to all desktops. This will make \fIcteddy\fP stay in sight +even when switching desktops, which again could be seen as a bit +intrusive, but a nice trick nonetheless. +.TP .B \-noquit Disable the "quit" command (do not quit when typing "q" in the window, but of course still on explicit window kills or process kills). .TP +.B \-nosm +Disable session management support. By default, cteddy will register +himself with your X session manager if you are running one, so that +he automatically comes back next time you log in. +.TP +.B \-nobg +By default, cteddy will detach himself from any terminal to which he +may be attached by forking into the background. This option turns off +that behaviour. Implies \fB-nobg\fP. +.TP .B \-F\fIfile\fP Display another image instead of \fIxteddy\fP. \fBfile\fP should refer to an image with a transparent background. Absolute and -- 2.11.4.GIT