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

   1 .TH XScreenSaver 1 "Dec-28-07" "X Version 11"
   2 .SH NAME
   3 cubicgrid - rotating 3D lattice seen from inside
   4 .SH SYNOPSIS
   5 .B cubicgrid
   6 [\-display \fIhost:display.screen\fP]
   7 [\-visual \fIvisual\fP]
   8 [\-window]
   9 [\-root]
  10 [\-install]
  11 [\-delay \fImicroseconds\fP]
  12 [\-mono]
  13 [\-speed \fInumber\fP]
  14 [\-zoom \fInumber\fP]
  15 [\-ticks \fInumber\fP]
  16 [\-bigdots]
  17 [\-fps]
  18 .SH DESCRIPTION
  19 This program shows the view of an observer located inside a set of points
  20 arranged to a 3D lattice.  As the lattice rotates, various view-throughs appear
  21 and evolve.  A simple idea with interesting results.
  22 .SH OPTIONS
  23 .I cubicgrid
  24 accepts the following options:
  25 .TP 8
  26 .B \-window
  27 Draw on a newly-created window.  This is the default.
  28 .TP 8
  29 .B \-root
  30 Draw on the root window.
  31 .TP 8
  32 .B \-install
  33 Install a private colormap for the window.
  34 .TP 8
  35 .B \-visual \fIvisual\fP\fP
  36 Specify which visual to use.  Legal values are the name of a visual class,
  37 or the id number (decimal or hex) of a specific visual.
  38 .TP 8
  39 .B \-delay \fImicroseconds\fP
  40 How long to pause between frames.  Default is 20000, or 0.02 second.
  41 .TP 8
  42 .B \-mono
  43 Draw in black and white.  If not used, a fixed all-color scheme is chosen.
  44 .TP 8
  45 .B \-speed \fInumber\fP
  46 The maximum speed of the rotation.  The actual speed and axis change smoothly
  47 for better effect.  0.5 - 10.  The default is 1.0.
  48 .TP 8
  49 .B \-zoom \fInumber\fP
  50 Size of the lattice.  Ideally it should fill all the screen, but one may find
  51 other values also interesting.  5 - 50.  The default of 20 should do for common
  52 screen aspect ratios.
  53 .TP 8
  54 .B \-ticks \fInumber\fP
  55 The count of points drawn along every axis.  10 - 100.  The default is 30.
  56 .TP 8
  57 .B \-bigdots
  58 Draw the points twice as big.
  59 .TP 8
  60 .B \-fps
  61 Display a running tally of how many frames per second are being rendered.
  62 In conjunction with \fB\-delay 0\fP, this can be a useful benchmark of
  63 your GL performance.
  64 .SH ENVIRONMENT
  65 .PP
  66 .TP 8
  67 .B DISPLAY
  68 to get the default host and display number.
  69 .TP 8
  70 .B XENVIRONMENT
  71 to get the name of a resource file that overrides the global resources
  72 stored in the RESOURCE_MANAGER property.
  73 .SH SEE ALSO
  74 .BR X (1),
  75 .BR xscreensaver (1)
  76 .SH COPYRIGHT
  77 Copyright \(co 2007 by Vasek Potocek.  Permission to use, copy, modify,
  78 distribute, and sell this software and its documentation for any purpose is
  79 hereby granted without fee, provided that the above copyright notice appear in
  80 all copies and that both that copyright notice and this permission notice
  81 appear in supporting documentation.  No representations are made about the
  82 suitability of this software for any purpose.  It is provided "as is" without
  83 express or implied warranty.
  84 .SH AUTHOR
  85 Vasek Potocek <vasek.potocek@post.cz>, Dec-28-07.