http://ftp.x.org/contrib/applications/xscreensaver-3.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 Q
29 will stop you.
30 .PP
31 .SH OPTIONS
32 .TP
33 .BI "-display " "host:dpy"
34 Specifys the display in the usual way.
35 .TP
36 .BI "-geometry " "WxH+X+Y"
37 Sets the size and location of the t3d window.
38 .TP
39 .BI "-move " "factor"
40 Modifies the direction move of t3d. The clock looks 30 degrees*
41 .I factor
42 to the left and to the right periodically.
43 .TP
44 .BI "-wobble " "factor"
45 Modifies the wobbling (sounds nice :-) of t3d by multiplying the
46 default deformation of the clock with
47 .I factor.
48 .TP
49 .BI "-nice " "factor"
50 Renices t3d by
51 .I factor
52 because t3d uses your process time. The default renice factor is 20, so
53 you can't do anything wrong with not renicing t3d. If you want more speed,
54 you should set nice to a smaller value.
55 .TP
56 .B -minutes
57 Shows one small ball for every minute, instead of one for every 2.5 minutes.
58 .TP
59 .BI "-mag " "factor"
60 Changes the magnification of t3d. By default, t3d uses a 200x200 window. A
61 .I factor
62 of 2 means, it will use a 400x400 window.
63 .TP
64 .BI "-cycle " "period"
65 Sets the moving cycle to
66 .I period
67 seconds. By default, this value is 10 seconds.
68 .TP
69 .BI "-wait " "microsec"
70 Inserts a wait after drawing one view of the clock. By default, t3d waits
71 40 ms after each drawing. This helps you to keep the performance loss
72 small.
73 .TP
74 .BI "-fast " "precalc_radius"
75 t3d uses bitmap copy to draw precalculated balls. You can specify the radius
76 in pixels up to which t3d should precalculate balls. t3d will set a useful
77 range by itself using the magnification when it is started.
78 .TP
79 .B -colcycle
80 Draws cyclic the color scale used for the balls in the background instead
81 of the normal black.
82 .TP
83 .BI "-rgb " "red green blue"
84 Selects the color in RGB color space of the lightning spot on the balls.
85 All the other colors used for balls or
86 .B -colcycle
87 are less intensive colors of the same hue and saturation. All values
88 in range of 0 to 1.
89 .TP
90 .BI "-hsv " "hue saturation value"
91 Selects the color in HSV color space.
92 .I hue
93 is in degrees from 0 to 360, all other values in range from 0 to 1. It gives
94 nice but rather unpredictable results, if you use a saturation of e.g. 2.
95 Try it at your own risk.
96 .TP
97 .BI "-hsvcycle " "speed"
98 Rotates the hue axis every 10 seconds*
99 .I speed.
100 .TP
101 .B -help
102 Prints a short usage message.
103
104 .PP
105 .SH AUTHOR
106 .PP
107 Bernd Paysan
108
109 Email: bernd.paysan@gmx.de
110
111 Hacked on by jwz@jwz.org for xscreensaver.
112
113 .SH ACKNOWLEDGEMENT
114 .PP
115 Acknowledgement to Georg Acher, who wrote the initial program displaying
116 balls.
117
118 .SH COPYING
119 .PP
120 Copy, modify, and distribute T3D either under GPL version 2 or newer, or
121 under the standard MIT/X license notice.
122
123 .SH DISCLAIMER
124 .PP
125 T3D is not related to T3D(tm), the massive parallel Alpha--based
126 supercomputer from Cray Research. T3D's name was invented in 1991,
127 years before the project at Cray Research started. There is no
128 relation from T3D to Cray's T3D, even the balls surrounding T3D on
129 some posters weren't an inspiration for T3D. I don't know anything
130 about the other way round.
131
132 The programming style of T3D isn't intented as example of good style,
133 but as example of how a fast prototyped demo may look like. T3D wasn't
134 created to be useful, it was created to be nice.
135
136 .SH KNOWN BUGS
137 .PP
138 There are no known bugs in T3D. Maybe there are bugs in X. Slight
139 changes in the T3D sources are known to show these bugs, e.g. if
140 you remove the (int) casting at the XFillArc x,y,w,h-coordinates...