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

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .TH XScreenSaver 1 "January 15, 2001" "X Version 11"
   3 .SH NAME
   4 glsnake \- OpenGL enhanced Rubik's Snake cyclewaster.
   5 .SH SYNOPSIS
   6 .B glsnake
   7 [\-display \fIhost:display.screen\fP] [\-window] [\-root]
   8 [\-visual \fIvisual\fP] [\-delay \fImicroseconds\fP] [\-fps]
   9 [\-wireframe] [\-scarycolour]
  10 [\-velocity \fIangular\fP]
  11 [\-explode \fIdistance\fP]
  12 [\-statictime \fImilliseconds\fP]
  13 [\-yspin \fIangle\fP]
  14 [\-zspin \fIangle\fP]
  15 .SH DESCRIPTION
  16 .PP
  17 .B glsnake
  18 is an imitation of Rubiks\' Snake, using OpenGL.
  19 .SH OPTIONS
  20 .I glsnake
  21 accepts the following options:
  22 .TP 8
  23 .B \-window
  24 Draw on a newly-created window.  This is the default.
  25 .TP 8
  26 .B \-root
  27 Draw on the root window.
  28 .TP 8
  29 .B \-install
  30 Install a private colormap for the window.
  31 .TP 8
  32 .B \-visual \fIvisual\fP\fP
  33 Specify which visual to use.  Legal values are the name of a visual class,
  34 or the id number (decimal or hex) of a specific visual.
  35 .TP 8
  36 .B \-fps
  37 Display a running tally of how many frames per second are being rendered.
  38 In conjunction with \fB\-delay 0\fP, this can be a useful benchmark of
  39 your GL performance.
  40 .TP 8
  41 .B \-wireframe
  42 Display the snake in wireframe mode, rather than the default solid mode.
  43 .TP 8
  44 .B \-scarycolour
  45 Use the alternate colour scheme for the snake.  Shape identification using
  46 colour will be disabled.
  47 .TP 8
  48 .B -velocity \fIangular\fP
  49 Change the speed at which the snake morphs to a new shape.
  50 .TP 8
  51 .B -explode \fIdistance\fP
  52 Change the distance between the nodes of a snake.
  53 .TP 8
  54 .B \-statictime \fImilliseconds\fP
  55 Change the time between morphs.
  56 .TP 8
  57 .B \-yspin \fIangle\fP
  58 Change the angle of rotation around the Y axis per frame.
  59 .TP 8
  60 .B \-zspin \fIangle\fP
  61 Change the angle of rotation around the Z axis per frame.
  62 .SH ENVIRONMENT
  63 .PP
  64 .TP 8
  65 .B DISPLAY
  66 to get the default host and display number.
  67 .TP 8
  68 .B XENVIRONMENT
  69 to get the name of a resource file that overrides the global resources
  70 stored in the RESOURCE_MANAGER property.
  71 .SH FILES
  72 .TP
  73 \fB/usr/share/glsnake/*.glsnake\fP
  74 This XScreenSaver will attempt to read model files installed with the interactive \fBglsnake\fP.
  75 .SH SEE ALSO
  76 .BR X (1),
  77 .BR xscreensaver (1),
  78 .BR glsnake (6)
  79 .PP
  80 .EX
  81 http://spacepants.org/src/glsnake/
  82 .EE
  83 .SH BUGS
  84 The snake will happily intersect itself while morphing (this is not a bug).
  85 .PP
  86 The rotation/camera position sucks.
  87 .SH COPYRIGHT
  88 Copyright \(co 2001,2002 by Jamie Wilkinson, Andrew Bennetts, and Peter Aylett.
  89 .PP
  90 This program is free software; you can redistribute it and/or modify it under
  91 the terms of the GNU General Public License as published by the Free Software
  92 Foundation; either version 2 of the License, or (at your option) any later
  93 version.
  94 .PP
  95 This program is distributed in the hope that it will be useful, but WITHOUT
  96 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  97 FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  98 .SH AUTHOR
  99 Jamie Wilkinson <jaq@spacepants.org>, Andrew Bennetts <andrew@puzzling.org>,
 100 and Peter Aylett <peter@ylett.com>.  Ported to XScreenSaver by Jamie Wilkinson.