1baa491ef991d6b7c93fbb6e52f3583e07cf0751
[xscreensaver] / hacks / glx / atunnel.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 "12-Feb-03" "X Version 11"
15 .SH NAME
16 atunnel - hypnotic GL tunnel journey
17 .SH SYNOPSIS
18 .B sballs
19 [\-display \fIhost:display.screen\fP] [\-window] [\-root]
20 [\-visual \fIvisual\fP] [\-delay \fImicroseconds\fP]
21 [\-light] [\-no-light]
22 [\-wire] [\-no-wire]
23 [\-texture] [\-no-texture]
24 [\-fps] [\-no-fps]
25 .SH DESCRIPTION
26 The \fIatunnel\fP program draws an animation of a journey in a GL tunnel.
27 .SH OPTIONS
28 .I sballs
29 accepts the following options:
30 .TP 8
31 .B \-window
32 Draw on a newly-created window.  This is the default.
33 .TP 8
34 .B \-root
35 Draw on the root window.
36 .TP 8
37 .B \-install
38 Install a private colormap for the window.
39 .TP 8
40 .B \-visual \fIvisual\fP
41 Specify which visual to use.  Legal values are the name of a visual class,
42 or the id number (decimal or hex) of a specific visual.
43 .TP 8
44 .B \-fps
45 Display a running tally of how many frames per second are being rendered.
46 In conjunction with \fB\-delay 0\fP, this can be a useful benchmark of 
47 your GL performance.
48 .TP 8
49 .B \-texture
50 Show a textured tunnel. This is the default.
51 .TP 8
52 .B \-no\-texture
53 Disables texturing the animation.
54 .TP 8
55 .B \-wire
56 Draw a wireframe rendition of the tunnel.
57 .SH ENVIRONMENT
58 .PP
59 .TP 8
60 .B DISPLAY
61 to get the default host and display number.
62 .TP 8
63 .B XENVIRONMENT
64 to get the name of a resource file that overrides the global resources
65 stored in the RESOURCE_MANAGER property.
66 .SH SEE ALSO
67 .BR X (1),
68 .BR xscreensaver (1)
69 .SH COPYRIGHT
70 Copyright \(co 2003 by Eric Lassauge.
71 Permission to use, copy, modify, distribute, and sell this software and
72 its documentation for any purpose is hereby granted without fee,
73 provided that the above copyright notice appear in all copies and that
74 both that copyright notice and this permission notice appear in
75 supporting documentation.  No representations are made about the
76 suitability of this software for any purpose.  It is provided "as is"
77 without express or implied warranty.
78
79 The original code for this mode was written by 
80 Roman Podobedov <romka@ut.ee>
81 and can be found at http://romka.demonews.com
82
83 .SH AUTHOR
84 Roman Podobedov <romka@ut.ee> 
85 Eric Lassauge <lassauge@mail.dotcom.fr>