http://packetstormsecurity.org/UNIX/admin/xscreensaver-4.16.tar.gz
[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] [\-window] [\-root] [\-install]
7 [\-visual \fIvisual\fP] [\-delay \fImicroseconds\fP] [\-fps]
8 .SH DESCRIPTION
9 The \fIprovidence\fP code displays an eye, shrouded in glory, set upon the
10 base of a pyramid.
11 .SH OPTIONS
12 .I providence
13 accepts the following options:
14 .TP 8
15 .B \-window
16 Draw on a newly-created window.  This is the default.
17 .TP 8
18 .B \-root
19 Draw on the root window.
20 .TP 8
21 .B \-install
22 Install a private colormap for the window.
23 .TP 8
24 .B \-eye
25 Draw an eye/$.
26 .TP 8
27 .B \-visual \fIvisual\fP\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 .B \-fps
31 Display a running tally of how many frames per second are being rendered.
32 In conjunction with \fB\-delay 0\fP, this can be a useful benchmark of 
33 your GL performance.
34 .SH ENVIRONMENT
35 .PP
36 .TP 8
37 .B DISPLAY
38 to get the default host and display number.
39 .TP 8
40 .B XENVIRONMENT
41 to get the name of a resource file that overrides the global resources
42 stored in the RESOURCE_MANAGER property.
43 .SH SEE ALSO
44 .BR X (1),
45 .BR xscreensaver (1)
46 .BR xscreensaver\-demo (1),
47 .BR xscreensaver\-getimage (1)
48 .SH COPYRIGHT
49 Copyright \(co 2004 by Blair Tennessy.  Permission to use, copy, modify,
50 distribute, and sell this software and its documentation for any purpose is
51 hereby granted without fee, provided that the above copyright notice appear
52 in all copies and that both that copyright notice and this permission notice
53 appear in supporting documentation.  No representations are made about the
54 suitability of this software for any purpose.  It is provided "as is" without
55 express or implied warranty.
56 .SH AUTHOR
57 Blair Tennessy <tennessy@cs.ubc.ca>, 11-May-2004.
58