X-Git-Url: http://git.hungrycats.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=hacks%2Fbubbles.man;h=f9b892e62b38a0e90772daa335054443235f5f26;hb=HEAD;hp=ab9095181560c47a318a5b4db19eef00ca4f792c;hpb=de041722414a2e31c1c04caa10aaec9d6952e9b4;p=xscreensaver

diff --git a/hacks/bubbles.man b/hacks/bubbles.man
index ab909518..5e1ac068 100644
--- a/hacks/bubbles.man
+++ b/hacks/bubbles.man
@@ -1,22 +1,12 @@
-.de EX		\"Begin example
-.ne 5
-.if n .sp 1
-.if t .sp .5
-.nf
-.in +.5i
-..
-.de EE
-.fi
-.in -.5i
-.if n .sp 1
-.if t .sp .5
-..
 .TH XScreenSaver 1 "14-Dec-95" "X Version 11"
 .SH NAME
-bubbles - frying pan / soft drink simulation
+bubbles \- frying pan / soft drink simulation
 .SH SYNOPSIS
 .B bubbles
-[\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-simple] [\-broken] [\-3D] [\-file filename] [\-directory directoryname]
+[\-\-display \fIhost:display.screen\fP] [\-\-foreground \fIcolor\fP]
+[\-\-background \fIcolor\fP] [\-\-window] [\-\-root]
+[\-\-window\-id \fInumber\fP][\-\-mono] [\-\-install] [\-\-visual \fIvisual\fP] [\-\-simple] [\-\-broken] [\-3D] [\-\-rise|\-\-drop] [-trails]
+[\-\-fps]
 .SH DESCRIPTION
 \fIBubbles\fP sprays lots of little random bubbles all over the window which
 then grow until they reach their maximum size and go pop.  The inspiration
@@ -29,47 +19,48 @@ Depending on how your
 .I bubbles
 was compiled, it accepts the following options:
 .TP 8
-.B \-foreground
-Colour of circles if \fI\-simple\fP mode is selected.
+.B \-\-foreground
+Colour of circles if \fI\-\-simple\fP mode is selected.
 .TP 8
-.B \-background
+.B \-\-background
 Colour of window background.
 .TP 8
-.B \-window
+.B \-\-window
 Draw on a newly-created window.  This is the default.
 .TP 8
-.B \-root
+.B \-\-root
 Draw on the root window.
 .TP 8
-.B \-mono 
+.B \-\-window\-id \fInumber\fP
+Draw on the specified window.
+.TP 8
+.B \-\-mono 
 If on a color display, pretend we're on a monochrome display.
 .TP 8
-.B \-install
+.B \-\-install
 Install a private colormap for the window.
 .TP 8
-.B \-visual \fIvisual\fP
+.B \-\-visual \fIvisual\fP
 Specify which visual to use.  Legal values are the name of a visual class,
 or the id number (decimal or hex) of a specific visual.
 .TP 8
-.B \-delay microseconds
+.B \-\-delay microseconds
 How much of a delay should be introduced between steps of the animation.
-Default 1, or about 1 microsecond.  Actually, this is the delay between each
+Default 800, or about 800 microsecond.  Actually, this is the delay between each
 group of 15 new bubbles since such a delay between each step results in a
 very slow animation rate.
 .TP 8
-.B \-nodelay
-Same as \fI\-delay 0\fP.
+.B \-\-nodelay
+Same as \fI\-\-delay 0\fP.
 .TP 8
-.B \-simple
+.B \-\-simple
 Don't use the default fancy pixmap bubbles.  Just draw circles instead.
 This may give more bearable performance if your hardware wasn't made for
 this sort of thing.
 .TP 8
-.B \-broken
+.B \-\-broken
 Don't hide bubbles when they pop.  This was a bug during development
-but the results were actually quite attractive.  (This option is only
-available if you have the XPM library available and the imake generated
-Makefile has defined HAVE_XPM).
+but the results were actually quite attractive.
 .TP 8
 .B \-3D
 Normally, the simulation is done completely in two dimensions.  When a
@@ -80,31 +71,25 @@ whole thing looks more realistic but I find it attracts attention to
 the flickering of each bubble as they are move and are redrawn.  Your
 mileage may vary.
 .TP 8
-.B \-file filename
-Use the pixmap definitions in the given file, instead of the default (if
-one is compiled in).  This is ignored if \fI\-simple\fP is specified.  If
-the file is compressed (either with compress or gzip), it is decompressed
-before use.  (This option only works if you have XPM compiled into your
-binary and you have compiled with BUBBLES_IO set in bubbles.h.  This is
-\fBnot\fP the default).
-.TP 8
-.B \-directory directoryname
-Similar to \fI-file\fP except the file is taken randomly from the
-contents of the specified directory.  (Again, this option is only available
-if you have XPM and BUBBLES_IO was set when compiling.  See above).
-.TP 8
-.B \-quiet
+.B \-\-quiet
 Don't print messages explaining why one or several command line options
 were ignored.  This is disabled by default.
+.TP 8
+.B \-\-rise | \-\-drop 
+.TP 8
+.B \-\-trails
+.TP 8
+.B \-\-fps
+Display the current frame rate and CPU load.
 .SH NOTES
 If you find the pace of things too slow, remember that there is a delay
-even though you specify no \fI\-delay\fP option.  Try using \fI\-nodelay\fP
+even though you specify no \fI\-\-delay\fP option.  Try using \fI\-\-nodelay\fP
 although beware of the effects of irritation of other users if you're on a 
 shared system as you bleed their CPU time away.
 
 Some tools to assist in creation of new bubbles are included in the source
-distribution.  These can either be loaded with the \fI\-file\fP or
-\fI\-directory\fP options (if available) or they can be used in place
+distribution.  These can either be loaded with the \fI\-\-file\fP or
+\fI\-\-directory\fP options (if available) or they can be used in place
 of the distributed default bubble (bubble_default.c).
 You might like to copy these scripts to a permanent location and
 use them.  Read bubbles.README.
@@ -121,7 +106,7 @@ The movement of the bubbles looks jerky if an incomplete set of bubbles
 is used.  
 
 The hide/display algorithm could do with some work to avoid flickering
-when \fI\-nodelay\fP is set.
+when \fI\-\-nodelay\fP is set.
 .SH ENVIRONMENT
 .PP
 .TP 8
@@ -131,6 +116,9 @@ to get the default host and display number.
 .B XENVIRONMENT
 to get the name of a resource file that overrides the global resources
 stored in the RESOURCE_MANAGER property.
+.TP 8
+.B XSCREENSAVER_WINDOW
+The window ID to use with \fI\-\-root\fP.
 .SH SEE ALSO
 .BR X (1),
 .BR xscreensaver (1)