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

   1 .TH XScreenSaver 1 "" "X Version 11"
   2 .SH NAME
   3 polyhedra - draws the 80 uniform polyhedra and their duals
   4 .SH SYNOPSIS
   5 .SH SYNOPSIS
   6 .B polyhedra
   7 [\-display \fIhost:display.screen\fP]
   8 [\-visual \fIvisual\fP]
   9 [\-window]
  10 [\-root]
  11 [\-delay \fInumber\fP]
  12 [\-speed \fIfloat\fP]
  13 [\-duration \fIseconds\fP]
  14 [\-no-wander]
  15 [\-spin \fIXYZ\fP]
  16 [\-wireframe]
  17 [\-no-titles]
  18 [\-which \fIname\fP]
  19 [\-wireframe]
  20 [\-fps]
  21 .SH DESCRIPTION
  22 This program renders 160 different 3D solids, and displays some
  23 information about each.  A new solid is chosen every few seconds.
  24
  25 There are 75 uniform polyhedra, plus an inifinite number of
  26 prisms and antiprisms:
  27
  28   * Convex Uniform Polyhedra:
  29     * Platonic solids (5)
  30     * Archimedean solids (13)
  31     * Convex prisms and antiprisms (2 infinite families)
  32   * Nonconvex Uniform Polyhedra:
  33     * Kepler-Poinsot polyhedra (4)
  34     * Nonconvex uniform polyhedra (53)
  35     * Nonconvex prisms, antiprisms, and crossed antiprisms
  36       (3 infinite families)
  37
  38 Representative samples of the prism sets brings the total to 80 solids.
  39 Including the \fIdual\fP of each brings the total up to 160.  (To
  40 create the "dual" of a polyhedron, faces are replaced with vertices,
  41 and vertices with faces.)
  42 .SH OPTIONS
  43 .TP 8
  44 .B \-visual \fIvisual\fP
  45 Specify which visual to use.  Legal values are the name of a visual class,
  46 or the id number (decimal or hex) of a specific visual.
  47 .TP 8
  48 .B \-window
  49 Draw on a newly-created window.  This is the default.
  50 .TP 8
  51 .B \-root
  52 Draw on the root window.
  53 .TP 8
  54 .B \-delay \fInumber\fP
  55 Per-frame delay, in microseconds.  Default: 30000 (0.03 seconds.).
  56 .TP 8
  57 .B \-speed \fInumber\fP
  58 Larger numbers mean run faster.  Default: 1.0.
  59 .TP 8
  60 .B \-duration \fIseconds\fP
  61 How long before switching to a new polyhedron.  Default 12 seconds.
  62 .TP 8
  63 .B \-wander | \-no-wander
  64 Whether the objects should wander around the screen.
  65 .TP 8
  66 .B \-spin [XYZ] | \-no-spin
  67 Which axes, if any, to spin around on.
  68 .TP 8
  69 .B \-titles | \-no-titles
  70 Whether to display text describing each object.
  71 .TP 8
  72 .B \-which \fIobject-name\fP
  73 Display only one particular object, identified by number, name, or
  74 Whthoff symbol.
  75 .TP 8
  76 .B \-wireframe | \-no-wireframe
  77 Render in wireframe instead of solid.
  78 .TP 8
  79 .B \-fps
  80 Display the current frame rate, CPU load, and polygon count.
  81 .SH KEY BINDINGS
  82 When running in a window, you can rotate the object with the mouse.
  83 Also, the following keystrokes are defined:
  84 .TP 12
  85 .B SPC \fIor\fP TAB
  86 Select a new polyhedron at random.
  87 .TP 12
  88 .B + \fIor\fP >
  89 Select the next-higher-numbered polyhedron.
  90 .TP 12
  91 .B - \fIor\fP <
  92 Select the next-lower-numbered polyhedron.
  93 .TP 12
  94 .B ESC \fIor\fP ^C
  95 Quit.
  96 .SH ENVIRONMENT
  97 .PP
  98 .TP 8
  99 .B DISPLAY
 100 to get the default host and display number.
 101 .TP 8
 102 .B XENVIRONMENT
 103 to get the name of a resource file that overrides the global resources
 104 stored in the RESOURCE_MANAGER property.
 105 .SH SEE ALSO
 106 .BR X (1),
 107 .BR xscreensaver (1)
 108 .SH COPYRIGHT
 109 Copyright \(co 1991-2002 Dr. Zvi Har'El.
 110
 111 Copyright \(co 2004 Jamie Zawinski.  Permission to use, copy, modify,
 112 distribute, and sell this software and its documentation for any purpose is
 113 hereby granted without fee, provided that the above copyright notice appear
 114 in all copies and that both that copyright notice and this permission notice
 115 appear in supporting documentation.  No representations are made about the
 116 suitability of this software for any purpose.  It is provided "as is" without
 117 express or implied warranty.
 118 .SH AUTHOR
 119 Based on the program \fIkaleido\fP ("Kaleidoscopic construction of
 120 uniform polyhedra"), by Dr. Zvi Har'El <rl@math.technion.ac.il>
 121     http://www.math.technion.ac.il/~rl/
 122     ftp://ftp.math.technion.ac.il/kaleido/
 123
 124 Adapted for OpenGL and XScreenSaver by Jamie Zawinski, 2004.