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