31f45d33dd7113391139a43cb62d7966df4486a6
[xscreensaver] / hacks / glx / blinkbox.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 blinkbox 
4 .SH SYNOPSIS
5 .B blinkbox
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-delay \fInumber\fP]
11 [\-wireframe]
12 [\-boxsize \fInumber\fP]
13 [\-dissolve]
14 [\-fade]
15 [\-no\-blur]
16 [\-fps]
17 .SH DESCRIPTION
18 Shows a ball contained inside of a bounding box. Colored blocks blink in
19 when the ball hits the edges.
20 .SH OPTIONS
21 .TP 8
22 .B \-visual \fIvisual\fP
23 Specify which visual to use.  Legal values are the name of a visual class,
24 or the id number (decimal or hex) of a specific visual.
25 .TP 8
26 .B \-window
27 Draw on a newly-created window.  This is the default.
28 .TP 8
29 .B \-root
30 Draw on the root window.
31 .TP 8
32 .B \-delay \fInumber\fP
33 Per-frame delay, in microseconds.  Default: 30000 (0.03 seconds.).
34 .TP 8
35 .B \-wireframe | \-no-wireframe
36 Render in wireframe instead of solid.
37 .TP 8
38 .B \-boxsize 
39 Sets the size of the colored boxes. Should be between 1 and 8. Default: 2 
40 .TP 8
41 .B \-dissolve | \-no-dissolve
42 Boxes shrink instead of just vanishing.
43 .TP 8
44 .B \-fade | \-no-fade
45 Boxes fade to transparency instead of just vanishing.
46 .TP 8
47 .B \-blur | \-no-blur
48 Enable or disable motion blur on the ball.  Default: blurry.
49 .TP 8
50 .B \-fps
51 Display the current frame rate, CPU load, and polygon count.
52 .SH ENVIRONMENT
53 .PP
54 .TP 8
55 .B DISPLAY
56 to get the default host and display number.
57 .TP 8
58 .B XENVIRONMENT
59 to get the name of a resource file that overrides the global resources
60 stored in the RESOURCE_MANAGER property.
61 .SH SEE ALSO
62 .BR X (1),
63 .BR xscreensaver (1)
64 .SH COPYRIGHT
65 Copyright \(co 2003 by Jeremy English.  Permission to use, copy, modify, 
66 distribute, and sell this software and its documentation for any purpose is 
67 hereby granted without fee, provided that the above copyright notice appear 
68 in all copies and that both that copyright notice and this permission notice
69 appear in supporting documentation.  No representations are made about the 
70 suitability of this software for any purpose.  It is provided "as is" without
71 express or implied warranty.
72 .SH AUTHOR
73 Jeremy English.  Motion blur by John Boero.