From http://www.jwz.org/xscreensaver/xscreensaver-5.23.tar.gz

[xscreensaver] / hacks / glx / gflux.man

diff --git a/hacks/glx/gflux.man b/hacks/glx/gflux.man
index 33911478d6b043d5999f2d09b72479af84120eb2..654aeb463c7ca52e910708a571941e7817753184 100644 (file)
--- a/hacks/glx/gflux.man
+++ b/hacks/glx/gflux.man
@@ -1,9 +1,17 @@
-.TH XScreenSaver 1 "July 2000"
+.TH XScreenSaver 1 "May 2004"

 .SH NAME
 gflux \- rippling surface graphics hack
 .SH SYNOPSIS
 .B gflux
 .SH NAME
 gflux \- rippling surface graphics hack
 .SH SYNOPSIS
 .B gflux

-[\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-install] [\-visual \fIvisual\fP] [\-squares \fInum\fP] [\-resolution \fInum\fP] [\-draw \fInum\fP] [\-flat \fInum\fP] [\-speed \fInum\fP] [\-rotationx \fInum\fP] [\-rotationy \fInum\fP] [\-rotationz \fInum\fP]  [\-waves \fInum\fP] [\-waveChange \fInum\fP] [\-waveHeight \fInum\fP] [\-waveFreq \fInum\fP] [\-zoom \fInum\fP]
+[\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-install]
+[\-visual \fIvisual\fP] [\-delay \fImicroseconds\fP]
+[\-squares \fInum\fP] [\-resolution \fInum\fP] [\-mode \fImode\fP]
+[\-flat \fInum\fP] [\-speed \fInum\fP]
+[\-rotationx \fInum\fP] [\-rotationy \fInum\fP] [\-rotationz \fInum\fP]
+[\-waves \fInum\fP] [\-waveChange \fInum\fP] [\-waveHeight \fInum\fP]
+[\-waveFreq \fInum\fP] [\-zoom \fInum\fP]
+[\-wireframe]
+[\-fps]

 .SH DESCRIPTION
 The \fIgflux\fP program draws a colourfull animated rippling square rotating in 3D space.
 .SH OPTIONS
 .SH DESCRIPTION
 The \fIgflux\fP program draws a colourfull animated rippling square rotating in 3D space.
 .SH OPTIONS


@@ -29,8 +37,23 @@ Specifies the size of the grid in squares. default 19
 .B \-resolution \fInum\fP\fP
 Specifies the wireframe detail of the squares. default 4
 .TP 8
 .B \-resolution \fInum\fP\fP
 Specifies the wireframe detail of the squares. default 4
 .TP 8

-.B \-draw \fInum\fP\fP
-Specifies the draw method. 0 = wireframe (default), 1 = solid, 2 = light, 3 = checker texture mapped, 4 = PNM image is read from stdin and mapped to the surface
+.B \-mode \fImode\fP\fP
+Specifies the draw method: wireframe; solid (meaning a solid colored
+surface); light (same as solid, but with lighting effects);
+checker (a texture-mapped checkerboard pattern); or grab (meaning
+grab an image to manipulate.)
+
+When grabbing images, the image will be grabbed from the portion of
+the screen underlying the window, or from the system's video input,
+or from a random file on disk, as indicated by
+the \fIgrabDesktopImages\fP, \fIgrabVideoFrames\fP,
+and \fIchooseRandomImages\fP options in the \fI~/.xscreensaver\fP
+file; see
+.BR xscreensaver-demo (1)
+for more details.
+.TP 8
+.B \-wireframe
+Same as "-mode wire".

 .TP 8
 .B \-flat \fInum\fP\fP
 0 for smooth shading 1 for flat. default 0
 .TP 8
 .B \-flat \fInum\fP\fP
 0 for smooth shading 1 for flat. default 0


@@ -55,6 +78,12 @@ Specifies the maximum frequency of ripples. default 3.0
 .TP 8
 .B \-zoom \fInum\fP\fP
 Specifies the size of the viewport. Smaller values fill the screen with rippling surface. default 1.0
 .TP 8
 .B \-zoom \fInum\fP\fP
 Specifies the size of the viewport. Smaller values fill the screen with rippling surface. default 1.0

+.TP 8
+.B \-delay \fImicroseconds\fP
+How long to pause between frames.  Default is 20000, or 0.02 second.
+.TP 8
+.B \-fps
+Display the current frame rate, CPU load, and polygon count.

 .SH ENVIRONMENT
 .PP
 .TP 8
 .SH ENVIRONMENT
 .PP
 .TP 8


@@ -64,11 +93,11 @@ 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.
 .B XENVIRONMENT
 to get the name of a resource file that overrides the global resources
 stored in the RESOURCE_MANAGER property.

-.SH BUGS
-It's not unknown for this and other OpenGL hacks to fail under hardware accelaration (UtahGLX) and take the X server with them.  Texture images must be 16x16 or 32x32 or 64x64 etc.

 .SH SEE ALSO
 .BR X (1),
 .BR xscreensaver (1)
 .SH SEE ALSO
 .BR X (1),
 .BR xscreensaver (1)

+.BR xscreensaver\-demo (1),
+.BR xscreensaver\-getimage (1)

 .SH COPYRIGHT
 Copyright \(co 2000 by Josiah Pease.  Permission to use, copy, modify,
 distribute, and sell this software and its documentation for any purpose is
 .SH COPYRIGHT
 Copyright \(co 2000 by Josiah Pease.  Permission to use, copy, modify,
 distribute, and sell this software and its documentation for any purpose is