cdd6af5ba3ab8393ed31fd1b290a07a96ba20f76
[xscreensaver] / hacks / glx / timetunnel.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 timetunnel - Plasma tunnels fade in and out
4 .SH SYNOPSIS
5 .B timetunnel
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-start \fInumber\fP]
11 [\-end \fInumber\fP]
12 [\-dilate \fInumber\fP]
13 [\-no-logo]
14 [\-reverse]
15 [\-no-fog]
16 [\-no-texture]
17 [\-wireframe]
18 [\-fps]
19 [\-tardis \fItexture\fP]
20 [\-head \fItexture\fP]
21 [\-marquee \fItexture\fP]
22 [\-tun1 \fItexture\fP]
23 [\-tun2 \fItexture\fP]
24 [\-tun3 \fItexture\fP]
25 .SH DESCRIPTION
26 Draws an animation similar to the opening and closing effects on the
27 Dr. Who television show.
28 .SH OPTIONS
29 .TP 8
30 .B \-visual \fIvisual\fP
31 Specify which visual to use.  Legal values are the name of a visual class,
32 or the id number (decimal or hex) of a specific visual.
33 .TP 8
34 .B \-window
35 Draw on a newly-created window.  This is the default.
36 .TP 8
37 .B \-root
38 Draw on the root window.
39 .TP 8
40 .B \-start \fInumber\fP
41 Start time of loop, 0.0 - 30.00. Default 0.0.  May be identical to end time.
42 .TP 8
43 .B \-end \fInumber\fP
44 End time of loop, 0.0 - 30.00. Default 27.79.  May be identical to start time.
45 .TP 8
46 .B \-dilate \fInumber\fP
47 Scale time to speed or slow simulation.  Numbers less than one slow it down.
48 .TP 8
49 .B \-no-logo
50 Show only tunnels, no logos, etc.
51 .TP 8
52 .B \-reverse
53 Play in reverse, including tunnels.
54 .TP 8
55 .B \-no-fog
56 Turn off fog.
57 .TP 8
58 .B \-no-texture
59 Turn off textures.
60 .TP 8
61 .B \-wireframe
62 Show as wire frame.
63 .TP 8
64 .B \-fps | \-no-fps
65 Whether to show a frames-per-second display at the bottom of the screen.
66 .TP 8
67 .B \-tardis \fItexture\fP
68 Specify an xpm file to override default tardis texture.
69 .TP 8
70 .B \-head \fItexture\fP
71 Specify an xpm file to override default Dr. Who head texture.
72 .TP 8
73 .B \-marquee \fItexture\fP
74 Specify an xpm file to override default show marquee texture.
75 .TP 8
76 .B \-tun1 \fItexture\fP
77 Specify an xpm file to override default tardis tunnel texture.
78 .TP 8
79 .B \-tun2 \fItexture\fP
80 Specify an xpm file to override default middle tunnel texture.
81 .TP 8
82 .B \-tun3 \fItexture\fP
83 Specify an xpm file to override default final tunnel texture.
84 .SH ENVIRONMENT
85 .PP
86 .TP 8
87 .B DISPLAY
88 to get the default host and display number.
89 .TP 8
90 .B XENVIRONMENT
91 to get the name of a resource file that overrides the global resources
92 stored in the RESOURCE_MANAGER property.
93 .SH SEE ALSO
94 .BR X (1),
95 .BR xscreensaver (1)
96 .SH COPYRIGHT
97 Copyright \(co 2005 by Sean Brennan.  Permission to use, copy, modify, 
98 distribute, and sell this software and its documentation for any purpose is 
99 hereby granted without fee, provided that the above copyright notice appear 
100 in all copies and that both that copyright notice and this permission notice
101 appear in supporting documentation.  No representations are made about the 
102 suitability of this software for any purpose.  It is provided "as is" without
103 express or implied warranty.
104 .SH AUTHOR
105 Sean Brennan <zettix@yahoo.com>