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

   1 .de EX          \"Begin example
   2 .ne 5
   3 .if n .sp 1
   4 .if t .sp .5
   5 .nf
   6 .in +.5i
   7 ..
   8 .de EE
   9 .fi
  10 .in -.5i
  11 .if n .sp 1
  12 .if t .sp .5
  13 ..
  14 .TH XScreenSaver 1 "25-Jul-98" "X Version 11"
  15 .SH NAME
  16 kaleidocycle - draws twistable rings of tetrahedra
  17 .SH SYNOPSIS
  18 .B kaleidocycle
  19 [\-display \fIhost:display.screen\fP] [\-window] [\-root]
  20 [\-visual \fIvisual\fP] [\-delay \fImicroseconds\fP]
  21 [\-count \fInumber\fP]
  22 [\-speed \fInumber\fP]
  23 [\-wander] [\-no-wander]
  24 [\-spin \fIaxes\fP]
  25 [\-no-spin]
  26 [\-wireframe]
  27 [\-fps]
  28 .SH DESCRIPTION
  29 The \fIkaleidocycle\fP program draws a ring composed of tetrahedra
  30 connected at the edges that twists and rotates toroidally.  Segments
  31 are occasionally inserted or removed.
  32 .SH OPTIONS
  33 .I kaleidocycle
  34 accepts the following options:
  35 .TP 8
  36 .B \-window
  37 Draw on a newly-created window.  This is the default.
  38 .TP 8
  39 .B \-root
  40 Draw on the root window.
  41 .TP 8
  42 .B \-install
  43 Install a private colormap for the window.
  44 .TP 8
  45 .B \-visual \fIvisual\fP\fP
  46 Specify which visual to use.  Legal values are the name of a visual class,
  47 or the id number (decimal or hex) of a specific visual.
  48 .TP 8
  49 .B \-count \fInumber\fP
  50 The initial number of segments. Default 16.  Must be 8 or greater, and
  51 an even number.
  52 .TP 8
  53 .B \-speed \fInumber\fP
  54 Adjust the animation speed. 0.5 for half as fast, 2.0 for twice as fast.
  55 .TP 8
  56 .B \-wander
  57 Move the text around the screen.  This is the default.
  58 .TP 8
  59 .B \-no\-wander
  60 Keep the text centered on the screen.
  61 .TP 8
  62 .B \-spin
  63 Which axes around which the text should spin.  The default is "Z",
  64 meaning rotate the object the plane of the screen only.
  65 .TP 8
  66 .B \-no\-spin
  67 Don't spin the text at all: the same as \fB\-spin ""\fP.
  68 .TP 8
  69 .B \-wireframe
  70 Render in wireframe instead of solid.
  71 .TP 8
  72 .B \-fps
  73 Display the current frame rate, CPU load, and polygon count.
  74 .SH ENVIRONMENT
  75 .PP
  76 .TP 8
  77 .B DISPLAY
  78 to get the default host and display number.
  79 .TP 8
  80 .B XENVIRONMENT
  81 to get the name of a resource file that overrides the global resources
  82 stored in the RESOURCE_MANAGER property.
  83 .SH SEE ALSO
  84 .BR X (1),
  85 .BR xscreensaver (1)
  86 .SH COPYRIGHT
  87 Copyright \(co 2001-2013 by Jamie Zawinski.
  88 Permission to use, copy, modify, distribute, and sell this software and
  89 its documentation for any purpose is hereby granted without fee,
  90 provided that the above copyright notice appear in all copies and that
  91 both that copyright notice and this permission notice appear in
  92 supporting documentation.  No representations are made about the
  93 suitability of this software for any purpose.  It is provided "as is"
  94 without express or implied warranty.
  95 .SH AUTHOR
  96 Jamie Zawinski <jwz@jwz.org>