http://www.jwz.org/xscreensaver/xscreensaver-5.07.tar.gz
[xscreensaver] / hacks / t3d.man
1 .TH t3d 1 "Version 1.1" "Time 3D"
2 .SH NAME
3 t3d \- clock using flying balls to display the time
4 .SH SYNOPSIS
5 t3d [ \f2 options\f1 ]...
6 .SH DESCRIPTION
7 .PP
8 Time 3D is a clock. It uses flying balls to display the time. This
9 balls move and wobble around to give you the impression your
10 graphic workstation with its many XStones is doing something.
11 .PP
12 t3d uses mouse and keyboard to let you fly through the balls. Hit
13 .B S
14 to speed up, 
15 .B A
16 to slow down,
17 .B Z
18 to zoom in and
19 .B X
20 to zoom out.
21 Use the
22 .B left mouse button
23 to rotate to the left and the
24 .B right mouse button
25 to rotate the view to the right. Use the
26 .B middle mouse button
27 to change the optical axis and the moving direction.
28 .B 0
29 (zero) will stop you.
30 .B Q
31 quits.
32 .PP
33 .SH OPTIONS
34 .TP
35 .BI "-move " "factor"
36 Modifies the direction move of t3d. The clock looks 30 degrees*
37 .I factor
38 to the left and to the right periodically.
39 .TP
40 .BI "-wobble " "factor"
41 Modifies the wobbling (sounds nice :-) of t3d by multiplying the
42 default deformation of the clock with
43 .I factor.
44 .TP
45 .B -minutes
46 Shows one small ball for every minute, instead of one for every 2.5 minutes.
47 .TP
48 .BI "-mag " "factor"
49 Changes the magnification of t3d. By default, t3d draws a 200x200 image.
50 A .I factor
51 of 2 means, it will use a 400x400 image.
52 .TP
53 .BI "-cycle " "period"
54 Sets the moving cycle to
55 .I period
56 seconds. By default, this value is 10 seconds.
57 .TP
58 .BI "-delay " "microsec"
59 Inserts a wait after drawing one view of the clock. By default, t3d waits
60 40 ms after each drawing. This helps you to keep the performance loss
61 small.
62 .TP
63 .BI "-fast " "precalc_radius"
64 t3d uses bitmap copy to draw precalculated balls. You can specify the radius
65 in pixels up to which t3d should precalculate balls. t3d will set a useful
66 range by itself using the magnification when it is started.
67 .TP
68 .B -colcycle
69 Draws cyclic the color scale used for the balls in the background instead
70 of the normal black.
71 .TP
72 .BI "-rgb " "red green blue"
73 Selects the color in RGB color space of the lightning spot on the balls.
74 All the other colors used for balls or
75 .B -colcycle
76 are less intensive colors of the same hue and saturation. All values
77 in range of 0 to 1.
78 .TP
79 .BI "-hsv " "hue saturation value"
80 Selects the color in HSV color space.
81 .I hue
82 is in degrees from 0 to 360, all other values in range from 0 to 1. It gives
83 nice but rather unpredictable results, if you use a saturation of e.g. 2.
84 Try it at your own risk.
85 .TP
86 .BI "-hsvcycle " "speed"
87 Rotates the hue axis every 10 seconds*
88 .I speed.
89 .TP
90 .B -help
91 Prints a short usage message.
92 .TP 8
93 .B \-fps
94 Display the current frame rate and CPU load.
95 .PP
96 .SH AUTHOR
97 .PP
98 Bernd Paysan
99
100 Email: bernd.paysan@gmx.de
101
102 Hacked on by jwz@jwz.org for xscreensaver.
103
104 .SH ACKNOWLEDGEMENT
105 .PP
106 Acknowledgement to Georg Acher, who wrote the initial program displaying
107 balls.
108
109 .SH COPYING
110 .PP
111 Copy, modify, and distribute T3D either under GPL version 2 or newer, or
112 under the standard MIT/X license notice.
113
114 .SH DISCLAIMER
115 .PP
116 T3D is not related to T3D(tm), the massive parallel Alpha--based
117 supercomputer from Cray Research. T3D's name was invented in 1991,
118 years before the project at Cray Research started. There is no
119 relation from T3D to Cray's T3D, even the balls surrounding T3D on
120 some posters weren't an inspiration for T3D. I don't know anything
121 about the other way round.
122
123 The programming style of T3D isn't intended as example of good style,
124 but as example of how a fast prototyped demo may look like. T3D wasn't
125 created to be useful, it was created to be nice.
126
127 .SH KNOWN BUGS
128 .PP
129 There are no known bugs in T3D. Maybe there are bugs in X. Slight
130 changes in the T3D sources are known to show these bugs, e.g. if
131 you remove the (int) casting at the XFillArc x,y,w,h-coordinates...