git.hungrycats.org Git - xscreensaver/blob - hacks/glx/gflux.man

   1 .TH XScreenSaver 1 "May 2004"
   2 .SH NAME
   3 gflux \- rippling surface graphics hack
   4 .SH SYNOPSIS
   5 .B gflux
   6 [\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-install]
   7 [\-visual \fIvisual\fP] [\-delay \fImicroseconds\fP]
   8 [\-squares \fInum\fP] [\-resolution \fInum\fP] [\-mode \fImode\fP]
   9 [\-flat \fInum\fP] [\-speed \fInum\fP]
  10 [\-rotationx \fInum\fP] [\-rotationy \fInum\fP] [\-rotationz \fInum\fP]
  11 [\-waves \fInum\fP] [\-waveChange \fInum\fP] [\-waveHeight \fInum\fP]
  12 [\-waveFreq \fInum\fP] [\-zoom \fInum\fP]
  13 [\-wireframe]
  14 [\-fps]
  15 .SH DESCRIPTION
  16 The \fIgflux\fP program draws a colourfull animated rippling square rotating in 3D space.
  17 .SH OPTIONS
  18 .I gflux
  19 accepts the following options:
  20 .TP 8
  21 .B \-window
  22 Draw on a newly-created window.  This is the default.
  23 .TP 8
  24 .B \-root
  25 Draw on the root window.
  26 .TP 8
  27 .B \-install
  28 Install a private colormap for the window.
  29 .TP 8
  30 .B \-visual \fIvisual\fP\fP
  31 Specify which visual to use.  Legal values are the name of a visual class,
  32 or the id number (decimal or hex) of a specific visual.
  33 .TP 8
  34 .B \-squares \fInum\fP\fP
  35 Specifies the size of the grid in squares. default 19
  36 .TP 8
  37 .B \-resolution \fInum\fP\fP
  38 Specifies the wireframe detail of the squares. default 4
  39 .TP 8
  40 .B \-mode \fImode\fP\fP
  41 Specifies the draw method: wireframe; solid (meaning a solid colored
  42 surface); light (same as solid, but with lighting effects);
  43 checker (a texture-mapped checkerboard pattern); or grab (meaning
  44 grab an image to manipulate.)
  45
  46 When grabbing images, the image will be grabbed from the portion of
  47 the screen underlying the window, or from the system's video input,
  48 or from a random file on disk, as indicated by
  49 the \fIgrabDesktopImages\fP, \fIgrabVideoFrames\fP,
  50 and \fIchooseRandomImages\fP options in the \fI~/.xscreensaver\fP
  51 file; see
  52 .BR xscreensaver-demo (1)
  53 for more details.
  54 .TP 8
  55 .B \-wireframe
  56 Same as "-mode wire".
  57 .TP 8
  58 .B \-flat \fInum\fP\fP
  59 0 for smooth shading 1 for flat. default 0
  60 .TP 8
  61 .B \-speed \fInum\fP\fP
  62 Specifies speed of ripples flowing over the surface. default 0.05
  63 .TP 8
  64 .B \-rotationx \fInum\fP \-rotationy \fInum\fP \-rotationz \fInum\fP\fP
  65 Specifies the speed of rotation of the surface in these axis
  66 .TP 8
  67 .B \-waves \fInum\fP\fP
  68 Specifies the number of ripple centres at any one time.  Values should be greater than 1.  default 3
  69 .TP 8
  70 .B \-waveChange \fInum\fP\fP
  71 Specifies the duration of a ripple centre.  after this they fade away to be reborn elsewhere with a different frequency. default 50
  72 .TP 8
  73 .B \-waveHeight \fInum\fP\fP
  74 Specifies the height of ripples on the surface. default 1.0
  75 .TP 8
  76 .B \-waveFreq \fInum\fP\fP
  77 Specifies the maximum frequency of ripples. default 3.0
  78 .TP 8
  79 .B \-zoom \fInum\fP\fP
  80 Specifies the size of the viewport. Smaller values fill the screen with rippling surface. default 1.0
  81 .TP 8
  82 .B \-delay \fImicroseconds\fP
  83 How long to pause between frames.  Default is 20000, or 0.02 second.
  84 .TP 8
  85 .B \-fps
  86 Display the current frame rate, CPU load, and polygon count.
  87 .SH ENVIRONMENT
  88 .PP
  89 .TP 8
  90 .B DISPLAY
  91 to get the default host and display number.
  92 .TP 8
  93 .B XENVIRONMENT
  94 to get the name of a resource file that overrides the global resources
  95 stored in the RESOURCE_MANAGER property.
  96 .SH SEE ALSO
  97 .BR X (1),
  98 .BR xscreensaver (1)
  99 .BR xscreensaver\-demo (1),
 100 .BR xscreensaver\-getimage (1)
 101 .SH COPYRIGHT
 102 Copyright \(co 2000 by Josiah Pease.  Permission to use, copy, modify,
 103 distribute, and sell this software and its documentation for any purpose is
 104 hereby granted without fee, provided that the above copyright notice appear
 105 in all copies and that both that copyright notice and this permission notice
 106 appear in supporting documentation.  No representations are made about the
 107 suitability of this software for any purpose.  It is provided "as is" without
 108 express or implied warranty.
 109 .SH AUTHOR
 110 Josiah Pease <gflux@jpease.force9.co.uk>, 10-Jun-2000.
 111