f55e5be0ac572f7c091ebba80837f1d6c4daaa6d
[xscreensaver] / hacks / glx / lockward.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 lockward - Rotating spinning color-cycling things
4 .SH SYNOPSIS
5 .B lockward
6 [\-display \fIdisplayspec\fP]
7 [\-root]
8 [\-window]
9 [\-visual \fIarg\fP]
10 [\-window-id \fIarg\fP]
11 [\-delay \fIusec\fP]
12 [\-pair]
13 [\-fps]
14 [\-blink | \-no-blink]
15 [\-rotateidle-min \fImsec\fP]
16 [\-rotateidle-max \fImsec\fP]
17 [\-blinkidle-min \fImsec\fP]
18 [\-blinkidle-max \fImsec\fP]
19 [\-blinkdwell-min \fImsec\fP]
20 [\-blinkdwell-max \fImsec\fP]
21 .SH DESCRIPTION
22 .B lockward
23 draws a spinning, rotating set of notched wheels overlaid with some flashing
24 effects, using OpenGL.  It's a sort of cross between the wards in a
25 combination lock and those old information displays that animated via
26 polarized light.
27 .SH OPTIONS
28 .TP 8
29 .B \-visual \fIvisual\fP
30 Specify which visual to use.  Legal values are the name of a visual class,
31 or the ID number (decimal or hex) of a specific visual.
32 .TP 8
33 .B \-window
34 Draw on a newly-created window (default).
35 .TP 8
36 .B \-root
37 Draw on the root window.
38 .TP 8
39 .B \-delay \fImicroseconds\fP
40 Per-frame delay, in microseconds.  Default: 20000 (50 frames/sec).
41 .TP 8
42 .B \-blink | \-no-blink
43 Enables/disables the blinking effects.  Default: Enabled.
44 .TP 8
45 .B \-fps
46 Display the current frame rate, CPU load, and polygon count.
47 .TP 8
48 .B \-rotateidle-min \fImilliseconds
49 .TP 8
50 .B \-rotateidle-max \fImilliseconds
51 The minimum and maximum time each spinner will sit idle, in milliseconds.
52 Defaults: Min 1000, max 6000.
53 .TP 8
54 .B \-blinkidle-min \fImilliseconds
55 .TP 8
56 .B \-blinkidle-max \fImilliseconds
57 The minimum and maximum time between blinking effects, in milliseconds.
58 Defaults: Min 1000, max 9000.
59 .TP 8
60 .B \-blinkdwell-min \fImilliseconds
61 .TP 8
62 .B \-blinkdwell-max \fImilliseconds
63 The minimum and maximum dwell time for the blinking effects, in
64 milliseconds.  This affects how quickly the blinks actually happen.
65 Defaults: Min 100, max 600.
66 .SH ENVIRONMENT
67 .PP
68 .TP 8
69 .B DISPLAY
70 Default host and display number.
71 .TP 8
72 .B XENVIRONMENT
73 Name of a resource file that overrides the global resources stored in the
74 RESOURCE_MANAGER property.
75 .SH SEE ALSO
76 .BR X (1),
77 .BR xscreensaver (1)
78 .SH AUTHORS
79 Leo L. Schwab <ewhac@best.com>