From http://www.jwz.org/xscreensaver/xscreensaver-5.23.tar.gz
[xscreensaver] / hacks / glx / glblur.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 glblur - 3D radial blur texture fields
4 .SH SYNOPSIS
5 .B glblur
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-delay \fInumber\fP]
11 [\-blursize \fInumber\fP]
12 [\-no-wander]
13 [\-no-spin]
14 [\-spin \fI[XYZ]\fP]
15 [\-fps]
16 .SH DESCRIPTION
17 This program draws a box and a few line segments, and generates a 
18 radial blur outward from it.  This creates flowing field effects.
19
20 This is done by rendering the scene into a small texture, then
21 repeatedly rendering increasingly-enlarged and increasingly-transparent
22 versions of that texture onto the frame buffer.  As such, it's quite
23 graphics intensive: don't bother trying to run this if you don't have
24 hardware-accelerated texture support.  It will hurt your machine bad.
25 .SH OPTIONS
26 .TP 8
27 .B \-visual \fIvisual\fP
28 Specify which visual to use.  Legal values are the name of a visual class,
29 or the id number (decimal or hex) of a specific visual.
30 .TP 8
31 .B \-window
32 Draw on a newly-created window.  This is the default.
33 .TP 8
34 .B \-root
35 Draw on the root window.
36 .TP 8
37 .B \-delay \fInumber\fP
38 Per-frame delay, in microseconds.  Default: 10000 (0.01 seconds.).
39 .TP 8
40 .B \-blursize \fInumber\fP
41 How many copies of the scene should be laid down to make the vapor trail.
42 Default: 15.  Larger numbers create smoother fields, but are slower.
43 .TP 8
44 .B \-wander | \-no-wander
45 Whether the object should wander around the screen.
46 .TP 8
47 .B \-spin [XYZ]
48 Around which axes should the object spin?
49 .TP 8
50 .B \-no-spin
51 None.
52 .TP 8
53 .B \-fps
54 Display the current frame rate, CPU load, and polygon count.
55 .SH ENVIRONMENT
56 .PP
57 .TP 8
58 .B DISPLAY
59 to get the default host and display number.
60 .TP 8
61 .B XENVIRONMENT
62 to get the name of a resource file that overrides the global resources
63 stored in the RESOURCE_MANAGER property.
64 .SH SEE ALSO
65 .BR X (1),
66 .BR xscreensaver (1)
67 .SH COPYRIGHT
68 Copyright \(co 2002 by Jamie Zawinski.  Permission to use, copy, modify, 
69 distribute, and sell this software and its documentation for any purpose is 
70 hereby granted without fee, provided that the above copyright notice appear 
71 in all copies and that both that copyright notice and this permission notice
72 appear in supporting documentation.  No representations are made about the 
73 suitability of this software for any purpose.  It is provided "as is" without
74 express or implied warranty.
75 .SH AUTHOR
76 Jamie Zawinski, with inspiration from a tutorial by Dario Corno.