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