ea7286d540847877989030c1280464257f22040f
[xscreensaver] / hacks / glx / providence.man
1 .TH XScreenSaver 1 "May 2004"
2 .SH NAME
3 providence - eye in glory screenhack
4 .SH SYNOPSIS
5 .B providence
6 [\-display \fIhost:display.screen\fP]
7 [\-window]
8 [\-root]
9  [\-install]
10 [\-visual \fIvisual\fP]
11 [\-delay \fImicroseconds\fP]
12 [\-wireframe]
13 [\-fps]
14 .SH DESCRIPTION
15 The \fIprovidence\fP code displays an eye, shrouded in glory, set upon the
16 base of a pyramid.
17 .SH OPTIONS
18 .I providence
19 accepts the following options:
20 .TP 8
21 .B \-window
22 Draw on a newly-created window.  This is the default.
23 .TP 8
24 .B \-root
25 Draw on the root window.
26 .TP 8
27 .B \-install
28 Install a private colormap for the window.
29 .TP 8
30 .B \-eye
31 Draw an eye/$.
32 .TP 8
33 .B \-visual \fIvisual\fP\fP
34 Specify which visual to use.  Legal values are the name of a visual class,
35 or the id number (decimal or hex) of a specific visual.
36 .TP 8
37 .B \-wireframe
38 Render in wireframe (with hidden line removal) instead of as textured solids.
39 .TP 8
40 .B \-fps
41 Display the current frame rate, CPU load, and polygon count.
42 .SH ENVIRONMENT
43 .PP
44 .TP 8
45 .B DISPLAY
46 to get the default host and display number.
47 .TP 8
48 .B XENVIRONMENT
49 to get the name of a resource file that overrides the global resources
50 stored in the RESOURCE_MANAGER property.
51 .SH SEE ALSO
52 .BR X (1),
53 .BR xscreensaver (1)
54 .BR xscreensaver\-demo (1),
55 .BR xscreensaver\-getimage (1)
56 .SH COPYRIGHT
57 Copyright \(co 2004 by Blair Tennessy.  Permission to use, copy, modify,
58 distribute, and sell this software and its documentation for any purpose is
59 hereby granted without fee, provided that the above copyright notice appear
60 in all copies and that both that copyright notice and this permission notice
61 appear in supporting documentation.  No representations are made about the
62 suitability of this software for any purpose.  It is provided "as is" without
63 express or implied warranty.
64 .SH AUTHOR
65 Blair Tennessy <tennessy@cs.ubc.ca>, 11-May-2004.
66