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

   1 .TH XScreenSaver 1 "" "X Version 11"
   2 .SH NAME
   3 topblock - a 3D world of falling blocks that build up and up.
   4 .SH SYNOPSIS
   5 .B topblock
   6 [\-display \fIhost:display.screen\fP]
   7 [\-visual \fIvisual\fP]
   8 [\-window]
   9 [\-root]
  10 [\-delay \fInumber\fP]
  11 [\-wireframe]
  12 [\-fps]
  13 [\-size \fInumber\fP]
  14 [\-spawn \fInumber\fP]
  15 [\-camX \fInumber\fP]
  16 [\-camY \fInumber\fP]
  17 [\-camZ \fInumber\fP]
  18 [\-rotate]
  19 [\-no-carpet]
  20 [\-no-nipples]
  21 [\-blob]
  22 [\-rotateSpeed \fInumber\fP]
  23 [\-follow]
  24 [\-maxFalling \fInumber\fP]
  25 [\-resolution \fInumber\fP]
  26 [\-maxColors \fInumber\fP]
  27 [\-dropSpeed \fInumber\fP]
  28 [\-override]
  29 .SH DESCRIPTION
  30 Creates a world of falling blocks that build up and up.
  31 .SH OPTIONS
  32 .TP 8
  33 .B \-visual \fIvisual\fP
  34 Specify which visual to use.  Legal values are the name of a visual class,
  35 or the id number (decimal or hex) of a specific visual.
  36 .TP 8
  37 .B \-window
  38 Draw on a newly-created window.  This is the default.
  39 .TP 8
  40 .B \-root
  41 Draw on the root window.
  42 .TP 8
  43 .B \-delay \fInumber\fP
  44 Per-frame delay, in microseconds.  Default: 10000 (0.01 seconds.).
  45 .TP 8
  46 .B \-wireframe | \-no-wireframe
  47 Render in wireframe instead of solid.
  48 .TP 8
  49 .B \-fps
  50 Display the current frame rate, CPU load, and polygon count.
  51 .TP 8
  52 .B \-size \fInumber\fP
  53 Size of the base/carpet.
  54 .TP 8
  55 .B \-spawn \fInumber\fP
  56 Likeyhood of a new block being created per frame : 1 high, 1000 very low.
  57 .TP 8
  58 .B \-camX \fInumber\fP
  59 Initial camera X location in the world.
  60 .TP 8
  61 .B \-camY \fInumber\fP
  62 Initial camera Y location in the world.
  63 .TP 8
  64 .B \-camZ \fInumber\fP
  65 Initial camera Z location in the world.
  66 .TP 8
  67 .B \-rotate | -no-rotate
  68 Add/Remove rotation to/from the animation.
  69 .TP 8
  70 .B \-no-carpet
  71 Remove the base/carpet.
  72 .TP 8
  73 .B \-no-nipples
  74 Remove nipples on the blocks (also applies to udders) (has no effect in blob mode).
  75 .TP 8
  76 .B \-blob
  77 Run in blob mode, blocks become over sized spheres.
  78 .TP 8
  79 .B \-rotateSpeed \fInumber\fP
  80 Varries speed of world rotation.
  81 .TP 8
  82 .B \-follow
  83 Camera follows blocks as they fall instead of camera being semi static (stays with top block).
  84 .TP 8
  85 .B \-maxFalling \fInumber\fP
  86 Maximum number of objects created before recycling occurs.
  87 .TP 8
  88 .B \-resolution \fInumber\fP
  89 Resolution of tubes, disks and spheres.
  90 .TP 8
  91 .B \-maxColors \fInumber\fP
  92 Number of different colors available to falling objects.
  93 .TP 8
  94 .B \-dropSpeed \fInumber\fP
  95 Varries speed of falling objects.
  96 .TP 8
  97 .B \-override
  98 Overrides camera settings and provides a tunnel view.
  99
 100 .SH KEYS
 101 .PP
 102 .TP 8
 103 .B a
 104 Increases viewing X coordinate.
 105 .TP 8
 106 .B z
 107 Decreases viewing X coordinate.
 108 .TP 8
 109 .B s
 110 Increases viewing Y coordinate.
 111 .TP 8
 112 .B x
 113 Decreases viewing Y coordinate.
 114 .TP 8
 115 .B d
 116 Increases viewing Z coordinate.
 117 .TP 8
 118 .B c
 119 Decreases viewing Z coordinate.
 120 .TP 8
 121 .B f
 122 Increases camera location X coordinate.
 123 .TP 8
 124 .B v
 125 Decreases camera location X coordinate.
 126 .TP 8
 127 .B g
 128 Increases camera location Y coordinate.
 129 .TP 8
 130 .B b
 131 Decreases camera location Y coordinate.
 132 .TP 8
 133 .B h
 134 Increases camera location Z coordinate.
 135 .TP 8
 136 .B n
 137 Decreases camera location Z coordinate.
 138 .TP 8
 139 .B r
 140 Increases world rotation.
 141 .TP 8
 142 .B q
 143 quit.
 144 .SH EXAMPLES
 145 To see which block follow-mode is tracking, set the number of block colors to 1.
 146 .TP 8
 147 .B topblock -follow -maxColors 1
 148 .SH ENVIRONMENT
 149 .PP
 150 .TP 8
 151 .B DISPLAY
 152 to get the default host and display number.
 153 .TP 8
 154 .B XENVIRONMENT
 155 to get the name of a resource file that overrides the global resources
 156 stored in the RESOURCE_MANAGER property.
 157 .SH SEE ALSO
 158 .BR X (1),
 159 .BR xscreensaver (1)
 160 .SH COPYRIGHT
 161 Copyright \(co 2006 by rednuht.  Permission to use, copy, modify,
 162 distribute, and sell this software and its documentation for any purpose is
 163 hereby granted without fee, provided that the above copyright notice appear
 164 in all copies and that both that copyright notice and this permission notice
 165 appear in supporting documentation.  No representations are made about the
 166 suitability of this software for any purpose.  It is provided "as is" without
 167 express or implied warranty.
 168 .SH AUTHOR
 169 rednuht <topblock.xscreensaver@jumpstation.co.uk>
 170 <http://www.jumpstation.co.uk/xscreensaver/topblock/>