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] [\-altcolour]
  10 [\-angvel \fIangular\fP]
  11 [\-explode \fIdistance\fP]
  12 [\-statictime \fImilliseconds\fP]
  13 [\-yangvel \fIangle\fP]
  14 [\-zangvel \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 the current frame rate, CPU load, and polygon count.
  38 .TP 8
  39 .B \-wireframe
  40 Display the snake in wireframe mode, rather than the default solid mode.
  41 .TP 8
  42 .B \-altcolour
  43 Use the alternate colour scheme for the snake.  Shape identification using
  44 colour will be disabled.
  45 .TP 8
  46 .B -angvel \fIangular\fP
  47 Change the speed at which the snake morphs to a new shape.
  48 .TP 8
  49 .B -explode \fIdistance\fP
  50 Change the distance between the nodes of a snake.
  51 .TP 8
  52 .B \-statictime \fImilliseconds\fP
  53 Change the time between morphs.
  54 .TP 8
  55 .B \-yangvel \fIangle\fP
  56 Change the angle of rotation around the Y axis per frame.
  57 .TP 8
  58 .B \-zangvel \fIangle\fP
  59 Change the angle of rotation around the Z axis per frame.
  60 .SH ENVIRONMENT
  61 .PP
  62 .TP 8
  63 .B DISPLAY
  64 to get the default host and display number.
  65 .TP 8
  66 .B XENVIRONMENT
  67 to get the name of a resource file that overrides the global resources
  68 stored in the RESOURCE_MANAGER property.
  69 .SH FILES
  70 .TP
  71 \fB/usr/share/glsnake/*.glsnake\fP
  72 This XScreenSaver will attempt to read model files installed with the interactive \fBglsnake\fP.
  73 .SH SEE ALSO
  74 .BR X (1),
  75 .BR xscreensaver (1),
  76 .BR glsnake (MANSUFFIX)
  77 .PP
  78 .EX
  79 http://spacepants.org/src/glsnake/
  80 .EE
  81 .SH BUGS
  82 The snake will happily intersect itself while morphing (this is not a bug).
  83 .PP
  84 The rotation/camera position sucks.
  85 .SH COPYRIGHT
  86 Copyright \(co 2001,2002 by Jamie Wilkinson, Andrew Bennetts, and Peter Aylett.
  87 .PP
  88 This program is free software; you can redistribute it and/or modify it under
  89 the terms of the GNU General Public License as published by the Free Software
  90 Foundation; either version 2 of the License, or (at your option) any later
  91 version.
  92 .PP
  93 This program is distributed in the hope that it will be useful, but WITHOUT
  94 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  95 FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  96 .SH AUTHOR
  97 Jamie Wilkinson <jaq@spacepants.org>, Andrew Bennetts <andrew@puzzling.org>,
  98 and Peter Aylett <peter@ylett.com>.  Ported to XScreenSaver by Jamie Wilkinson.